Struct Client

pub struct Client { /* private fields */ }

Client for AWS Support

Client for invoking operations on AWS Support. Each operation on AWS Support 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_support::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_support::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 AddAttachmentsToSet operation has a Client::add_attachments_to_set, 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.add_attachments_to_set()
    .attachment_set_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 add_attachments_to_set(&self) -> AddAttachmentsToSetFluentBuilder

Constructs a fluent builder for the AddAttachmentsToSet operation.

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

    The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

    
    
  • attachments(Attachment) / set_attachments(Option<Vec::<Attachment>>):
    required: true
    

    One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.

    In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

    
    
• On success, responds with AddAttachmentsToSetOutput with field(s):
  • attachment_set_id(Option<String>):

    The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.

  • expiry_time(Option<String>):

    The time and date when the attachment set expires.

• On failure, responds with SdkError<AddAttachmentsToSetError>

impl Client

pub fn add_communication_to_case(&self) -> AddCommunicationToCaseFluentBuilder

Constructs a fluent builder for the AddCommunicationToCase operation.

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

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    
    
  • communication_body(impl Into<String>) / set_communication_body(Option<String>):
    required: true
    

    The body of an email communication to add to the support case.

    
    
  • cc_email_addresses(impl Into<String>) / set_cc_email_addresses(Option<Vec::<String>>):
    required: false
    

    The email addresses in the CC line of an email to be added to the support case.

    
    
  • attachment_set_id(impl Into<String>) / set_attachment_set_id(Option<String>):
    required: false
    

    The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

    
    
• On success, responds with AddCommunicationToCaseOutput with field(s):
  • result(bool):

    True if AddCommunicationToCase succeeds. Otherwise, returns an error.

• On failure, responds with SdkError<AddCommunicationToCaseError>

impl Client

pub fn create_case(&self) -> CreateCaseFluentBuilder

Constructs a fluent builder for the CreateCase operation.

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

    The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

    
    
  • service_code(impl Into<String>) / set_service_code(Option<String>):
    required: false
    

    The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

    
    
  • severity_code(impl Into<String>) / set_severity_code(Option<String>):
    required: false
    

    A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode.

    For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.

    The availability of severity levels depends on the support plan for the Amazon Web Services account.

    
    
  • category_code(impl Into<String>) / set_category_code(Option<String>):
    required: false
    

    The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

    
    
  • communication_body(impl Into<String>) / set_communication_body(Option<String>):
    required: true
    

    The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.

    
    
  • cc_email_addresses(impl Into<String>) / set_cc_email_addresses(Option<Vec::<String>>):
    required: false
    

    A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (“en”), Japanese (“ja”) and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

    
    
  • issue_type(impl Into<String>) / set_issue_type(Option<String>):
    required: false
    

    The type of issue for the case. You can specify customer-service or technical. If you don’t specify a value, the default is technical.

    
    
  • attachment_set_id(impl Into<String>) / set_attachment_set_id(Option<String>):
    required: false
    

    The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.

    
    
• On success, responds with CreateCaseOutput with field(s):
  • case_id(Option<String>):

    The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47

• On failure, responds with SdkError<CreateCaseError>

impl Client

pub fn describe_attachment(&self) -> DescribeAttachmentFluentBuilder

Constructs a fluent builder for the DescribeAttachment operation.

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

    The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

    
    
• On success, responds with DescribeAttachmentOutput with field(s):
  • attachment(Option<Attachment>):

    This object includes the attachment content and file name.

    In the previous response syntax, the value for the data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

• On failure, responds with SdkError<DescribeAttachmentError>

impl Client

pub fn describe_cases(&self) -> DescribeCasesFluentBuilder

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

• The fluent builder is configurable:
  • case_id_list(impl Into<String>) / set_case_id_list(Option<Vec::<String>>):
    required: false
    

    A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

    
    
  • display_id(impl Into<String>) / set_display_id(Option<String>):
    required: false
    

    The ID displayed for a case in the Amazon Web Services Support Center user interface.

    
    
  • after_time(impl Into<String>) / set_after_time(Option<String>):
    required: false
    

    The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    
    
  • before_time(impl Into<String>) / set_before_time(Option<String>):
    required: false
    

    The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    
    
  • include_resolved_cases(bool) / set_include_resolved_cases(Option<bool>):
    required: false
    

    Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren’t included.

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

    A resumption point for pagination.

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

    The maximum number of results to return before paginating.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (“en”), Japanese (“ja”) and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

    
    
  • include_communications(bool) / set_include_communications(Option<bool>):
    required: false
    

    Specifies whether to include communications in the DescribeCases response. By default, communications are included.

    
    
• On success, responds with DescribeCasesOutput with field(s):
  • cases(Option<Vec::<CaseDetails>>):

    The details for the cases that match the request.

  • next_token(Option<String>):

    A resumption point for pagination.

• On failure, responds with SdkError<DescribeCasesError>

impl Client

pub fn describe_communications(&self) -> DescribeCommunicationsFluentBuilder

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

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

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    
    
  • before_time(impl Into<String>) / set_before_time(Option<String>):
    required: false
    

    The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    
    
  • after_time(impl Into<String>) / set_after_time(Option<String>):
    required: false
    

    The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

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

    A resumption point for pagination.

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

    The maximum number of results to return before paginating.

    
    
• On success, responds with DescribeCommunicationsOutput with field(s):
  • communications(Option<Vec::<Communication>>):

    The communications for the case.

  • next_token(Option<String>):

    A resumption point for pagination.

• On failure, responds with SdkError<DescribeCommunicationsError>

impl Client

pub fn describe_create_case_options( &self, ) -> DescribeCreateCaseOptionsFluentBuilder

Constructs a fluent builder for the DescribeCreateCaseOptions operation.

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

    The type of issue for the case. You can specify customer-service or technical. If you don’t specify a value, the default is technical.

    
    
  • service_code(impl Into<String>) / set_service_code(Option<String>):
    required: true
    

    The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: true
    

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (“en”), Japanese (“ja”) and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

    
    
  • category_code(impl Into<String>) / set_category_code(Option<String>):
    required: true
    

    The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

    
    
• On success, responds with DescribeCreateCaseOptionsOutput with field(s):
  • language_availability(Option<String>):

    Language availability can be any of the following:

    • available

    • best_effort

    • unavailable

  • communication_types(Option<Vec::<CommunicationTypeOptions>>):

    A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.

• On failure, responds with SdkError<DescribeCreateCaseOptionsError>

impl Client

pub fn describe_services(&self) -> DescribeServicesFluentBuilder

Constructs a fluent builder for the DescribeServices operation.

• The fluent builder is configurable:
  • service_code_list(impl Into<String>) / set_service_code_list(Option<Vec::<String>>):
    required: false
    

    A JSON-formatted list of service codes available for Amazon Web Services services.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (“en”), Japanese (“ja”) and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

    
    
• On success, responds with DescribeServicesOutput with field(s):
  • services(Option<Vec::<Service>>):

    A JSON-formatted list of Amazon Web Services services.

• On failure, responds with SdkError<DescribeServicesError>

impl Client

pub fn describe_severity_levels(&self) -> DescribeSeverityLevelsFluentBuilder

Constructs a fluent builder for the DescribeSeverityLevels operation.

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

    The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (“en”), Japanese (“ja”) and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

    
    
• On success, responds with DescribeSeverityLevelsOutput with field(s):
  • severity_levels(Option<Vec::<SeverityLevel>>):

    The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.

• On failure, responds with SdkError<DescribeSeverityLevelsError>

impl Client

pub fn describe_supported_languages( &self, ) -> DescribeSupportedLanguagesFluentBuilder

Constructs a fluent builder for the DescribeSupportedLanguages operation.

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

    The type of issue for the case. You can specify customer-service or technical.

    
    
  • service_code(impl Into<String>) / set_service_code(Option<String>):
    required: true
    

    The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

    
    
  • category_code(impl Into<String>) / set_category_code(Option<String>):
    required: true
    

    The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

    
    
• On success, responds with DescribeSupportedLanguagesOutput with field(s):
  • supported_languages(Option<Vec::<SupportedLanguage>>):

    A JSON-formatted array that contains the available ISO 639-1 language codes.

• On failure, responds with SdkError<DescribeSupportedLanguagesError>

impl Client

pub fn describe_trusted_advisor_check_refresh_statuses( &self, ) -> DescribeTrustedAdvisorCheckRefreshStatusesFluentBuilder

Constructs a fluent builder for the DescribeTrustedAdvisorCheckRefreshStatuses operation.

• The fluent builder is configurable:
  • check_ids(Option<String>) / set_check_ids(Option<Vec::<Option<String>>>):
    required: true
    

    The IDs of the Trusted Advisor checks to get the status.

    If you specify the check ID of a check that is automatically refreshed, you might see an InvalidParameterValue error.

    
    
• On success, responds with DescribeTrustedAdvisorCheckRefreshStatusesOutput with field(s):
  • statuses(Vec::<TrustedAdvisorCheckRefreshStatus>):

    The refresh status of the specified Trusted Advisor checks.

• On failure, responds with SdkError<DescribeTrustedAdvisorCheckRefreshStatusesError>

impl Client

pub fn describe_trusted_advisor_check_result( &self, ) -> DescribeTrustedAdvisorCheckResultFluentBuilder

Constructs a fluent builder for the DescribeTrustedAdvisorCheckResult operation.

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

    The unique identifier for the Trusted Advisor check.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    The ISO 639-1 code for the language that you want your check results to appear in.

    The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

    • Chinese, Simplified - zh

    • Chinese, Traditional - zh_TW

    • English - en

    • French - fr

    • German - de

    • Indonesian - id

    • Italian - it

    • Japanese - ja

    • Korean - ko

    • Portuguese, Brazilian - pt_BR

    • Spanish - es

    
    
• On success, responds with DescribeTrustedAdvisorCheckResultOutput with field(s):
  • result(Option<TrustedAdvisorCheckResult>):

    The detailed results of the Trusted Advisor check.

• On failure, responds with SdkError<DescribeTrustedAdvisorCheckResultError>

impl Client

pub fn describe_trusted_advisor_check_summaries( &self, ) -> DescribeTrustedAdvisorCheckSummariesFluentBuilder

Constructs a fluent builder for the DescribeTrustedAdvisorCheckSummaries operation.

• The fluent builder is configurable:
  • check_ids(Option<String>) / set_check_ids(Option<Vec::<Option<String>>>):
    required: true
    

    The IDs of the Trusted Advisor checks.

    
    
• On success, responds with DescribeTrustedAdvisorCheckSummariesOutput with field(s):
  • summaries(Vec::<TrustedAdvisorCheckSummary>):

    The summary information for the requested Trusted Advisor checks.

• On failure, responds with SdkError<DescribeTrustedAdvisorCheckSummariesError>

impl Client

pub fn describe_trusted_advisor_checks( &self, ) -> DescribeTrustedAdvisorChecksFluentBuilder

Constructs a fluent builder for the DescribeTrustedAdvisorChecks operation.

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

    The ISO 639-1 code for the language that you want your checks to appear in.

    The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

    • Chinese, Simplified - zh

    • Chinese, Traditional - zh_TW

    • English - en

    • French - fr

    • German - de

    • Indonesian - id

    • Italian - it

    • Japanese - ja

    • Korean - ko

    • Portuguese, Brazilian - pt_BR

    • Spanish - es

    
    
• On success, responds with DescribeTrustedAdvisorChecksOutput with field(s):
  • checks(Vec::<TrustedAdvisorCheckDescription>):

    Information about all available Trusted Advisor checks.

• On failure, responds with SdkError<DescribeTrustedAdvisorChecksError>

impl Client

pub fn refresh_trusted_advisor_check( &self, ) -> RefreshTrustedAdvisorCheckFluentBuilder

Constructs a fluent builder for the RefreshTrustedAdvisorCheck operation.

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

    The unique identifier for the Trusted Advisor check to refresh.

    Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

    
    
• On success, responds with RefreshTrustedAdvisorCheckOutput with field(s):
  • status(Option<TrustedAdvisorCheckRefreshStatus>):

    The current refresh status for a check, including the amount of time until the check is eligible for refresh.

• On failure, responds with SdkError<RefreshTrustedAdvisorCheckError>

impl Client

pub fn resolve_case(&self) -> ResolveCaseFluentBuilder

Constructs a fluent builder for the ResolveCase operation.

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

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    
    
• On success, responds with ResolveCaseOutput with field(s):
  • initial_case_status(Option<String>):

    The status of the case when the ResolveCase request was sent.

  • final_case_status(Option<String>):

    The status of the case after the ResolveCase request was processed.

• On failure, responds with SdkError<ResolveCaseError>

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.