Struct aws_sdk_chimesdkidentity::Client

pub struct Client { /* private fields */ }

Client for Amazon Chime SDK Identity

Client for invoking operations on Amazon Chime SDK Identity. Each operation on Amazon Chime SDK Identity 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_chimesdkidentity::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_chimesdkidentity::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 CreateAppInstance operation has a Client::create_app_instance, 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_app_instance()
    .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_app_instance(&self) -> CreateAppInstanceFluentBuilder

Constructs a fluent builder for the CreateAppInstance operation.

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

    The name of the AppInstance.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: false
    

    The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    The unique ID of the request. Use different tokens to create different AppInstances.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags assigned to the AppInstance.

    
    
• On success, responds with CreateAppInstanceOutput with field(s):
  • app_instance_arn(Option<String>):

    The Amazon Resource Number (ARN) of the AppInstance.

• On failure, responds with SdkError<CreateAppInstanceError>

impl Client

pub fn create_app_instance_admin(&self) -> CreateAppInstanceAdminFluentBuilder

Constructs a fluent builder for the CreateAppInstanceAdmin operation.

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

    The ARN of the administrator of the current AppInstance.

    
    
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the AppInstance.

    
    
• On success, responds with CreateAppInstanceAdminOutput with field(s):
  • app_instance_admin(Option<Identity>):

    The ARN and name of the administrator, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

  • app_instance_arn(Option<String>):

    The ARN of the of the admin for the AppInstance.

• On failure, responds with SdkError<CreateAppInstanceAdminError>

impl Client

pub fn create_app_instance_bot(&self) -> CreateAppInstanceBotFluentBuilder

Constructs a fluent builder for the CreateAppInstanceBot operation.

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

    The ARN of the AppInstance request.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The user’s name.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: false
    

    The request metadata. Limited to a 1KB string in UTF-8.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    The unique ID for the client making the request. Use different tokens for different AppInstanceBots.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags assigned to the AppInstanceBot.

    
    
  • configuration(Configuration) / set_configuration(Option<Configuration>):
    required: true
    

    Configuration information about the Amazon Lex V2 V2 bot.

    
    
• On success, responds with CreateAppInstanceBotOutput with field(s):
  • app_instance_bot_arn(Option<String>):

    The ARN of the AppinstanceBot.

• On failure, responds with SdkError<CreateAppInstanceBotError>

impl Client

pub fn create_app_instance_user(&self) -> CreateAppInstanceUserFluentBuilder

Constructs a fluent builder for the CreateAppInstanceUser operation.

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

    The ARN of the AppInstance request.

    
    
  • app_instance_user_id(impl Into<String>) / set_app_instance_user_id(Option<String>):
    required: true
    

    The user ID of the AppInstance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The user’s name.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: false
    

    The request’s metadata. Limited to a 1KB string in UTF-8.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    The unique ID of the request. Use different tokens to request additional AppInstances.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags assigned to the AppInstanceUser.

    
    
  • expiration_settings(ExpirationSettings) / set_expiration_settings(Option<ExpirationSettings>):
    required: false
    

    Settings that control the interval after which the AppInstanceUser is automatically deleted.

    
    
• On success, responds with CreateAppInstanceUserOutput with field(s):
  • app_instance_user_arn(Option<String>):

    The user’s ARN.

• On failure, responds with SdkError<CreateAppInstanceUserError>

impl Client

pub fn delete_app_instance(&self) -> DeleteAppInstanceFluentBuilder

Constructs a fluent builder for the DeleteAppInstance operation.

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

    The ARN of the AppInstance.

    
    
• On success, responds with DeleteAppInstanceOutput
• On failure, responds with SdkError<DeleteAppInstanceError>

impl Client

pub fn delete_app_instance_admin(&self) -> DeleteAppInstanceAdminFluentBuilder

Constructs a fluent builder for the DeleteAppInstanceAdmin operation.

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

    The ARN of the AppInstance’s administrator.

    
    
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the AppInstance.

    
    
• On success, responds with DeleteAppInstanceAdminOutput
• On failure, responds with SdkError<DeleteAppInstanceAdminError>

impl Client

pub fn delete_app_instance_bot(&self) -> DeleteAppInstanceBotFluentBuilder

Constructs a fluent builder for the DeleteAppInstanceBot operation.

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

    The ARN of the AppInstanceBot being deleted.

    
    
• On success, responds with DeleteAppInstanceBotOutput
• On failure, responds with SdkError<DeleteAppInstanceBotError>

impl Client

pub fn delete_app_instance_user(&self) -> DeleteAppInstanceUserFluentBuilder

Constructs a fluent builder for the DeleteAppInstanceUser operation.

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

    The ARN of the user request being deleted.

    
    
• On success, responds with DeleteAppInstanceUserOutput
• On failure, responds with SdkError<DeleteAppInstanceUserError>

impl Client

pub fn deregister_app_instance_user_endpoint( &self ) -> DeregisterAppInstanceUserEndpointFluentBuilder

Constructs a fluent builder for the DeregisterAppInstanceUserEndpoint operation.

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

    The ARN of the AppInstanceUser.

    
    
  • endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
    required: true
    

    The unique identifier of the AppInstanceUserEndpoint.

    
    
• On success, responds with DeregisterAppInstanceUserEndpointOutput
• On failure, responds with SdkError<DeregisterAppInstanceUserEndpointError>

impl Client

pub fn describe_app_instance(&self) -> DescribeAppInstanceFluentBuilder

Constructs a fluent builder for the DescribeAppInstance operation.

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

    The ARN of the AppInstance.

    
    
• On success, responds with DescribeAppInstanceOutput with field(s):
  • app_instance(Option<AppInstance>):

    The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.

• On failure, responds with SdkError<DescribeAppInstanceError>

impl Client

pub fn describe_app_instance_admin( &self ) -> DescribeAppInstanceAdminFluentBuilder

Constructs a fluent builder for the DescribeAppInstanceAdmin operation.

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

    The ARN of the AppInstanceAdmin.

    
    
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the AppInstance.

    
    
• On success, responds with DescribeAppInstanceAdminOutput with field(s):
  • app_instance_admin(Option<AppInstanceAdmin>):

    The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

• On failure, responds with SdkError<DescribeAppInstanceAdminError>

impl Client

pub fn describe_app_instance_bot(&self) -> DescribeAppInstanceBotFluentBuilder

Constructs a fluent builder for the DescribeAppInstanceBot operation.

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

    The ARN of the AppInstanceBot.

    
    
• On success, responds with DescribeAppInstanceBotOutput with field(s):
  • app_instance_bot(Option<AppInstanceBot>):

    The detials of the AppInstanceBot.

• On failure, responds with SdkError<DescribeAppInstanceBotError>

impl Client

pub fn describe_app_instance_user(&self) -> DescribeAppInstanceUserFluentBuilder

Constructs a fluent builder for the DescribeAppInstanceUser operation.

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

    The ARN of the AppInstanceUser.

    
    
• On success, responds with DescribeAppInstanceUserOutput with field(s):
  • app_instance_user(Option<AppInstanceUser>):

    The name of the AppInstanceUser.

• On failure, responds with SdkError<DescribeAppInstanceUserError>

impl Client

pub fn describe_app_instance_user_endpoint( &self ) -> DescribeAppInstanceUserEndpointFluentBuilder

Constructs a fluent builder for the DescribeAppInstanceUserEndpoint operation.

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

    The ARN of the AppInstanceUser.

    
    
  • endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
    required: true
    

    The unique identifier of the AppInstanceUserEndpoint.

    
    
• On success, responds with DescribeAppInstanceUserEndpointOutput with field(s):
  • app_instance_user_endpoint(Option<AppInstanceUserEndpoint>):

    The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.

• On failure, responds with SdkError<DescribeAppInstanceUserEndpointError>

impl Client

pub fn get_app_instance_retention_settings( &self ) -> GetAppInstanceRetentionSettingsFluentBuilder

Constructs a fluent builder for the GetAppInstanceRetentionSettings operation.

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

    The ARN of the AppInstance.

    
    
• On success, responds with GetAppInstanceRetentionSettingsOutput with field(s):
  • app_instance_retention_settings(Option<AppInstanceRetentionSettings>):

    The retention settings for the AppInstance.

  • initiate_deletion_timestamp(Option<DateTime>):

    The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

• On failure, responds with SdkError<GetAppInstanceRetentionSettingsError>

impl Client

pub fn list_app_instance_admins(&self) -> ListAppInstanceAdminsFluentBuilder

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

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

    The ARN of the AppInstance.

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

    The maximum number of administrators that you want to return.

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

    The token returned from previous API requests until the number of administrators is reached.

    
    
• On success, responds with ListAppInstanceAdminsOutput with field(s):
  • app_instance_arn(Option<String>):

    The ARN of the AppInstance.

  • app_instance_admins(Option<Vec::<AppInstanceAdminSummary>>):

    The information for each administrator.

  • next_token(Option<String>):

    The token returned from previous API requests until the number of administrators is reached.

• On failure, responds with SdkError<ListAppInstanceAdminsError>

impl Client

pub fn list_app_instance_bots(&self) -> ListAppInstanceBotsFluentBuilder

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

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

    The ARN of the AppInstance.

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

    The maximum number of requests to return.

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

    The token passed by previous API calls until all requested bots are returned.

    
    
• On success, responds with ListAppInstanceBotsOutput with field(s):
  • app_instance_arn(Option<String>):

    The ARN of the AppInstance.

  • app_instance_bots(Option<Vec::<AppInstanceBotSummary>>):

    The information for each requested AppInstanceBot.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested bots are returned.

• On failure, responds with SdkError<ListAppInstanceBotsError>

impl Client

pub fn list_app_instance_user_endpoints( &self ) -> ListAppInstanceUserEndpointsFluentBuilder

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

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

    The ARN of the AppInstanceUser.

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

    The maximum number of endpoints that you want to return.

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

    The token passed by previous API calls until all requested endpoints are returned.

    
    
• On success, responds with ListAppInstanceUserEndpointsOutput with field(s):
  • app_instance_user_endpoints(Option<Vec::<AppInstanceUserEndpointSummary>>):

    The information for each requested AppInstanceUserEndpoint.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested endpoints are returned.

• On failure, responds with SdkError<ListAppInstanceUserEndpointsError>

impl Client

pub fn list_app_instance_users(&self) -> ListAppInstanceUsersFluentBuilder

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

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

    The ARN of the AppInstance.

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

    The maximum number of requests that you want returned.

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

    The token passed by previous API calls until all requested users are returned.

    
    
• On success, responds with ListAppInstanceUsersOutput with field(s):
  • app_instance_arn(Option<String>):

    The ARN of the AppInstance.

  • app_instance_users(Option<Vec::<AppInstanceUserSummary>>):

    The information for each requested AppInstanceUser.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested users are returned.

• On failure, responds with SdkError<ListAppInstanceUsersError>

impl Client

pub fn list_app_instances(&self) -> ListAppInstancesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of AppInstances that you want to return.

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

    The token passed by previous API requests until you reach the maximum number of AppInstances.

    
    
• On success, responds with ListAppInstancesOutput with field(s):
  • app_instances(Option<Vec::<AppInstanceSummary>>):

    The information for each AppInstance.

  • next_token(Option<String>):

    The token passed by previous API requests until the maximum number of AppInstances is reached.

• On failure, responds with SdkError<ListAppInstancesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The ARN of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tag key-value pairs.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_app_instance_retention_settings( &self ) -> PutAppInstanceRetentionSettingsFluentBuilder

Constructs a fluent builder for the PutAppInstanceRetentionSettings operation.

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

    The ARN of the AppInstance.

    
    
  • app_instance_retention_settings(AppInstanceRetentionSettings) / set_app_instance_retention_settings(Option<AppInstanceRetentionSettings>):
    required: true
    

    The time in days to retain data. Data type: number.

    
    
• On success, responds with PutAppInstanceRetentionSettingsOutput with field(s):
  • app_instance_retention_settings(Option<AppInstanceRetentionSettings>):

    The time in days to retain data. Data type: number.

  • initiate_deletion_timestamp(Option<DateTime>):

    The time at which the API deletes data.

• On failure, responds with SdkError<PutAppInstanceRetentionSettingsError>

impl Client

pub fn put_app_instance_user_expiration_settings( &self ) -> PutAppInstanceUserExpirationSettingsFluentBuilder

Constructs a fluent builder for the PutAppInstanceUserExpirationSettings operation.

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

    The ARN of the AppInstanceUser.

    
    
  • expiration_settings(ExpirationSettings) / set_expiration_settings(Option<ExpirationSettings>):
    required: false
    

    Settings that control the interval after which an AppInstanceUser is automatically deleted.

    
    
• On success, responds with PutAppInstanceUserExpirationSettingsOutput with field(s):
  • app_instance_user_arn(Option<String>):

    The ARN of the AppInstanceUser.

  • expiration_settings(Option<ExpirationSettings>):

    Settings that control the interval after which an AppInstanceUser is automatically deleted.

• On failure, responds with SdkError<PutAppInstanceUserExpirationSettingsError>

impl Client

pub fn register_app_instance_user_endpoint( &self ) -> RegisterAppInstanceUserEndpointFluentBuilder

Constructs a fluent builder for the RegisterAppInstanceUserEndpoint operation.

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

    The ARN of the AppInstanceUser.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the AppInstanceUserEndpoint.

    
    
  • r#type(AppInstanceUserEndpointType) / set_type(Option<AppInstanceUserEndpointType>):
    required: true
    

    The type of the AppInstanceUserEndpoint. Supported types:

    • APNS: The mobile notification service for an Apple device.

    • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

    • GCM: The mobile notification service for an Android device.

    Populate the ResourceArn value of each type as PinpointAppArn.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to which the endpoint belongs.

    
    
  • endpoint_attributes(EndpointAttributes) / set_endpoint_attributes(Option<EndpointAttributes>):
    required: true
    

    The attributes of an Endpoint.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    The unique ID assigned to the request. Use different tokens to register other endpoints.

    
    
  • allow_messages(AllowMessages) / set_allow_messages(Option<AllowMessages>):
    required: false
    

    Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

    
    
• On success, responds with RegisterAppInstanceUserEndpointOutput with field(s):
  • app_instance_user_arn(Option<String>):

    The ARN of the AppInstanceUser.

  • endpoint_id(Option<String>):

    The unique identifier of the AppInstanceUserEndpoint.

• On failure, responds with SdkError<RegisterAppInstanceUserEndpointError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The resource ARN.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tag key-value pairs.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The resource ARN.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_app_instance(&self) -> UpdateAppInstanceFluentBuilder

Constructs a fluent builder for the UpdateAppInstance operation.

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

    The ARN of the AppInstance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name that you want to change.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: true
    

    The metadata that you want to change.

    
    
• On success, responds with UpdateAppInstanceOutput with field(s):
  • app_instance_arn(Option<String>):

    The ARN of the AppInstance.

• On failure, responds with SdkError<UpdateAppInstanceError>

impl Client

pub fn update_app_instance_bot(&self) -> UpdateAppInstanceBotFluentBuilder

Constructs a fluent builder for the UpdateAppInstanceBot operation.

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

    The ARN of the AppInstanceBot.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the AppInstanceBot.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: true
    

    The metadata of the AppInstanceBot.

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

    The configuration for the bot update.

    
    
• On success, responds with UpdateAppInstanceBotOutput with field(s):
  • app_instance_bot_arn(Option<String>):

    The ARN of the AppInstanceBot.

• On failure, responds with SdkError<UpdateAppInstanceBotError>

impl Client

pub fn update_app_instance_user(&self) -> UpdateAppInstanceUserFluentBuilder

Constructs a fluent builder for the UpdateAppInstanceUser operation.

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

    The ARN of the AppInstanceUser.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the AppInstanceUser.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: true
    

    The metadata of the AppInstanceUser.

    
    
• On success, responds with UpdateAppInstanceUserOutput with field(s):
  • app_instance_user_arn(Option<String>):

    The ARN of the AppInstanceUser.

• On failure, responds with SdkError<UpdateAppInstanceUserError>

impl Client

pub fn update_app_instance_user_endpoint( &self ) -> UpdateAppInstanceUserEndpointFluentBuilder

Constructs a fluent builder for the UpdateAppInstanceUserEndpoint operation.

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

    The ARN of the AppInstanceUser.

    
    
  • endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
    required: true
    

    The unique identifier of the AppInstanceUserEndpoint.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the AppInstanceUserEndpoint.

    
    
  • allow_messages(AllowMessages) / set_allow_messages(Option<AllowMessages>):
    required: false
    

    Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

    
    
• On success, responds with UpdateAppInstanceUserEndpointOutput with field(s):
  • app_instance_user_arn(Option<String>):

    The ARN of the AppInstanceUser.

  • endpoint_id(Option<String>):

    The unique identifier of the AppInstanceUserEndpoint.

• On failure, responds with SdkError<UpdateAppInstanceUserEndpointError>

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.