Struct aws_sdk_resourcegroups::Client

pub struct Client { /* private fields */ }

Client for AWS Resource Groups

Client for invoking operations on AWS Resource Groups. Each operation on AWS Resource Groups is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_resourcegroups::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_resourcegroups::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateGroup operation has a Client::create_group, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_group()
    .name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_group(&self) -> CreateGroupFluentBuilder

Constructs a fluent builder for the CreateGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the group, which is the identifier of the group in other operations. You can’t change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with AWS, aws, or any other possible capitalization; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.

    
    
  • resource_query(ResourceQuery) / set_resource_query(Option<ResourceQuery>):
    required: false
    

    The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups.

    A resource group can contain either a ResourceQuery or a Configuration, but not both.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to add to the group. A tag is key-value pair string.

    
    
  • configuration(GroupConfigurationItem) / set_configuration(Option<Vec::<GroupConfigurationItem>>):
    required: false
    

    A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.

    A resource group can contain either a Configuration or a ResourceQuery, but not both.

    
    
• On success, responds with CreateGroupOutput with field(s):
  • group(Option<Group>):

    The description of the resource group.

  • resource_query(Option<ResourceQuery>):

    The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with the group.

  • group_configuration(Option<GroupConfiguration>):

    The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for Resource Groups.

• On failure, responds with SdkError<CreateGroupError>

impl Client

pub fn delete_group(&self) -> DeleteGroupFluentBuilder

Constructs a fluent builder for the DeleteGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    Deprecated - don’t use this parameter. Use Group instead.

    
    
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or the ARN of the resource group to delete.

    
    
• On success, responds with DeleteGroupOutput with field(s):
  • group(Option<Group>):

    A full description of the deleted resource group.

• On failure, responds with SdkError<DeleteGroupError>

impl Client

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    The current settings for the optional features in Resource Groups.

• On failure, responds with SdkError<GetAccountSettingsError>

impl Client

pub fn get_group(&self) -> GetGroupFluentBuilder

Constructs a fluent builder for the GetGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    Deprecated - don’t use this parameter. Use Group instead.

    
    
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or the ARN of the resource group to retrieve.

    
    
• On success, responds with GetGroupOutput with field(s):
  • group(Option<Group>):

    A structure that contains the metadata details for the specified resource group. Use GetGroupQuery and GetGroupConfiguration to get those additional details of the resource group.

• On failure, responds with SdkError<GetGroupError>

impl Client

pub fn get_group_configuration(&self) -> GetGroupConfigurationFluentBuilder

Constructs a fluent builder for the GetGroupConfiguration operation.

• The fluent builder is configurable:
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or the ARN of the resource group for which you want to retrive the service configuration.

    
    
• On success, responds with GetGroupConfigurationOutput with field(s):
  • group_configuration(Option<GroupConfiguration>):

    A structure that describes the service configuration attached with the specified group. For details about the service configuration syntax, see Service configurations for Resource Groups.

• On failure, responds with SdkError<GetGroupConfigurationError>

impl Client

pub fn get_group_query(&self) -> GetGroupQueryFluentBuilder

Constructs a fluent builder for the GetGroupQuery operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    Don’t use this parameter. Use Group instead.

    
    
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or the ARN of the resource group to query.

    
    
• On success, responds with GetGroupQueryOutput with field(s):
  • group_query(Option<GroupQuery>):

    The resource query associated with the specified group. For more information about resource queries, see Create a tag-based group in Resource Groups.

• On failure, responds with SdkError<GetGroupQueryError>

impl Client

pub fn get_tags(&self) -> GetTagsFluentBuilder

Constructs a fluent builder for the GetTags operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the resource group whose tags you want to retrieve.

    
    
• On success, responds with GetTagsOutput with field(s):
  • arn(Option<String>):

    The ARN of the tagged resource group.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with the specified resource group.

• On failure, responds with SdkError<GetTagsError>

impl Client

pub fn group_resources(&self) -> GroupResourcesFluentBuilder

Constructs a fluent builder for the GroupResources operation.

• The fluent builder is configurable:
  • group(impl Into<String>) / set_group(Option<String>):
    required: true
    

    The name or the ARN of the resource group to add resources to.

    
    
  • resource_arns(impl Into<String>) / set_resource_arns(Option<Vec::<String>>):
    required: true
    

    The list of ARNs of the resources to be added to the group.

    
    
• On success, responds with GroupResourcesOutput with field(s):
  • succeeded(Option<Vec::<String>>):

    A list of ARNs of the resources that this operation successfully added to the group.

  • failed(Option<Vec::<FailedResource>>):

    A list of ARNs of any resources that this operation failed to add to the group.

  • pending(Option<Vec::<PendingResource>>):

    A list of ARNs of any resources that this operation is still in the process adding to the group. These pending additions continue asynchronously. You can check the status of pending additions by using the ListGroupResources operation, and checking the Resources array in the response and the Status field of each object in that array.

• On failure, responds with SdkError<GroupResourcesError>

impl Client

pub fn list_group_resources(&self) -> ListGroupResourcesFluentBuilder

Constructs a fluent builder for the ListGroupResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    Deprecated - don’t use this parameter. Use the Group request field instead.

    
    
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or the ARN of the resource group

    
    
  • filters(ResourceFilter) / set_filters(Option<Vec::<ResourceFilter>>):
    required: false
    

    Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.

    • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

    When you specify a resource-type filter for ListGroupResources, Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:

    The resource types specified as filters in the request are not valid.

    The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn’t occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or Amazon CloudFront stack-based queries).

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call’s NextToken response to indicate where the output should continue from.

    
    
• On success, responds with ListGroupResourcesOutput with field(s):
  • resources(Option<Vec::<ListGroupResourcesItem>>):

    An array of resources from which you can determine each resource’s identity, type, and group membership status.

  • resource_identifiers(Option<Vec::<ResourceIdentifier>>):

    Deprecated - don’t use this parameter. Use the Resources response field instead.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

  • query_errors(Option<Vec::<QueryError>>):

    A list of QueryError objects. Each error contains an ErrorCode and Message. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE, CLOUDFORMATION_STACK_NOT_EXISTING, CLOUDFORMATION_STACK_UNASSUMABLE_ROLE and RESOURCE_TYPE_NOT_SUPPORTED.

• On failure, responds with SdkError<ListGroupResourcesError>

impl Client

pub fn list_groups(&self) -> ListGroupsFluentBuilder

Constructs a fluent builder for the ListGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(GroupFilter) / set_filters(Option<Vec::<GroupFilter>>):
    required: false
    

    Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

    • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

    • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

      • AWS::AppRegistry::Application

      • AWS::AppRegistry::ApplicationResourceGroups

      • AWS::CloudFormation::Stack

      • AWS::EC2::CapacityReservationPool

      • AWS::EC2::HostManagement

      • AWS::NetworkFirewall::RuleGroup

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call’s NextToken response to indicate where the output should continue from.

    
    
• On success, responds with ListGroupsOutput with field(s):
  • group_identifiers(Option<Vec::<GroupIdentifier>>):

    A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn.

  • groups(Option<Vec::<Group>>):

    Deprecated - don’t use this field. Use the GroupIdentifiers response field instead.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

• On failure, responds with SdkError<ListGroupsError>

impl Client

pub fn put_group_configuration(&self) -> PutGroupConfigurationFluentBuilder

Constructs a fluent builder for the PutGroupConfiguration operation.

• The fluent builder is configurable:
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or ARN of the resource group with the configuration that you want to update.

    
    
  • configuration(GroupConfigurationItem) / set_configuration(Option<Vec::<GroupConfigurationItem>>):
    required: false
    

    The new configuration to associate with the specified group. A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements.

    For information about the syntax of a service configuration, see Service configurations for Resource Groups.

    A resource group can contain either a Configuration or a ResourceQuery, but not both.

    
    
• On success, responds with PutGroupConfigurationOutput
• On failure, responds with SdkError<PutGroupConfigurationError>

impl Client

pub fn search_resources(&self) -> SearchResourcesFluentBuilder

Constructs a fluent builder for the SearchResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_query(ResourceQuery) / set_resource_query(Option<ResourceQuery>):
    required: true
    

    The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call’s NextToken response to indicate where the output should continue from.

    
    
• On success, responds with SearchResourcesOutput with field(s):
  • resource_identifiers(Option<Vec::<ResourceIdentifier>>):

    The ARNs and resource types of resources that are members of the group that you specified.

  • next_token(Option<String>):

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

  • query_errors(Option<Vec::<QueryError>>):

    A list of QueryError objects. Each error contains an ErrorCode and Message.

    Possible values for ErrorCode:

    • CLOUDFORMATION_STACK_INACTIVE

    • CLOUDFORMATION_STACK_NOT_EXISTING

    • CLOUDFORMATION_STACK_UNASSUMABLE_ROLE

• On failure, responds with SdkError<SearchResourcesError>

impl Client

pub fn tag(&self) -> TagFluentBuilder

Constructs a fluent builder for the Tag operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the resource group to which to add tags.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to add to the specified resource group. A tag is a string-to-string map of key-value pairs.

    
    
• On success, responds with TagOutput with field(s):
  • arn(Option<String>):

    The ARN of the tagged resource.

  • tags(Option<HashMap::<String, String>>):

    The tags that have been added to the specified resource group.

• On failure, responds with SdkError<TagError>

impl Client

pub fn ungroup_resources(&self) -> UngroupResourcesFluentBuilder

Constructs a fluent builder for the UngroupResources operation.

• The fluent builder is configurable:
  • group(impl Into<String>) / set_group(Option<String>):
    required: true
    

    The name or the ARN of the resource group from which to remove the resources.

    
    
  • resource_arns(impl Into<String>) / set_resource_arns(Option<Vec::<String>>):
    required: true
    

    The ARNs of the resources to be removed from the group.

    
    
• On success, responds with UngroupResourcesOutput with field(s):
  • succeeded(Option<Vec::<String>>):

    A list of resources that were successfully removed from the group by this operation.

  • failed(Option<Vec::<FailedResource>>):

    A list of any resources that failed to be removed from the group by this operation.

  • pending(Option<Vec::<PendingResource>>):

    A list of any resources that are still in the process of being removed from the group by this operation. These pending removals continue asynchronously. You can check the status of pending removals by using the ListGroupResources operation. After the resource is successfully removed, it no longer appears in the response.

• On failure, responds with SdkError<UngroupResourcesError>

impl Client

pub fn untag(&self) -> UntagFluentBuilder

Constructs a fluent builder for the Untag operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.

    
    
  • keys(impl Into<String>) / set_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to be removed.

    
    
• On success, responds with UntagOutput with field(s):
  • arn(Option<String>):

    The ARN of the resource group from which tags have been removed.

  • keys(Option<Vec::<String>>):

    The keys of the tags that were removed.

• On failure, responds with SdkError<UntagError>

impl Client

pub fn update_account_settings(&self) -> UpdateAccountSettingsFluentBuilder

Constructs a fluent builder for the UpdateAccountSettings operation.

• The fluent builder is configurable:
  • group_lifecycle_events_desired_status(GroupLifecycleEventsDesiredStatus) / set_group_lifecycle_events_desired_status(Option<GroupLifecycleEventsDesiredStatus>):
    required: false
    

    Specifies whether you want to turn group lifecycle events on or off.

    
    
• On success, responds with UpdateAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    A structure that displays the status of the optional features in the account.

• On failure, responds with SdkError<UpdateAccountSettingsError>

impl Client

pub fn update_group(&self) -> UpdateGroupFluentBuilder

Constructs a fluent builder for the UpdateGroup operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    Don’t use this parameter. Use Group instead.

    
    
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or the ARN of the resource group to modify.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.

    
    
• On success, responds with UpdateGroupOutput with field(s):
  • group(Option<Group>):

    The update description of the resource group.

• On failure, responds with SdkError<UpdateGroupError>

impl Client

pub fn update_group_query(&self) -> UpdateGroupQueryFluentBuilder

Constructs a fluent builder for the UpdateGroupQuery operation.

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    Don’t use this parameter. Use Group instead.

    
    
  • group(impl Into<String>) / set_group(Option<String>):
    required: false
    

    The name or the ARN of the resource group to query.

    
    
  • resource_query(ResourceQuery) / set_resource_query(Option<ResourceQuery>):
    required: true
    

    The resource query to determine which Amazon Web Services resources are members of this resource group.

    A resource group can contain either a Configuration or a ResourceQuery, but not both.

    
    
• On success, responds with UpdateGroupQueryOutput with field(s):
  • group_query(Option<GroupQuery>):

    The updated resource query associated with the resource group after the update.

• On failure, responds with SdkError<UpdateGroupQueryError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.