aws_sdk_ec2/client/

describe_dhcp_options.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDhcpOptions`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`dhcp_options_ids(impl Into<String>)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::dhcp_options_ids) / [`set_dhcp_options_ids(Option<Vec::<String>>)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::set_dhcp_options_ids):<br>required: **false**<br><p>The IDs of DHCP option sets.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>dhcp-options-id</code> - The ID of a DHCP options set.</p></li>  <li>   <p><code>key</code> - The key for one of the options (for example, <code>domain-name</code>).</p></li>  <li>   <p><code>value</code> - The value for one of the options.</p></li>  <li>   <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the DHCP options set.</p></li>  <li>   <p><code>tag</code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>  <li>   <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li> </ul><br>
    /// - On success, responds with [`DescribeDhcpOptionsOutput`](crate::operation::describe_dhcp_options::DescribeDhcpOptionsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_dhcp_options::DescribeDhcpOptionsOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
    ///   - [`dhcp_options(Option<Vec::<DhcpOptions>>)`](crate::operation::describe_dhcp_options::DescribeDhcpOptionsOutput::dhcp_options): <p>Information about the DHCP options sets.</p>
    /// - On failure, responds with [`SdkError<DescribeDhcpOptionsError>`](crate::operation::describe_dhcp_options::DescribeDhcpOptionsError)
    pub fn describe_dhcp_options(&self) -> crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder {
        crate::operation::describe_dhcp_options::builders::DescribeDhcpOptionsFluentBuilder::new(self.handle.clone())
    }
}