Struct Client

pub struct Client { /* private fields */ }

Client for AWS Support App

Client for invoking operations on AWS Support App. Each operation on AWS Support App 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_supportapp::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 Builder 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_supportapp::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 CreateSlackChannelConfiguration operation has a Client::create_slack_channel_configuration, 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_slack_channel_configuration()
    .team_id("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_slack_channel_configuration( &self, ) -> CreateSlackChannelConfigurationFluentBuilder

Constructs a fluent builder for the CreateSlackChannelConfiguration operation.

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

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

    
    
  • channel_id(impl Into<String>) / set_channel_id(Option<String>):
    required: true
    

    The channel ID in Slack. This ID identifies a channel within a Slack workspace.

    
    
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: false
    

    The name of the Slack channel that you configure for the Amazon Web Services Support App.

    
    
  • notify_on_create_or_reopen_case(bool) / set_notify_on_create_or_reopen_case(Option<bool>):
    required: false
    

    Whether you want to get notified when a support case is created or reopened.

    
    
  • notify_on_add_correspondence_to_case(bool) / set_notify_on_add_correspondence_to_case(Option<bool>):
    required: false
    

    Whether you want to get notified when a support case has a new correspondence.

    
    
  • notify_on_resolve_case(bool) / set_notify_on_resolve_case(Option<bool>):
    required: false
    

    Whether you want to get notified when a support case is resolved.

    
    
  • notify_on_case_severity(NotificationSeverityLevel) / set_notify_on_case_severity(Option<NotificationSeverityLevel>):
    required: true
    

    The case severity for a support case that you want to receive notifications.

    If you specify high or all, you must specify true for at least one of the following parameters:

    • notifyOnAddCorrespondenceToCase

    • notifyOnCreateOrReopenCase

    • notifyOnResolveCase

    If you specify none, the following parameters must be null or false:

    • notifyOnAddCorrespondenceToCase

    • notifyOnCreateOrReopenCase

    • notifyOnResolveCase

    If you don’t specify these parameters in your request, they default to false.

    
    
  • channel_role_arn(impl Into<String>) / set_channel_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

    
    
• On success, responds with CreateSlackChannelConfigurationOutput
• On failure, responds with SdkError<CreateSlackChannelConfigurationError>

impl Client

pub fn delete_account_alias(&self) -> DeleteAccountAliasFluentBuilder

Constructs a fluent builder for the DeleteAccountAlias operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteAccountAliasOutput
• On failure, responds with SdkError<DeleteAccountAliasError>

impl Client

pub fn delete_slack_channel_configuration( &self, ) -> DeleteSlackChannelConfigurationFluentBuilder

Constructs a fluent builder for the DeleteSlackChannelConfiguration operation.

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

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

    
    
  • channel_id(impl Into<String>) / set_channel_id(Option<String>):
    required: true
    

    The channel ID in Slack. This ID identifies a channel within a Slack workspace.

    
    
• On success, responds with DeleteSlackChannelConfigurationOutput
• On failure, responds with SdkError<DeleteSlackChannelConfigurationError>

impl Client

pub fn delete_slack_workspace_configuration( &self, ) -> DeleteSlackWorkspaceConfigurationFluentBuilder

Constructs a fluent builder for the DeleteSlackWorkspaceConfiguration operation.

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

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

    
    
• On success, responds with DeleteSlackWorkspaceConfigurationOutput
• On failure, responds with SdkError<DeleteSlackWorkspaceConfigurationError>

impl Client

pub fn get_account_alias(&self) -> GetAccountAliasFluentBuilder

Constructs a fluent builder for the GetAccountAlias operation.

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

    An alias or short name for an Amazon Web Services account.

• On failure, responds with SdkError<GetAccountAliasError>

impl Client

pub fn list_slack_channel_configurations( &self, ) -> ListSlackChannelConfigurationsFluentBuilder

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

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

    If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn’t include a pagination token value.

    
    
• On success, responds with ListSlackChannelConfigurationsOutput with field(s):
  • next_token(Option<String>):

    The point where pagination should resume when the response returns only partial results.

  • slack_channel_configurations(Vec::<SlackChannelConfiguration>):

    The configurations for a Slack channel.

• On failure, responds with SdkError<ListSlackChannelConfigurationsError>

impl Client

pub fn list_slack_workspace_configurations( &self, ) -> ListSlackWorkspaceConfigurationsFluentBuilder

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

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

    If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn’t include a pagination token value.

    
    
• On success, responds with ListSlackWorkspaceConfigurationsOutput with field(s):
  • next_token(Option<String>):

    The point where pagination should resume when the response returns only partial results.

  • slack_workspace_configurations(Option<Vec::<SlackWorkspaceConfiguration>>):

    The configurations for a Slack workspace.

• On failure, responds with SdkError<ListSlackWorkspaceConfigurationsError>

impl Client

pub fn put_account_alias(&self) -> PutAccountAliasFluentBuilder

Constructs a fluent builder for the PutAccountAlias operation.

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

    An alias or short name for an Amazon Web Services account.

    
    
• On success, responds with PutAccountAliasOutput
• On failure, responds with SdkError<PutAccountAliasError>

impl Client

pub fn register_slack_workspace_for_organization( &self, ) -> RegisterSlackWorkspaceForOrganizationFluentBuilder

Constructs a fluent builder for the RegisterSlackWorkspaceForOrganization operation.

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

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG. Specify the Slack workspace that you want to use for your organization.

    
    
• On success, responds with RegisterSlackWorkspaceForOrganizationOutput with field(s):
  • team_id(Option<String>):

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

  • team_name(Option<String>):

    The name of the Slack workspace.

  • account_type(Option<AccountType>):

    Whether the Amazon Web Services account is a management or member account that’s part of an organization in Organizations.

• On failure, responds with SdkError<RegisterSlackWorkspaceForOrganizationError>

impl Client

pub fn update_slack_channel_configuration( &self, ) -> UpdateSlackChannelConfigurationFluentBuilder

Constructs a fluent builder for the UpdateSlackChannelConfiguration operation.

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

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

    
    
  • channel_id(impl Into<String>) / set_channel_id(Option<String>):
    required: true
    

    The channel ID in Slack. This ID identifies a channel within a Slack workspace.

    
    
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: false
    

    The Slack channel name that you want to update.

    
    
  • notify_on_create_or_reopen_case(bool) / set_notify_on_create_or_reopen_case(Option<bool>):
    required: false
    

    Whether you want to get notified when a support case is created or reopened.

    
    
  • notify_on_add_correspondence_to_case(bool) / set_notify_on_add_correspondence_to_case(Option<bool>):
    required: false
    

    Whether you want to get notified when a support case has a new correspondence.

    
    
  • notify_on_resolve_case(bool) / set_notify_on_resolve_case(Option<bool>):
    required: false
    

    Whether you want to get notified when a support case is resolved.

    
    
  • notify_on_case_severity(NotificationSeverityLevel) / set_notify_on_case_severity(Option<NotificationSeverityLevel>):
    required: false
    

    The case severity for a support case that you want to receive notifications.

    If you specify high or all, at least one of the following parameters must be true:

    • notifyOnAddCorrespondenceToCase

    • notifyOnCreateOrReopenCase

    • notifyOnResolveCase

    If you specify none, any of the following parameters that you specify in your request must be false:

    • notifyOnAddCorrespondenceToCase

    • notifyOnCreateOrReopenCase

    • notifyOnResolveCase

    If you don’t specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.

    
    
  • channel_role_arn(impl Into<String>) / set_channel_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

    
    
• On success, responds with UpdateSlackChannelConfigurationOutput with field(s):
  • team_id(Option<String>):

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

  • channel_id(Option<String>):

    The channel ID in Slack. This ID identifies a channel within a Slack workspace.

  • channel_name(Option<String>):

    The name of the Slack channel that you configure for the Amazon Web Services Support App.

  • notify_on_create_or_reopen_case(Option<bool>):

    Whether you want to get notified when a support case is created or reopened.

  • notify_on_add_correspondence_to_case(Option<bool>):

    Whether you want to get notified when a support case has a new correspondence.

  • notify_on_resolve_case(Option<bool>):

    Whether you want to get notified when a support case is resolved.

  • notify_on_case_severity(Option<NotificationSeverityLevel>):

    The case severity for a support case that you want to receive notifications.

  • channel_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

• On failure, responds with SdkError<UpdateSlackChannelConfigurationError>

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 duplicate 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.