Class: Aws::Support::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::Support::Client

show all

Includes:: ClientStubs

Defined in:: lib/aws-sdk-support/client.rb,
sig/client.rbs

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.

Defined Under Namespace

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#add_attachments_to_set(params = {}) ⇒ Types::AddAttachmentsToSetResponse
Adds one or more attachments to an attachment set.
#add_communication_to_case(params = {}) ⇒ Types::AddCommunicationToCaseResponse
Adds additional customer communication to a Amazon Web Services Support case.
#complete_attachment_upload(params = {}) ⇒ Types::CompleteAttachmentUploadResponse
Completes an attachment upload that was started with GetAttachmentUploadLinks.
#create_case(params = {}) ⇒ Types::CreateCaseResponse
Creates a case in the Amazon Web Services Support Center.
#describe_attachment(params = {}) ⇒ Types::DescribeAttachmentResponse
Returns the attachment that has the specified ID.
#describe_attachment_upload_status(params = {}) ⇒ Types::DescribeAttachmentUploadStatusResponse
Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks.
#describe_cases(params = {}) ⇒ Types::DescribeCasesResponse
Returns a list of cases that you specify by passing one or more case IDs.
#describe_communications(params = {}) ⇒ Types::DescribeCommunicationsResponse
Returns communications and attachments for one or more support cases.
#describe_create_case_options(params = {}) ⇒ Types::DescribeCreateCaseOptionsResponse
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
#describe_services(params = {}) ⇒ Types::DescribeServicesResponse
Returns the current list of Amazon Web Services services and a list of service categories for each service.
#describe_severity_levels(params = {}) ⇒ Types::DescribeSeverityLevelsResponse
Returns the list of severity levels that you can assign to a support case.
#describe_supported_languages(params = {}) ⇒ Types::DescribeSupportedLanguagesResponse
Returns a list of supported languages for a specified categoryCode, issueType and serviceCode.
#describe_trusted_advisor_check_refresh_statuses(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
#describe_trusted_advisor_check_result(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckResultResponse
Returns the results of the Trusted Advisor check that has the specified check ID.
#describe_trusted_advisor_check_summaries(params = {}) ⇒ Types::DescribeTrustedAdvisorCheckSummariesResponse
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
#describe_trusted_advisor_checks(params = {}) ⇒ Types::DescribeTrustedAdvisorChecksResponse
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata.
#get_attachment_download_link(params = {}) ⇒ Types::GetAttachmentDownloadLinkResponse
Returns a presigned download URL for an attachment that is associated with a case communication.
#get_attachment_upload_links(params = {}) ⇒ Types::GetAttachmentUploadLinksResponse
Returns one or more presigned upload URLs for uploading a large file attachment to a support case by using a multipart upload workflow.
#refresh_trusted_advisor_check(params = {}) ⇒ Types::RefreshTrustedAdvisorCheckResponse
Refreshes the Trusted Advisor check that you specify using the check ID.
#resolve_case(params = {}) ⇒ Types::ResolveCaseResponse
Resolves a support case.

Class Method Summary collapse

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ Client constructor
A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:plugins (Array<Seahorse::Client::Plugin>) — default: []] —
A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
:credentials (required, Aws::CredentialProvider) —
Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
- ~/.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::InstanceProfileCredentials 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)
:account_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.
:auth_scheme_preference (Array<String>) —
A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.
: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 —
When true, the SDK will not prepend the modeled host prefix to the endpoint.
:disable_request_compression (Boolean) — default: false —
When set to 'true' the request body will not be compressed for supported operations.
:endpoint (String, URI::HTTPS, URI::HTTP) —
Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:
```
'http://example.com'
'https://example.com'
'http://example.com:123'
```
: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_checksum_calculation (String) — default: "when_supported" —
Determines when a checksum will be calculated for request payloads. Values are:
- when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
- when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
: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.
:response_checksum_validation (String) — default: "when_supported" —
Determines when checksum validation will be performed on response payloads. Values are:
- when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
- when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
: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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.
:sdk_ua_app_id (String) —
A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
:secret_access_key (String)
:session_token (String)
:sigv4a_signing_region_set (Array) —
A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:
- Aws.config[:sigv4a_signing_region_set]
- ENV['AWS_SIGV4A_SIGNING_REGION_SET']
- ~/.aws/config
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.
: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.
:telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:
- OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
:token_provider (Aws::TokenProvider) —
Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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_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.
: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_open_timeout (Float) — default: 15 —
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_proxy (URI::HTTP, String) —
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
: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_wire_trace (Boolean) — default: false —
When true, HTTP debug output will be sent to the :logger.
:on_chunk_received (Proc) —
When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).
:on_chunk_sent (Proc) —
When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised.
: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.
:ssl_ca_store (String) —
Sets the X509::Store to verify peer certificate.
:ssl_cert (OpenSSL::X509::Certificate) —
Sets a client certificate when creating http connections.
:ssl_key (OpenSSL::PKey) —
Sets a client key when creating http connections.
:ssl_timeout (Float) —
Sets the SSL timeout in seconds
:ssl_verify_peer (Boolean) — default: true —
When true, SSL peer certificates are verified when establishing a connection.



478
479
480

# File 'lib/aws-sdk-support/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



2399
2400
2401

# File 'lib/aws-sdk-support/client.rb', line 2399

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



2402
2403
2404

# File 'lib/aws-sdk-support/client.rb', line 2402

def errors_module
  Errors
end

.new ⇒ `Object`

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Support/Client.html#initialize-instance_method

14	# File 'sig/client.rbs', line 14 def self.new: (

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 an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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",
    },
  ],
  dry_run: false,
})

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.
:dry_run (Boolean) —
Specifies whether to validate the request without actually adding the attachments. When set to true, the request is validated but no attachments are stored, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::AddAttachmentsToSetResponse) —
Returns a response object which responds to the following methods:
- #attachment_set_id => String
- #expiry_time => String

See Also:

AWS API Documentation

88	# File 'sig/client.rbs', line 88 def add_attachments_to_set: (

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

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

To attach files larger than 5 MB to the communication, use the uploadIds parameter.

Amazon Web Services Support automatically redacts sensitive information from support cases to protect your data. The following information is replaced with [REDACTED_BY_Amazon Web Services] and is not stored:

Amazon Web Services secret keys - The complete key is replaced. Example: [REDACTED_BY_Amazon Web Services]
Private keys - The complete key is replaced. Example: [REDACTED_BY_Amazon Web Services]
Credit card numbers - The number is redacted, but the last 4 digits remain. Example: [REDACTED_BY_Amazon Web Services]-7016

This sensitive information is never required by Amazon Web Services Support.

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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",
  upload_ids: ["UploadId"],
  dry_run: false,
})

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-exen-2025-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. Each attachment in the set must be 5 MB or smaller. To attach files larger than 5 MB, use uploadIds.
:upload_ids (Array<String>) —
A list of upload IDs that identify attachments to add to the case. Each uploadId is returned by the GetAttachmentUploadLinks operation. The upload must reach the attachment-ready state by calling CompleteAttachmentUpload before it can be passed here. Use uploadIds to attach files of any supported size, including files larger than 5 MB.
:dry_run (Boolean) —
Specifies whether to validate the request without actually adding the communication to the case. When set to true, the request is validated but the communication isn't added, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::AddCommunicationToCaseResponse) —
Returns a response object which responds to the following methods:
- #result => Boolean

See Also:

AWS API Documentation

105	# File 'sig/client.rbs', line 105 def add_communication_to_case: (

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-support/client.rb', line 2372

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Support')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-support'
  context[:gem_version] = '1.95.0'
  Seahorse::Client::Request.new(handlers, context)
end

#complete_attachment_upload(params = {}) ⇒ `Types::CompleteAttachmentUploadResponse`

Completes an attachment upload that was started with GetAttachmentUploadLinks. After you upload a part of the file to its presigned Amazon S3 URL, call CompleteAttachmentUpload with the partIndex and eTag of that part. You can include one part per call, or multiple parts in a single call. After CompleteAttachmentUpload has been called for every part of the file, the service processes the upload asynchronously. The attachment-ready status might not be reflected immediately. Use DescribeAttachmentUploadStatus to poll for the uploadStatus to become attachment-ready before passing the uploadId to CreateCase or AddCommunicationToCase.

Examples:

Request syntax with placeholder values


resp = client.complete_attachment_upload({
  upload_id: "UploadId", # required
  completed_uploads: [ # required
    {
      part_index: 1, # required
      e_tag: "ETag", # required
    },
  ],
  dry_run: false,
})

Response structure


resp.upload_status #=> String, one of "attachment-ready", "attachment-not-ready", "failed"

Parameters:

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

Options Hash (params):

:upload_id (required, String) —
The identifier associated with the upload to complete.
:completed_uploads (required, Array<Types::CompletedUpload>) —
The list of parts being reported as completed in this call. Each entry must contain the partIndex of an uploaded part and the ETag returned by Amazon S3 when that part was uploaded.
:dry_run (Boolean) —
Specifies whether to validate the request without actually completing the upload. When set to true, the request is validated but the upload isn't finalized, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::CompleteAttachmentUploadResponse) —
Returns a response object which responds to the following methods:
- #upload_status => String

See Also:

AWS API Documentation

120	# File 'sig/client.rbs', line 120 def complete_attachment_upload: (

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

Submit a request from the Amazon Web Services Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.

Amazon Web Services secret keys - The complete key is replaced. Example: [REDACTED_BY_Amazon Web Services]
Private keys - The complete key is replaced. Example: [REDACTED_BY_Amazon Web Services]
Credit card numbers - The number is redacted, but the last 4 digits remain. Example: [REDACTED_BY_Amazon Web Services]-7016

This sensitive information is never required by Amazon Web Services Support.

A successful CreateCase request returns a 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.

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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",
  upload_ids: ["UploadId"],
  dry_run: false,
})

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") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). 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. Each attachment in the set must be 5 MB or smaller. To attach files larger than 5 MB, use uploadIds.
:upload_ids (Array<String>) —
A list of upload IDs that identify attachments to add to the case. Each uploadId is returned by the GetAttachmentUploadLinks operation. The upload must reach the attachment-ready state by calling CompleteAttachmentUpload before it can be passed here. Use uploadIds to attach files of any supported size, including files larger than 5 MB.
:dry_run (Boolean) —
Specifies whether to validate the request without actually creating the case. When set to true, the request is validated but no case is created, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::CreateCaseResponse) —
Returns a response object which responds to the following methods:
- #case_id => String

See Also:

AWS API Documentation

137	# File 'sig/client.rbs', line 137 def create_case: (

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

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

DescribeAttachment can't return attachments larger than 5 MB. If the specified attachmentId refers to an attachment larger than 5 MB, the request fails with InvalidParameterValueException.

To download an attachment of any size, including attachments larger than 5 MB, use GetAttachmentDownloadLink. GetAttachmentDownloadLink returns an Amazon S3 presigned URL that you can use to download the attachment directly.

Examples:

Request syntax with placeholder values


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

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.

If the specified attachment is larger than 5 MB, this operation returns InvalidParameterValueException. To download attachments larger than 5 MB, use GetAttachmentDownloadLink.
:dry_run (Boolean) —
Specifies whether to validate the request without actually retrieving the attachment. When set to true, the request is validated but no attachment content is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeAttachmentResponse) —
Returns a response object which responds to the following methods:
- #attachment => Types::Attachment

See Also:

AWS API Documentation

157	# File 'sig/client.rbs', line 157 def describe_attachment: (

#describe_attachment_upload_status(params = {}) ⇒ `Types::DescribeAttachmentUploadStatusResponse`

Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks. Use this operation to track where an upload is in the workflow. While parts are still being uploaded and reported through CompleteAttachmentUpload, the uploadStatus is attachment-not-ready and uploadProgress reports the total number of parts and how many have been completed so far. After every part has been reported and the service finishes processing the upload asynchronously, the uploadStatus becomes attachment-ready and the uploadId can be attached to a case through CreateCase or AddCommunicationToCase.

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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_upload_status({
  upload_id: "UploadId", # required
  dry_run: false,
})

Response structure


resp.upload_status #=> String, one of "attachment-ready", "attachment-not-ready", "failed"
resp.file_name #=> String
resp.upload_progress.total_parts #=> Integer
resp.upload_progress.completed_parts_count #=> Integer

Parameters:

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

Options Hash (params):

:upload_id (required, String) —
The unique identifier for the upload. The uploadId is returned by GetAttachmentUploadLinks when you initiate the upload.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning upload status. When set to true, the request is validated but no status is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeAttachmentUploadStatusResponse) —
Returns a response object which responds to the following methods:
- #upload_status => String
- #file_name => String
- #upload_progress => Types::UploadProgress

See Also:

AWS API Documentation

170	# File 'sig/client.rbs', line 170 def describe_attachment_upload_status: (

#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 24 months after creation. If a case was created more than 24 months ago, a request might return an error.

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

Each Communication returned by this operation includes attachment information in two fields:

attachmentSet: returns only attachments that are 5 MB or smaller. Attachments larger than 5 MB are not included in this field.
attachments: returns all attachments regardless of size.

Amazon Web Services recommends that you use the attachments field and download each attachment with GetAttachmentDownloadLink, which supports attachments of any size. The attachmentSet field and DescribeAttachment return only attachments that are 5 MB or smaller.

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,
  dry_run: 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].attachments #=> Array
resp.cases[0].recent_communications.communications[0].attachments[0].attachment_id #=> String
resp.cases[0].recent_communications.communications[0].attachments[0].file_name #=> 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 24 months after creation.
:before_time (String) —
The end date for a filtered date search on support case communications. Case communications are available for 24 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") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). 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.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning case data. When set to true, the request is validated but no cases are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeCasesResponse) —
Returns a response object which responds to the following methods:
- #cases => Array<Types::CaseDetails>
- #next_token => String

See Also:

AWS API Documentation

182	# File 'sig/client.rbs', line 182 def describe_cases: (

#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 24 months after creation. If a case was created more than 24 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.

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

Each Communication returned by this operation includes attachment information in two fields:

attachmentSet: returns only attachments that are 5 MB or smaller. Attachments larger than 5 MB are not included in this field.
attachments: returns all attachments regardless of size.

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,
  dry_run: false,
})

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].attachments #=> Array
resp.communications[0].attachments[0].attachment_id #=> String
resp.communications[0].attachments[0].file_name #=> 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-exen-2025-c4c1d2bf33c5cf47
:before_time (String) —
The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
:after_time (String) —
The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.
:next_token (String) —
A resumption point for pagination.
:max_results (Integer) —
The maximum number of results to return before paginating.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning communications. When set to true, the request is validated but no communications are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeCommunicationsResponse) —
Returns a response object which responds to the following methods:
- #communications => Array<Types::Communication>
- #next_token => String

See Also:

AWS API Documentation

202	# File 'sig/client.rbs', line 202 def describe_communications: (

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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
  dry_run: false,
})

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") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). 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.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning case option data. When set to true, the request is validated but no options are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeCreateCaseOptionsResponse) —
Returns a response object which responds to the following methods:
- #language_availability => String
- #communication_types => Array<Types::CommunicationTypeOptions>

See Also:

AWS API Documentation

218	# File 'sig/client.rbs', line 218 def describe_create_case_options: (

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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",
  dry_run: false,
})

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") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning the list of services. When set to true, the request is validated but no services are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeServicesResponse) —
Returns a response object which responds to the following methods:
- #services => Array<Types::Service>

See Also:

AWS API Documentation

232	# File 'sig/client.rbs', line 232 def describe_services: (

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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",
  dry_run: false,
})

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") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning severity levels. When set to true, the request is validated but no severity levels are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeSeverityLevelsResponse) —
Returns a response object which responds to the following methods:
- #severity_levels => Array<Types::SeverityLevel>

See Also:

AWS API Documentation

244	# File 'sig/client.rbs', line 244 def describe_severity_levels: (

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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
  dry_run: false,
})

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.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning supported languages. When set to true, the request is validated but no languages are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::DescribeSupportedLanguagesResponse) —
Returns a response object which responds to the following methods:
- #supported_languages => Array<Types::SupportedLanguage>

See Also:

AWS API Documentation

255	# File 'sig/client.rbs', line 255 def describe_supported_languages: (

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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:

(Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse) —
Returns a response object which responds to the following methods:
- #statuses => Array<Types::TrustedAdvisorCheckRefreshStatus>

See Also:

AWS API Documentation

268	# File 'sig/client.rbs', line 268 def describe_trusted_advisor_check_refresh_statuses: (

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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_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:

(Types::DescribeTrustedAdvisorCheckResultResponse) —
Returns a response object which responds to the following methods:
- #result => Types::TrustedAdvisorCheckResult

See Also:

AWS API Documentation

278	# File 'sig/client.rbs', line 278 def describe_trusted_advisor_check_result: (

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

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

Understanding the Trusted Advisor Resources processed value

The Resources processed value, resourcesProcessed, usually shows both flagged resources (those with warnings or errors) and resources in good standing (ok status resources). However, some checks report flagged resources only. To understand what a specific check reports, review the detailed check information in the Trusted Advisor check reference. If you see a Green criterion listed in the Alert criteria, then the check reports all resources. If there's no Green criterion listed in the Alert criteria, then the check reports only flagged resources. For example, the Amazon EC2 Reserved Instance optimization check (cX3c2R1chu) doesn't list a Green criterion in the Alert criteria. So, this check only reports flagged resources.

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:

(Types::DescribeTrustedAdvisorCheckSummariesResponse) —
Returns a response object which responds to the following methods:
- #summaries => Array<Types::TrustedAdvisorCheckSummary>

See Also:

AWS API Documentation

289	# File 'sig/client.rbs', line 289 def describe_trusted_advisor_check_summaries: (

#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 Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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 Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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.

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:

(Types::DescribeTrustedAdvisorChecksResponse) —
Returns a response object which responds to the following methods:
- #checks => Array<Types::TrustedAdvisorCheckDescription>

See Also:

AWS API Documentation

299	# File 'sig/client.rbs', line 299 def describe_trusted_advisor_checks: (

#get_attachment_download_link(params = {}) ⇒ `Types::GetAttachmentDownloadLinkResponse`

Returns a presigned download URL for an attachment that is associated with a case communication. The download link works for an attachment of any size, including attachments added through AddAttachmentsToSet and attachments uploaded through GetAttachmentUploadLinks. The download URL is time-limited and expires at the date and time indicated in the downloadUrl response field. Download the attachment from the URL before it expires.

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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.get_attachment_download_link({
  attachment_id: "AttachmentId", # required
  dry_run: false,
})

Response structure


resp.file_name #=> String
resp.download_url.url #=> String
resp.download_url.expiry_date #=> String

Parameters:

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

Options Hash (params):

:attachment_id (required, String) —
The unique identifier of the attachment for which to retrieve a download link. Attachment IDs are returned in the AttachmentDetails objects in the attachments field of a Communication returned by DescribeCommunications or DescribeCases.
:dry_run (Boolean) —
Specifies whether to validate the request without actually returning a download link. When set to true, the request is validated but no URL is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::GetAttachmentDownloadLinkResponse) —
Returns a response object which responds to the following methods:
- #file_name => String
- #download_url => Types::DownloadUrl

See Also:

AWS API Documentation

310	# File 'sig/client.rbs', line 310 def get_attachment_download_link: (

#get_attachment_upload_links(params = {}) ⇒ `Types::GetAttachmentUploadLinksResponse`

Returns one or more presigned upload URLs for uploading a large file attachment to a support case by using a multipart upload workflow. The maximum file size that you can upload with this workflow is 150 MB, and parts can be up to 100 MB each. Initiate a new upload by providing fileName and fileSizeBytes; the response returns a unique uploadId, the part size, the total number of parts, and a list of presigned upload URLs for the requested range of parts. A maximum of 10 upload URLs are returned per call. To retrieve more upload URLs for an upload that's already in progress, call GetAttachmentUploadLinks again with the existing uploadId and a new uploadRange.

Upload each part to its presigned URL by using HTTP PUT and capture the ETag from the response. After you upload all parts, call CompleteAttachmentUpload with the uploadId and the list of part indexes and ETags to finalize the upload. You can then attach the upload to a case by passing the uploadId in the uploadIds parameter of CreateCase or AddCommunicationToCase. To monitor progress before completion, call DescribeAttachmentUploadStatus.

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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.get_attachment_upload_links({
  file_name: "FileName", # required
  file_size_bytes: 1,
  upload_id: "UploadId",
  upload_range: {
    start_index: 1, # required
    end_index: 1,
  },
  dry_run: false,
})

Response structure


resp.upload_id #=> String
resp.part_size_bytes #=> Integer
resp.total_parts #=> Integer
resp.next_index #=> Integer
resp.upload_urls #=> Array
resp.upload_urls[0].url #=> String
resp.upload_urls[0].part_index #=> Integer
resp.upload_urls[0].expiry_date #=> String

Parameters:

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

Options Hash (params):

:file_name (required, String) —
The name of the file to upload, including the file extension. This value is required when you initiate a new upload.
:file_size_bytes (Integer) —
The total size of the file in bytes. The service uses this value to calculate the total number of parts and the size of each part. Required when you initiate a new upload (when uploadId isn't provided). Valid range: 1 to 157,286,400 bytes (approximately 150 MB).
:upload_id (String) —
The unique identifier of an in-progress multipart upload, returned by a previous call to GetAttachmentUploadLinks. Specify uploadId to retrieve additional presigned upload URLs for an upload that has already been initiated. Required when fileSizeBytes isn't provided. Length: 1 to 2,048 characters.
:upload_range (Types::UploadRange) —
The range of part indexes for which to return presigned upload URLs. Use this parameter to page through the upload URLs for a large file across multiple calls. If you omit this parameter, the service determines the range to return.
:dry_run (Boolean) —
Specifies whether to validate the request without actually generating upload URLs. When set to true, the request is validated but no URLs are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::GetAttachmentUploadLinksResponse) —
Returns a response object which responds to the following methods:
- #upload_id => String
- #part_size_bytes => Integer
- #total_parts => Integer
- #next_index => Integer
- #upload_urls => Array<Types::UploadUrl>

See Also:

AWS API Documentation

325	# File 'sig/client.rbs', line 325 def get_attachment_upload_links: (

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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.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:

(Types::RefreshTrustedAdvisorCheckResponse) —
Returns a response object which responds to the following methods:
- #status => Types::TrustedAdvisorCheckRefreshStatus

See Also:

AWS API Documentation

342	# File 'sig/client.rbs', line 342 def refresh_trusted_advisor_check: (

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

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

If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations 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",
  dry_run: false,
})

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-exen-2025-c4c1d2bf33c5cf47
:dry_run (Boolean) —
Specifies whether to validate the request without actually resolving the case. When set to true, the request is validated but the case isn't resolved, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Returns:

(Types::ResolveCaseResponse) —
Returns a response object which responds to the following methods:
- #initial_case_status => String
- #final_case_status => String

See Also:

AWS API Documentation

353	# File 'sig/client.rbs', line 353 def resolve_case: (

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



2392
2393
2394

# File 'lib/aws-sdk-support/client.rb', line 2392

def waiter_names
  []
end

Class: Aws::Support::Client

Overview

Defined Under Namespace

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

.new ⇒ Object

Instance Method Details

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

#build_request(operation_name, params = {}) ⇒ Object

#complete_attachment_upload(params = {}) ⇒ Types::CompleteAttachmentUploadResponse

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

#describe_attachment_upload_status(params = {}) ⇒ Types::DescribeAttachmentUploadStatusResponse

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

.new ⇒ `Object`

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

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

#build_request(operation_name, params = {}) ⇒ `Object`

#complete_attachment_upload(params = {}) ⇒ `Types::CompleteAttachmentUploadResponse`

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

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

#describe_attachment_upload_status(params = {}) ⇒ `Types::DescribeAttachmentUploadStatusResponse`

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

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

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

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

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

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

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

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

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

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

#get_attachment_download_link(params = {}) ⇒ `Types::GetAttachmentDownloadLinkResponse`

#get_attachment_upload_links(params = {}) ⇒ `Types::GetAttachmentUploadLinksResponse`

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

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

#waiter_names ⇒ `Object`