Struct aws_sdk_synthetics::client::fluent_builders::DescribeCanaries

pub struct DescribeCanaries<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to DescribeCanaries.

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation does not have resource-level authorization, so if a user is able to use DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be used to restrict access to all canaries. It cannot be used on specific resources.

Implementations

impl<C, M, R> DescribeCanaries<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeCanariesOutput, SdkError<DescribeCanariesError>> where
    R::Policy: SmithyRetryPolicy<DescribeCanariesInputOperationOutputAlias, DescribeCanariesOutput, DescribeCanariesError, DescribeCanariesInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeCanariesPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn max_results(self, input: i32) -> Self

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

pub fn set_max_results(self, input: Option<i32>) -> Self

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DescribeCanaries<C, M, R>

fn clone(&self) -> DescribeCanaries<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeCanaries<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.