Struct aws_sdk_cloudcontrol::client::fluent_builders::ListResources

pub struct ListResources<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to ListResources.

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.

Implementations

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

pub async fn send(
    self
) -> Result<ListResourcesOutput, SdkError<ListResourcesError>> where
    R::Policy: SmithyRetryPolicy<ListResourcesInputOperationOutputAlias, ListResourcesOutput, ListResourcesError, ListResourcesInputOperationRetryAlias>, 

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 type_name(self, inp: impl Into<String>) -> Self

The name of the resource type.

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

The name of the resource type.

pub fn type_version_id(self, inp: impl Into<String>) -> Self

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

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

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

pub fn role_arn(self, inp: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

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

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

The default is 20.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

The default is 20.

pub fn resource_model(self, inp: impl Into<String>) -> Self

The resource model to use to select the resources to return.

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

The resource model to use to select the resources to return.

Trait Implementations

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

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

Formats the value using the given formatter.