Struct aws_sdk_shield::client::fluent_builders::ListProtectionGroups

source · [−]

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

Expand description

Fluent builder constructing a request to ListProtectionGroups.

Retrieves the ProtectionGroup objects for the account.

Implementations

source

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

source

pub async fn send(
self
) -> Result<ListProtectionGroupsOutput, SdkError<ListProtectionGroupsError>> where
R::Policy: SmithyRetryPolicy<ListProtectionGroupsInputOperationOutputAlias, ListProtectionGroupsOutput, ListProtectionGroupsError, ListProtectionGroupsInputOperationRetryAlias>,

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.

source

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

Create a paginator for this request

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

source

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

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

source

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

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

source

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

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

source

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

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.