Class: Aws::Support::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-support/lib/aws-sdk-support/client.rb

Overview

An API client for Support. To construct a client, you need to configure a :region and :credentials.

client = Aws::Support::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Support::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Support::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



395
396
397
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 395

def initialize(*args)
  super
end

Instance Method Details

#add_attachments_to_set(params = {}) ⇒ Types::AddAttachmentsToSetResponse

Adds one or more attachments to an attachment set.

An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.add_attachments_to_set({
  attachment_set_id: "AttachmentSetId",
  attachments: [ # required
    {
      file_name: "FileName",
      data: "data",
    },
  ],
})

Response structure


resp.attachment_set_id #=> String
resp.expiry_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attachment_set_id (String) —

    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 (required, Array<Types::Attachment>) —

    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.

Returns:

See Also:



465
466
467
468
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 465

def add_attachments_to_set(params = {}, options = {})
  req = build_request(:add_attachments_to_set, params)
  req.send_request(options)
end

#add_communication_to_case(params = {}) ⇒ Types::AddCommunicationToCaseResponse

Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.add_communication_to_case({
  case_id: "CaseId",
  communication_body: "CommunicationBody", # required
  cc_email_addresses: ["CcEmailAddress"],
  attachment_set_id: "AttachmentSetId",
})

Response structure


resp.result #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :case_id (String) —

    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 (required, String) —

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

  • :cc_email_addresses (Array<String>) —

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

  • :attachment_set_id (String) —

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

Returns:

See Also:



528
529
530
531
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 528

def add_communication_to_case(params = {}, options = {})
  req = build_request(:add_communication_to_case, params)
  req.send_request(options)
end

#create_case(params = {}) ⇒ Types::CreateCaseResponse

Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.

The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:

A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.

The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.create_case({
  subject: "Subject", # required
  service_code: "ServiceCode",
  severity_code: "SeverityCode",
  category_code: "CategoryCode",
  communication_body: "CommunicationBody", # required
  cc_email_addresses: ["CcEmailAddress"],
  language: "Language",
  issue_type: "IssueType",
  attachment_set_id: "AttachmentSetId",
})

Response structure


resp.case_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subject (required, String) —

    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 (String) —

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

  • :severity_code (String) —

    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 (String) —

    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 (required, String) —

    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 (Array<String>) —

    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 (String) —

    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 (String) —

    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 (String) —

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

Returns:

See Also:



673
674
675
676
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 673

def create_case(params = {}, options = {})
  req = build_request(:create_case, params)
  req.send_request(options)
end

#describe_attachment(params = {}) ⇒ Types::DescribeAttachmentResponse

Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.describe_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.attachment.file_name #=> String
resp.attachment.data #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

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

Returns:

See Also:



723
724
725
726
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 723

def describe_attachment(params = {}, options = {})
  req = build_request(:describe_attachment, params)
  req.send_request(options)
end

#describe_cases(params = {}) ⇒ Types::DescribeCasesResponse

Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.

The response returns the following in JSON format:

  • One or more CaseDetails data types.

  • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_cases({
  case_id_list: ["CaseId"],
  display_id: "DisplayId",
  after_time: "AfterTime",
  before_time: "BeforeTime",
  include_resolved_cases: false,
  next_token: "NextToken",
  max_results: 1,
  language: "Language",
  include_communications: false,
})

Response structure


resp.cases #=> Array
resp.cases[0].case_id #=> String
resp.cases[0].display_id #=> String
resp.cases[0].subject #=> String
resp.cases[0].status #=> String
resp.cases[0].service_code #=> String
resp.cases[0].category_code #=> String
resp.cases[0].severity_code #=> String
resp.cases[0].submitted_by #=> String
resp.cases[0].time_created #=> String
resp.cases[0].recent_communications.communications #=> Array
resp.cases[0].recent_communications.communications[0].case_id #=> String
resp.cases[0].recent_communications.communications[0].body #=> String
resp.cases[0].recent_communications.communications[0].submitted_by #=> String
resp.cases[0].recent_communications.communications[0].time_created #=> String
resp.cases[0].recent_communications.communications[0].attachment_set #=> Array
resp.cases[0].recent_communications.communications[0].attachment_set[0].attachment_id #=> String
resp.cases[0].recent_communications.communications[0].attachment_set[0].file_name #=> String
resp.cases[0].recent_communications.next_token #=> String
resp.cases[0].cc_email_addresses #=> Array
resp.cases[0].cc_email_addresses[0] #=> String
resp.cases[0].language #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :case_id_list (Array<String>) —

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

  • :display_id (String) —

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

  • :after_time (String) —

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

  • :before_time (String) —

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

  • :include_resolved_cases (Boolean) —

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

  • :next_token (String) —

    A resumption point for pagination.

  • :max_results (Integer) —

    The maximum number of results to return before paginating.

  • :language (String) —

    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 (Boolean) —

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

Returns:

See Also:



850
851
852
853
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 850

def describe_cases(params = {}, options = {})
  req = build_request(:describe_cases, params)
  req.send_request(options)
end

#describe_communications(params = {}) ⇒ Types::DescribeCommunicationsResponse

Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_communications({
  case_id: "CaseId", # required
  before_time: "BeforeTime",
  after_time: "AfterTime",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.communications #=> Array
resp.communications[0].case_id #=> String
resp.communications[0].body #=> String
resp.communications[0].submitted_by #=> String
resp.communications[0].time_created #=> String
resp.communications[0].attachment_set #=> Array
resp.communications[0].attachment_set[0].attachment_id #=> String
resp.communications[0].attachment_set[0].file_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :case_id (required, String) —

    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 (String) —

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

  • :after_time (String) —

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

  • :next_token (String) —

    A resumption point for pagination.

  • :max_results (Integer) —

    The maximum number of results to return before paginating.

Returns:

See Also:



938
939
940
941
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 938

def describe_communications(params = {}, options = {})
  req = build_request(:describe_communications, params)
  req.send_request(options)
end

#describe_create_case_options(params = {}) ⇒ Types::DescribeCreateCaseOptionsResponse

Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.describe_create_case_options({
  issue_type: "IssueType", # required
  service_code: "ServiceCode", # required
  language: "Language", # required
  category_code: "CategoryCode", # required
})

Response structure


resp.language_availability #=> String
resp.communication_types #=> Array
resp.communication_types[0].type #=> String
resp.communication_types[0].supported_hours #=> Array
resp.communication_types[0].supported_hours[0].start_time #=> String
resp.communication_types[0].supported_hours[0].end_time #=> String
resp.communication_types[0].dates_without_support #=> Array
resp.communication_types[0].dates_without_support[0].start_date_time #=> String
resp.communication_types[0].dates_without_support[0].end_date_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :issue_type (required, String) —

    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 (required, String) —

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

  • :language (required, String) —

    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 (required, String) —

    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.

Returns:

See Also:



1015
1016
1017
1018
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1015

def describe_create_case_options(params = {}, options = {})
  req = build_request(:describe_create_case_options, params)
  req.send_request(options)
end

#describe_services(params = {}) ⇒ Types::DescribeServicesResponse

Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.

The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.describe_services({
  service_code_list: ["ServiceCode"],
  language: "Language",
})

Response structure


resp.services #=> Array
resp.services[0].code #=> String
resp.services[0].name #=> String
resp.services[0].categories #=> Array
resp.services[0].categories[0].code #=> String
resp.services[0].categories[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_code_list (Array<String>) —

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

  • :language (String) —

    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.

Returns:

See Also:



1084
1085
1086
1087
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1084

def describe_services(params = {}, options = {})
  req = build_request(:describe_services, params)
  req.send_request(options)
end

#describe_severity_levels(params = {}) ⇒ Types::DescribeSeverityLevelsResponse

Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.describe_severity_levels({
  language: "Language",
})

Response structure


resp.severity_levels #=> Array
resp.severity_levels[0].code #=> String
resp.severity_levels[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :language (String) —

    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.

Returns:

See Also:



1135
1136
1137
1138
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1135

def describe_severity_levels(params = {}, options = {})
  req = build_request(:describe_severity_levels, params)
  req.send_request(options)
end

#describe_supported_languages(params = {}) ⇒ Types::DescribeSupportedLanguagesResponse

Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.describe_supported_languages({
  issue_type: "ValidatedIssueTypeString", # required
  service_code: "ValidatedServiceCode", # required
  category_code: "ValidatedCategoryCode", # required
})

Response structure


resp.supported_languages #=> Array
resp.supported_languages[0].code #=> String
resp.supported_languages[0].language #=> String
resp.supported_languages[0].display #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :issue_type (required, String) —

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

  • :service_code (required, String) —

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

  • :category_code (required, String) —

    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.

Returns:

See Also:



1197
1198
1199
1200
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1197

def describe_supported_languages(params = {}, options = {})
  req = build_request(:describe_supported_languages, params)
  req.send_request(options)
end

#describe_trusted_advisor_check_refresh_statuses(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_trusted_advisor_check_refresh_statuses({
  check_ids: ["String"], # required
})

Response structure


resp.statuses #=> Array
resp.statuses[0].check_id #=> String
resp.statuses[0].status #=> String
resp.statuses[0].millis_until_next_refreshable #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :check_ids (required, Array<String>) —

    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.

Returns:

See Also:



1264
1265
1266
1267
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1264

def describe_trusted_advisor_check_refresh_statuses(params = {}, options = {})
  req = build_request(:describe_trusted_advisor_check_refresh_statuses, params)
  req.send_request(options)
end

#describe_trusted_advisor_check_result(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckResultResponse

Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

  • TrustedAdvisorCategorySpecificSummary

  • TrustedAdvisorResourceDetail

  • TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

  • status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.

  • timestamp - The time of the last refresh of the check.

  • checkId - The unique identifier for the check.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_trusted_advisor_check_result({
  check_id: "String", # required
  language: "String",
})

Response structure


resp.result.check_id #=> String
resp.result.timestamp #=> String
resp.result.status #=> String
resp.result.resources_summary.resources_processed #=> Integer
resp.result.resources_summary.resources_flagged #=> Integer
resp.result.resources_summary.resources_ignored #=> Integer
resp.result.resources_summary.resources_suppressed #=> Integer
resp.result.category_specific_summary.cost_optimizing.estimated_monthly_savings #=> Float
resp.result.category_specific_summary.cost_optimizing.estimated_percent_monthly_savings #=> Float
resp.result.flagged_resources #=> Array
resp.result.flagged_resources[0].status #=> String
resp.result.flagged_resources[0].region #=> String
resp.result.flagged_resources[0].resource_id #=> String
resp.result.flagged_resources[0].is_suppressed #=> Boolean
resp.result.flagged_resources[0].metadata #=> Array
resp.result.flagged_resources[0].metadata[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :check_id (required, String) —

    The unique identifier for the Trusted Advisor check.

  • :language (String) —

    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

Returns:

See Also:



1380
1381
1382
1383
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1380

def describe_trusted_advisor_check_result(params = {}, options = {})
  req = build_request(:describe_trusted_advisor_check_result, params)
  req.send_request(options)
end

#describe_trusted_advisor_check_summaries(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckSummariesResponse

Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains an array of TrustedAdvisorCheckSummary objects.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_trusted_advisor_check_summaries({
  check_ids: ["String"], # required
})

Response structure


resp.summaries #=> Array
resp.summaries[0].check_id #=> String
resp.summaries[0].timestamp #=> String
resp.summaries[0].status #=> String
resp.summaries[0].has_flagged_resources #=> Boolean
resp.summaries[0].resources_summary.resources_processed #=> Integer
resp.summaries[0].resources_summary.resources_flagged #=> Integer
resp.summaries[0].resources_summary.resources_ignored #=> Integer
resp.summaries[0].resources_summary.resources_suppressed #=> Integer
resp.summaries[0].category_specific_summary.cost_optimizing.estimated_monthly_savings #=> Float
resp.summaries[0].category_specific_summary.cost_optimizing.estimated_percent_monthly_savings #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :check_ids (required, Array<String>) —

    The IDs of the Trusted Advisor checks.

Returns:

See Also:



1445
1446
1447
1448
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1445

def describe_trusted_advisor_check_summaries(params = {}, options = {})
  req = build_request(:describe_trusted_advisor_check_summaries, params)
  req.send_request(options)
end

#describe_trusted_advisor_checks(params = {}) ⇒ Types::DescribeTrustedAdvisorChecksResponse

Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

  • The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_trusted_advisor_checks({
  language: "String", # required
})

Response structure


resp.checks #=> Array
resp.checks[0].id #=> String
resp.checks[0].name #=> String
resp.checks[0].description #=> String
resp.checks[0].category #=> String
resp.checks[0].metadata #=> Array
resp.checks[0].metadata[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :language (required, String) —

    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

Returns:

See Also:



1537
1538
1539
1540
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1537

def describe_trusted_advisor_checks(params = {}, options = {})
  req = build_request(:describe_trusted_advisor_checks, params)
  req.send_request(options)
end

#refresh_trusted_advisor_check(params = {}) ⇒ Types::RefreshTrustedAdvisorCheckResponse

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Examples:

Request syntax with placeholder values


resp = client.refresh_trusted_advisor_check({
  check_id: "String", # required
})

Response structure


resp.status.check_id #=> String
resp.status.status #=> String
resp.status.millis_until_next_refreshable #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :check_id (required, String) —

    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.

Returns:

See Also:



1603
1604
1605
1606
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1603

def refresh_trusted_advisor_check(params = {}, options = {})
  req = build_request(:refresh_trusted_advisor_check, params)
  req.send_request(options)
end

#resolve_case(params = {}) ⇒ Types::ResolveCaseResponse

Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.

* You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Examples:

Request syntax with placeholder values


resp = client.resolve_case({
  case_id: "CaseId",
})

Response structure


resp.initial_case_status #=> String
resp.final_case_status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :case_id (String) —

    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

Returns:

See Also:



1651
1652
1653
1654
 
# File 'gems/aws-sdk-support/lib/aws-sdk-support/client.rb', line 1651

def resolve_case(params = {}, options = {})
  req = build_request(:resolve_case, params)
  req.send_request(options)
end