Struct aws_sdk_supportapp::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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_supportapp::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_supportapp::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_supportapp::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn create_slack_channel_configuration(
    &self
) -> CreateSlackChannelConfiguration

Constructs a fluent builder for the CreateSlackChannelConfiguration operation.

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

    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>):

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

  • channel_name(impl Into<String>) / set_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(bool) / set_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(bool) / set_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(bool) / set_notify_on_resolve_case(Option<bool>):

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

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

    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>):

    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>

pub fn delete_account_alias(&self) -> DeleteAccountAlias

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>

pub fn delete_slack_channel_configuration(
    &self
) -> DeleteSlackChannelConfiguration

Constructs a fluent builder for the DeleteSlackChannelConfiguration operation.

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

    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>):

    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>

pub fn delete_slack_workspace_configuration(
    &self
) -> DeleteSlackWorkspaceConfiguration

Constructs a fluent builder for the DeleteSlackWorkspaceConfiguration operation.

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

    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>

pub fn get_account_alias(&self) -> GetAccountAlias

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>

pub fn list_slack_channel_configurations(
    &self
) -> ListSlackChannelConfigurations

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>):

    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(Option<Vec<SlackChannelConfiguration>>):

    The configurations for a Slack channel.

• On failure, responds with SdkError<ListSlackChannelConfigurationsError>

pub fn list_slack_workspace_configurations(
    &self
) -> ListSlackWorkspaceConfigurations

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>):

    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>

pub fn put_account_alias(&self) -> PutAccountAlias

Constructs a fluent builder for the PutAccountAlias operation.

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

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

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

pub fn register_slack_workspace_for_organization(
    &self
) -> RegisterSlackWorkspaceForOrganization

Constructs a fluent builder for the RegisterSlackWorkspaceForOrganization operation.

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

    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>

pub fn update_slack_channel_configuration(
    &self
) -> UpdateSlackChannelConfiguration

Constructs a fluent builder for the UpdateSlackChannelConfiguration operation.

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

    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>):

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

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

    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>):

    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>):

    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>):

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

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

    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>):

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

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.