aws_sdk_synthetics/client/

describe_canaries.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeCanaries`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::set_max_results):<br>required: **false**<br><p>Specify this parameter to limit how many canaries are returned each time you use the <code>DescribeCanaries</code> operation. If you omit this parameter, the default of 20 is used.</p><br>
    ///   - [`names(impl Into<String>)`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::names) / [`set_names(Option<Vec::<String>>)`](crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::set_names):<br>required: **false**<br><p>Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.</p> <p>If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.</p> <p>You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html"> Limiting a user to viewing specific canaries</a>.</p><br>
    /// - On success, responds with [`DescribeCanariesOutput`](crate::operation::describe_canaries::DescribeCanariesOutput) with field(s):
    ///   - [`canaries(Option<Vec::<Canary>>)`](crate::operation::describe_canaries::DescribeCanariesOutput::canaries): <p>Returns an array. Each item in the array contains the full information about one canary.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_canaries::DescribeCanariesOutput::next_token): <p>A token that indicates that there is more data available. You can use this token in a subsequent <code>DescribeCanaries</code> operation to retrieve the next set of results.</p>
    /// - On failure, responds with [`SdkError<DescribeCanariesError>`](crate::operation::describe_canaries::DescribeCanariesError)
    pub fn describe_canaries(&self) -> crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder {
        crate::operation::describe_canaries::builders::DescribeCanariesFluentBuilder::new(self.handle.clone())
    }
}