# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::Support module Types # @note When making an API call, you may pass AddAttachmentsToSetRequest # data as a hash: # # { # attachment_set_id: "AttachmentSetId", # attachments: [ # required # { # file_name: "FileName", # data: "data", # }, # ], # } # # @!attribute [rw] attachment_set_id # 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. # @return [String] # # @!attribute [rw] attachments # 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`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSetRequest AWS API Documentation # class AddAttachmentsToSetRequest < Struct.new( :attachment_set_id, :attachments) SENSITIVE = [] include Aws::Structure end # The ID and expiry time of the attachment set returned by the # AddAttachmentsToSet operation. # # @!attribute [rw] attachment_set_id # The ID of the attachment set. If an `attachmentSetId` was not # specified, a new attachment set is created, and the ID of the set is # returned in the response. If an `attachmentSetId` was specified, the # attachments are added to the specified set, if it exists. # @return [String] # # @!attribute [rw] expiry_time # The time and date when the attachment set expires. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSetResponse AWS API Documentation # class AddAttachmentsToSetResponse < Struct.new( :attachment_set_id, :expiry_time) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AddCommunicationToCaseRequest # data as a hash: # # { # case_id: "CaseId", # communication_body: "CommunicationBody", # required # cc_email_addresses: ["CcEmailAddress"], # attachment_set_id: "AttachmentSetId", # } # # @!attribute [rw] case_id # 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* # @return [String] # # @!attribute [rw] communication_body # The body of an email communication to add to the support case. # @return [String] # # @!attribute [rw] cc_email_addresses # The email addresses in the CC line of an email to be added to the # support case. # @return [Array] # # @!attribute [rw] attachment_set_id # The ID of a set of one or more attachments for the communication to # add to the case. Create the set by calling AddAttachmentsToSet # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddCommunicationToCaseRequest AWS API Documentation # class AddCommunicationToCaseRequest < Struct.new( :case_id, :communication_body, :cc_email_addresses, :attachment_set_id) SENSITIVE = [] include Aws::Structure end # The result of the AddCommunicationToCase operation. # # @!attribute [rw] result # True if AddCommunicationToCase succeeds. Otherwise, returns an # error. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddCommunicationToCaseResponse AWS API Documentation # class AddCommunicationToCaseResponse < Struct.new( :result) SENSITIVE = [] include Aws::Structure end # An attachment to a case communication. The attachment consists of the # file name and the content of the file. # # @note When making an API call, you may pass Attachment # data as a hash: # # { # file_name: "FileName", # data: "data", # } # # @!attribute [rw] file_name # The name of the attachment file. # @return [String] # # @!attribute [rw] data # The content of the attachment file. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Attachment AWS API Documentation # class Attachment < Struct.new( :file_name, :data) SENSITIVE = [] include Aws::Structure end # The file name and ID of an attachment to a case communication. You can # use the ID to retrieve the attachment with the DescribeAttachment # operation. # # @!attribute [rw] attachment_id # The ID of the attachment. # @return [String] # # @!attribute [rw] file_name # The file name of the attachment. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentDetails AWS API Documentation # class AttachmentDetails < Struct.new( :attachment_id, :file_name) SENSITIVE = [] include Aws::Structure end # An attachment with the specified ID could not be found. # # @!attribute [rw] message # An attachment with the specified ID could not be found. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentIdNotFound AWS API Documentation # class AttachmentIdNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The limit for the number of attachment sets created in a short period # of time has been exceeded. # # @!attribute [rw] message # The limit for the number of attachment sets created in a short # period of time has been exceeded. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentLimitExceeded AWS API Documentation # class AttachmentLimitExceeded < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The expiration time of the attachment set has passed. The set expires # 1 hour after it is created. # # @!attribute [rw] message # The expiration time of the attachment set has passed. The set # expires one hour after it is created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentSetExpired AWS API Documentation # class AttachmentSetExpired < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # An attachment set with the specified ID could not be found. # # @!attribute [rw] message # An attachment set with the specified ID could not be found. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentSetIdNotFound AWS API Documentation # class AttachmentSetIdNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A limit for the size of an attachment set has been exceeded. The # limits are three attachments and 5 MB per attachment. # # @!attribute [rw] message # A limit for the size of an attachment set has been exceeded. The # limits are three attachments and 5 MB per attachment. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AttachmentSetSizeLimitExceeded AWS API Documentation # class AttachmentSetSizeLimitExceeded < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The case creation limit for the account has been exceeded. # # @!attribute [rw] message # An error message that indicates that you have exceeded the number of # cases you can have open. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CaseCreationLimitExceeded AWS API Documentation # class CaseCreationLimitExceeded < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A JSON-formatted object that contains the metadata for a support case. # It is contained in the response from a DescribeCases request. # **CaseDetails** contains the following fields: # # * **caseId** - 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*. # # * **categoryCode** - The category of problem for the support case. # Corresponds to the `CategoryCode` values returned by a call to # DescribeServices. # # * **displayId** - The identifier for the case on pages in the Amazon # Web Services Support Center. # # * **language** - The ISO 639-1 code for the language in which Amazon # Web Services provides support. Amazon Web Services Support currently # supports English ("en") and Japanese ("ja"). Language parameters # must be passed explicitly for operations that take them. # # * **nextToken** - A resumption point for pagination. # # * **recentCommunications** - One or more Communication objects. Fields # of these objects are `attachments`, `body`, `caseId`, `submittedBy`, # and `timeCreated`. # # * **serviceCode** - The identifier for the Amazon Web Services service # that corresponds to the service code defined in the call to # DescribeServices. # # * **severityCode** - The severity code assigned to the case. Contains # one of the values returned by the call to DescribeSeverityLevels. # The possible values are: `low`, `normal`, `high`, `urgent`, and # `critical`. # # * **status** - The status of the case in the Amazon Web Services # Support Center. Valid values: # # * `opened` # # * `pending-customer-action` # # * `reopened` # # * `resolved` # # * `unassigned` # # * `work-in-progress` # # * **subject** - The subject line of the case. # # * **submittedBy** - The email address of the account that submitted # the case. # # * **timeCreated** - The time the case was created, in ISO-8601 format. # # @!attribute [rw] case_id # 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* # @return [String] # # @!attribute [rw] display_id # The ID displayed for the case in the Amazon Web Services Support # Center. This is a numeric string. # @return [String] # # @!attribute [rw] subject # The subject line for the case in the Amazon Web Services Support # Center. # @return [String] # # @!attribute [rw] status # The status of the case. # # Valid values: # # * `opened` # # * `pending-customer-action` # # * `reopened` # # * `resolved` # # * `unassigned` # # * `work-in-progress` # @return [String] # # @!attribute [rw] service_code # The code for the Amazon Web Services service. You can get a list of # codes and the corresponding service names by calling # DescribeServices. # @return [String] # # @!attribute [rw] category_code # The category of problem for the support case. # @return [String] # # @!attribute [rw] severity_code # The code for the severity level returned by the call to # DescribeSeverityLevels. # @return [String] # # @!attribute [rw] submitted_by # The email address of the account that submitted the case. # @return [String] # # @!attribute [rw] time_created # The time that the case was created in the Amazon Web Services # Support Center. # @return [String] # # @!attribute [rw] recent_communications # The five most recent communications between you and Amazon Web # Services Support Center, including the IDs of any attachments to the # communications. Also includes a `nextToken` that you can use to # retrieve earlier communications. # @return [Types::RecentCaseCommunications] # # @!attribute [rw] cc_email_addresses # The email addresses that receive copies of communication about the # case. # @return [Array] # # @!attribute [rw] language # The ISO 639-1 code for the language in which Amazon Web Services # provides support. Amazon Web Services Support currently supports # English ("en") and Japanese ("ja"). Language parameters must be # passed explicitly for operations that take them. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CaseDetails AWS API Documentation # class CaseDetails < Struct.new( :case_id, :display_id, :subject, :status, :service_code, :category_code, :severity_code, :submitted_by, :time_created, :recent_communications, :cc_email_addresses, :language) SENSITIVE = [] include Aws::Structure end # The requested `caseId` couldn't be located. # # @!attribute [rw] message # The requested `CaseId` could not be located. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CaseIdNotFound AWS API Documentation # class CaseIdNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A JSON-formatted name/value pair that represents the category name and # category code of the problem, selected from the DescribeServices # response for each Amazon Web Services service. # # @!attribute [rw] code # The category code for the support case. # @return [String] # # @!attribute [rw] name # The category name for the support case. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Category AWS API Documentation # class Category < Struct.new( :code, :name) SENSITIVE = [] include Aws::Structure end # A communication associated with a support case. The communication # consists of the case ID, the message body, attachment information, the # submitter of the communication, and the date and time of the # communication. # # @!attribute [rw] case_id # 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* # @return [String] # # @!attribute [rw] body # The text of the communication between the customer and Amazon Web # Services Support. # @return [String] # # @!attribute [rw] submitted_by # The identity of the account that submitted, or responded to, the # support case. Customer entries include the role or IAM user as well # as the email address. For example, "AdminRole (Role) # <janedoe@example.com>. Entries from the Amazon Web Services # Support team display "Amazon Web Services," and don't show an # email address. # @return [String] # # @!attribute [rw] time_created # The time the communication was created. # @return [String] # # @!attribute [rw] attachment_set # Information about the attachments to the case communication. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Communication AWS API Documentation # class Communication < Struct.new( :case_id, :body, :submitted_by, :time_created, :attachment_set) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateCaseRequest # data as a hash: # # { # 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", # } # # @!attribute [rw] subject # The title of the support case. The title appears in the **Subject** # field on the Amazon Web Services Support Center [Create Case][1] # page. # # # # [1]: https://console.aws.amazon.com/support/home#/case/create # @return [String] # # @!attribute [rw] service_code # The code for the Amazon Web Services service. You can use the # DescribeServices operation to get the possible `serviceCode` values. # @return [String] # # @!attribute [rw] severity_code # 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][1] # in the *Amazon Web Services Support User Guide*. # # The availability of severity levels depends on the support plan for # the Amazon Web Services account. # # # # # # [1]: https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity # @return [String] # # @!attribute [rw] category_code # 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. # @return [String] # # @!attribute [rw] communication_body # The communication body text that describes the issue. This text # appears in the **Description** field on the Amazon Web Services # Support Center [Create Case][1] page. # # # # [1]: https://console.aws.amazon.com/support/home#/case/create # @return [String] # # @!attribute [rw] cc_email_addresses # 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][1]. # # # # [1]: http://aws.amazon.com/tools/ # @return [Array] # # @!attribute [rw] language # The language in which Amazon Web Services Support handles the case. # You must specify the ISO 639-1 code for the `language` parameter if # you want support in that language. Currently, English ("en") and # Japanese ("ja") are supported. # @return [String] # # @!attribute [rw] issue_type # 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`. # @return [String] # # @!attribute [rw] attachment_set_id # The ID of a set of one or more attachments for the case. Create the # set by using the AddAttachmentsToSet operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCaseRequest AWS API Documentation # class CreateCaseRequest < Struct.new( :subject, :service_code, :severity_code, :category_code, :communication_body, :cc_email_addresses, :language, :issue_type, :attachment_set_id) SENSITIVE = [] include Aws::Structure end # The support case ID returned by a successful completion of the # CreateCase operation. # # @!attribute [rw] case_id # The support case ID requested or returned in the call. The case ID # is an alphanumeric string in the following format: # case-*12345678910-2013-c4c1d2bf33c5cf47* # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCaseResponse AWS API Documentation # class CreateCaseResponse < Struct.new( :case_id) SENSITIVE = [] include Aws::Structure end # The limit for the number of DescribeAttachment requests in a short # period of time has been exceeded. # # @!attribute [rw] message # The limit for the number of DescribeAttachment requests in a short # period of time has been exceeded. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachmentLimitExceeded AWS API Documentation # class DescribeAttachmentLimitExceeded < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeAttachmentRequest # data as a hash: # # { # attachment_id: "AttachmentId", # required # } # # @!attribute [rw] attachment_id # The ID of the attachment to return. Attachment IDs are returned by # the DescribeCommunications operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachmentRequest AWS API Documentation # class DescribeAttachmentRequest < Struct.new( :attachment_id) SENSITIVE = [] include Aws::Structure end # The content and file name of the attachment returned by the # DescribeAttachment operation. # # @!attribute [rw] attachment # This object includes the attachment content and file name. # # In the previous response syntax, the value for the `data` parameter # appears as `blob`, which is represented as a base64-encoded string. # The value for `fileName` is the name of the attachment, such as # `troubleshoot-screenshot.png`. # @return [Types::Attachment] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachmentResponse AWS API Documentation # class DescribeAttachmentResponse < Struct.new( :attachment) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeCasesRequest # data as a hash: # # { # 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, # } # # @!attribute [rw] case_id_list # A list of ID numbers of the support cases you want returned. The # maximum number of cases is 100. # @return [Array] # # @!attribute [rw] display_id # The ID displayed for a case in the Amazon Web Services Support # Center user interface. # @return [String] # # @!attribute [rw] after_time # The start date for a filtered date search on support case # communications. Case communications are available for 12 months # after creation. # @return [String] # # @!attribute [rw] before_time # The end date for a filtered date search on support case # communications. Case communications are available for 12 months # after creation. # @return [String] # # @!attribute [rw] include_resolved_cases # Specifies whether to include resolved support cases in the # `DescribeCases` response. By default, resolved cases aren't # included. # @return [Boolean] # # @!attribute [rw] next_token # A resumption point for pagination. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return before paginating. # @return [Integer] # # @!attribute [rw] language # The ISO 639-1 code for the language in which Amazon Web Services # provides support. Amazon Web Services Support currently supports # English ("en") and Japanese ("ja"). Language parameters must be # passed explicitly for operations that take them. # @return [String] # # @!attribute [rw] include_communications # Specifies whether to include communications in the `DescribeCases` # response. By default, communications are included. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCasesRequest AWS API Documentation # class DescribeCasesRequest < Struct.new( :case_id_list, :display_id, :after_time, :before_time, :include_resolved_cases, :next_token, :max_results, :language, :include_communications) SENSITIVE = [] include Aws::Structure end # Returns an array of [CaseDetails][1] objects and a `nextToken` that # defines a point for pagination in the result set. # # # # [1]: https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html # # @!attribute [rw] cases # The details for the cases that match the request. # @return [Array] # # @!attribute [rw] next_token # A resumption point for pagination. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCasesResponse AWS API Documentation # class DescribeCasesResponse < Struct.new( :cases, :next_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeCommunicationsRequest # data as a hash: # # { # case_id: "CaseId", # required # before_time: "BeforeTime", # after_time: "AfterTime", # next_token: "NextToken", # max_results: 1, # } # # @!attribute [rw] case_id # 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* # @return [String] # # @!attribute [rw] before_time # The end date for a filtered date search on support case # communications. Case communications are available for 12 months # after creation. # @return [String] # # @!attribute [rw] after_time # The start date for a filtered date search on support case # communications. Case communications are available for 12 months # after creation. # @return [String] # # @!attribute [rw] next_token # A resumption point for pagination. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return before paginating. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunicationsRequest AWS API Documentation # class DescribeCommunicationsRequest < Struct.new( :case_id, :before_time, :after_time, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end # The communications returned by the DescribeCommunications operation. # # @!attribute [rw] communications # The communications for the case. # @return [Array] # # @!attribute [rw] next_token # A resumption point for pagination. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunicationsResponse AWS API Documentation # class DescribeCommunicationsResponse < Struct.new( :communications, :next_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeServicesRequest # data as a hash: # # { # service_code_list: ["ServiceCode"], # language: "Language", # } # # @!attribute [rw] service_code_list # A JSON-formatted list of service codes available for Amazon Web # Services services. # @return [Array] # # @!attribute [rw] language # The ISO 639-1 code for the language in which Amazon Web Services # provides support. Amazon Web Services Support currently supports # English ("en") and Japanese ("ja"). Language parameters must be # passed explicitly for operations that take them. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeServicesRequest AWS API Documentation # class DescribeServicesRequest < Struct.new( :service_code_list, :language) SENSITIVE = [] include Aws::Structure end # The list of Amazon Web Services services returned by the # DescribeServices operation. # # @!attribute [rw] services # A JSON-formatted list of Amazon Web Services services. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeServicesResponse AWS API Documentation # class DescribeServicesResponse < Struct.new( :services) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeSeverityLevelsRequest # data as a hash: # # { # language: "Language", # } # # @!attribute [rw] language # The ISO 639-1 code for the language in which Amazon Web Services # provides support. Amazon Web Services Support currently supports # English ("en") and Japanese ("ja"). Language parameters must be # passed explicitly for operations that take them. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeSeverityLevelsRequest AWS API Documentation # class DescribeSeverityLevelsRequest < Struct.new( :language) SENSITIVE = [] include Aws::Structure end # The list of severity levels returned by the DescribeSeverityLevels # operation. # # @!attribute [rw] severity_levels # The available severity levels for the support case. Available # severity levels are defined by your service level agreement with # Amazon Web Services. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeSeverityLevelsResponse AWS API Documentation # class DescribeSeverityLevelsResponse < Struct.new( :severity_levels) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeTrustedAdvisorCheckRefreshStatusesRequest # data as a hash: # # { # check_ids: ["String"], # required # } # # @!attribute [rw] check_ids # 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. # # # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatusesRequest AWS API Documentation # class DescribeTrustedAdvisorCheckRefreshStatusesRequest < Struct.new( :check_ids) SENSITIVE = [] include Aws::Structure end # The statuses of the Trusted Advisor checks returned by the # DescribeTrustedAdvisorCheckRefreshStatuses operation. # # @!attribute [rw] statuses # The refresh status of the specified Trusted Advisor checks. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatusesResponse AWS API Documentation # class DescribeTrustedAdvisorCheckRefreshStatusesResponse < Struct.new( :statuses) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeTrustedAdvisorCheckResultRequest # data as a hash: # # { # check_id: "String", # required # language: "String", # } # # @!attribute [rw] check_id # The unique identifier for the Trusted Advisor check. # @return [String] # # @!attribute [rw] language # The ISO 639-1 code for the language in which Amazon Web Services # provides support. Amazon Web Services Support currently supports # English ("en") and Japanese ("ja"). Language parameters must be # passed explicitly for operations that take them. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckResultRequest AWS API Documentation # class DescribeTrustedAdvisorCheckResultRequest < Struct.new( :check_id, :language) SENSITIVE = [] include Aws::Structure end # The result of the Trusted Advisor check returned by the # DescribeTrustedAdvisorCheckResult operation. # # @!attribute [rw] result # The detailed results of the Trusted Advisor check. # @return [Types::TrustedAdvisorCheckResult] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckResultResponse AWS API Documentation # class DescribeTrustedAdvisorCheckResultResponse < Struct.new( :result) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeTrustedAdvisorCheckSummariesRequest # data as a hash: # # { # check_ids: ["String"], # required # } # # @!attribute [rw] check_ids # The IDs of the Trusted Advisor checks. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckSummariesRequest AWS API Documentation # class DescribeTrustedAdvisorCheckSummariesRequest < Struct.new( :check_ids) SENSITIVE = [] include Aws::Structure end # The summaries of the Trusted Advisor checks returned by the # DescribeTrustedAdvisorCheckSummaries operation. # # @!attribute [rw] summaries # The summary information for the requested Trusted Advisor checks. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckSummariesResponse AWS API Documentation # class DescribeTrustedAdvisorCheckSummariesResponse < Struct.new( :summaries) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeTrustedAdvisorChecksRequest # data as a hash: # # { # language: "String", # required # } # # @!attribute [rw] language # The ISO 639-1 code for the language in which Amazon Web Services # provides support. Amazon Web Services Support currently supports # English ("en") and Japanese ("ja"). Language parameters must be # passed explicitly for operations that take them. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorChecksRequest AWS API Documentation # class DescribeTrustedAdvisorChecksRequest < Struct.new( :language) SENSITIVE = [] include Aws::Structure end # Information about the Trusted Advisor checks returned by the # DescribeTrustedAdvisorChecks operation. # # @!attribute [rw] checks # Information about all available Trusted Advisor checks. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorChecksResponse AWS API Documentation # class DescribeTrustedAdvisorChecksResponse < Struct.new( :checks) SENSITIVE = [] include Aws::Structure end # An internal server error occurred. # # @!attribute [rw] message # An internal server error occurred. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/InternalServerError AWS API Documentation # class InternalServerError < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The five most recent communications associated with the case. # # @!attribute [rw] communications # The five most recent communications associated with the case. # @return [Array] # # @!attribute [rw] next_token # A resumption point for pagination. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RecentCaseCommunications AWS API Documentation # class RecentCaseCommunications < Struct.new( :communications, :next_token) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RefreshTrustedAdvisorCheckRequest # data as a hash: # # { # check_id: "String", # required # } # # @!attribute [rw] check_id # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheckRequest AWS API Documentation # class RefreshTrustedAdvisorCheckRequest < Struct.new( :check_id) SENSITIVE = [] include Aws::Structure end # The current refresh status of a Trusted Advisor check. # # @!attribute [rw] status # The current refresh status for a check, including the amount of time # until the check is eligible for refresh. # @return [Types::TrustedAdvisorCheckRefreshStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheckResponse AWS API Documentation # class RefreshTrustedAdvisorCheckResponse < Struct.new( :status) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ResolveCaseRequest # data as a hash: # # { # case_id: "CaseId", # } # # @!attribute [rw] case_id # 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* # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/ResolveCaseRequest AWS API Documentation # class ResolveCaseRequest < Struct.new( :case_id) SENSITIVE = [] include Aws::Structure end # The status of the case returned by the ResolveCase operation. # # @!attribute [rw] initial_case_status # The status of the case when the ResolveCase request was sent. # @return [String] # # @!attribute [rw] final_case_status # The status of the case after the ResolveCase request was processed. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/ResolveCaseResponse AWS API Documentation # class ResolveCaseResponse < Struct.new( :initial_case_status, :final_case_status) SENSITIVE = [] include Aws::Structure end # Information about an Amazon Web Services service returned by the # DescribeServices operation. # # @!attribute [rw] code # The code for an Amazon Web Services service returned by the # DescribeServices response. The `name` element contains the # corresponding friendly name. # @return [String] # # @!attribute [rw] name # The friendly name for an Amazon Web Services service. The `code` # element contains the corresponding code. # @return [String] # # @!attribute [rw] categories # A list of categories that describe the type of support issue a case # describes. Categories consist of a category name and a category # code. Category names and codes are passed to Amazon Web Services # Support when you call CreateCase. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/Service AWS API Documentation # class Service < Struct.new( :code, :name, :categories) SENSITIVE = [] include Aws::Structure end # A code and name pair that represents the severity level of a support # case. The available values depend on the support plan for the account. # For more information, see [Choosing a severity][1] in the *Amazon Web # Services Support User Guide*. # # # # [1]: https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity # # @!attribute [rw] code # The code for case severity level. # # Valid values: `low` \| `normal` \| `high` \| `urgent` \| `critical` # @return [String] # # @!attribute [rw] name # The name of the severity level that corresponds to the severity # level code. # # The values returned by the API are different from the values that # appear in the Amazon Web Services Support Center. For example, the # API uses the code `low`, but the name appears as General guidance in # Support Center. # # The following are the API code names and how they appear in the # console: # # * `low` - General guidance # # * `normal` - System impaired # # * `high` - Production system impaired # # * `urgent` - Production system down # # * `critical` - Business-critical system down # # # # For more information, see [Choosing a severity][1] in the *Amazon # Web Services Support User Guide*. # # # # [1]: https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/SeverityLevel AWS API Documentation # class SeverityLevel < Struct.new( :code, :name) SENSITIVE = [] include Aws::Structure end # The container for summary information that relates to the category of # the Trusted Advisor check. # # @!attribute [rw] cost_optimizing # The summary information about cost savings for a Trusted Advisor # check that is in the Cost Optimizing category. # @return [Types::TrustedAdvisorCostOptimizingSummary] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCategorySpecificSummary AWS API Documentation # class TrustedAdvisorCategorySpecificSummary < Struct.new( :cost_optimizing) SENSITIVE = [] include Aws::Structure end # The description and metadata for a Trusted Advisor check. # # @!attribute [rw] id # The unique identifier for the Trusted Advisor check. # @return [String] # # @!attribute [rw] name # The display name for the Trusted Advisor check. # @return [String] # # @!attribute [rw] description # The description of the Trusted Advisor check, which includes the # alert criteria and recommended operations (contains HTML markup). # @return [String] # # @!attribute [rw] category # The category of the Trusted Advisor check. # @return [String] # # @!attribute [rw] metadata # The column headings for the data returned by the Trusted Advisor # check. The order of the headings corresponds to the order of the # data in the **Metadata** element of the TrustedAdvisorResourceDetail # for the check. **Metadata** contains all the data that is shown in # the Excel download, even in those cases where the UI shows just # summary data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckDescription AWS API Documentation # class TrustedAdvisorCheckDescription < Struct.new( :id, :name, :description, :category, :metadata) SENSITIVE = [] include Aws::Structure end # The refresh status of a Trusted Advisor check. # # @!attribute [rw] check_id # The unique identifier for the Trusted Advisor check. # @return [String] # # @!attribute [rw] status # The status of the Trusted Advisor check for which a refresh has been # requested: # # * `none` - The check is not refreshed or the non-success status # exceeds the timeout # # * `enqueued` - The check refresh requests has entered the refresh # queue # # * `processing` - The check refresh request is picked up by the rule # processing engine # # * `success` - The check is successfully refreshed # # * `abandoned` - The check refresh has failed # @return [String] # # @!attribute [rw] millis_until_next_refreshable # The amount of time, in milliseconds, until the Trusted Advisor check # is eligible for refresh. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckRefreshStatus AWS API Documentation # class TrustedAdvisorCheckRefreshStatus < Struct.new( :check_id, :status, :millis_until_next_refreshable) SENSITIVE = [] include Aws::Structure end # The results of a Trusted Advisor check returned by # DescribeTrustedAdvisorCheckResult. # # @!attribute [rw] check_id # The unique identifier for the Trusted Advisor check. # @return [String] # # @!attribute [rw] timestamp # The time of the last refresh of the check. # @return [String] # # @!attribute [rw] status # The alert status of the check: "ok" (green), "warning" (yellow), # "error" (red), or "not\_available". # @return [String] # # @!attribute [rw] resources_summary # Details about Amazon Web Services resources that were analyzed in a # call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. # @return [Types::TrustedAdvisorResourcesSummary] # # @!attribute [rw] category_specific_summary # Summary information that relates to the category of the check. Cost # Optimizing is the only category that is currently supported. # @return [Types::TrustedAdvisorCategorySpecificSummary] # # @!attribute [rw] flagged_resources # The details about each resource listed in the check result. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckResult AWS API Documentation # class TrustedAdvisorCheckResult < Struct.new( :check_id, :timestamp, :status, :resources_summary, :category_specific_summary, :flagged_resources) SENSITIVE = [] include Aws::Structure end # A summary of a Trusted Advisor check result, including the alert # status, last refresh, and number of resources examined. # # @!attribute [rw] check_id # The unique identifier for the Trusted Advisor check. # @return [String] # # @!attribute [rw] timestamp # The time of the last refresh of the check. # @return [String] # # @!attribute [rw] status # The alert status of the check: "ok" (green), "warning" (yellow), # "error" (red), or "not\_available". # @return [String] # # @!attribute [rw] has_flagged_resources # Specifies whether the Trusted Advisor check has flagged resources. # @return [Boolean] # # @!attribute [rw] resources_summary # Details about Amazon Web Services resources that were analyzed in a # call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. # @return [Types::TrustedAdvisorResourcesSummary] # # @!attribute [rw] category_specific_summary # Summary information that relates to the category of the check. Cost # Optimizing is the only category that is currently supported. # @return [Types::TrustedAdvisorCategorySpecificSummary] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCheckSummary AWS API Documentation # class TrustedAdvisorCheckSummary < Struct.new( :check_id, :timestamp, :status, :has_flagged_resources, :resources_summary, :category_specific_summary) SENSITIVE = [] include Aws::Structure end # The estimated cost savings that might be realized if the recommended # operations are taken. # # @!attribute [rw] estimated_monthly_savings # The estimated monthly savings that might be realized if the # recommended operations are taken. # @return [Float] # # @!attribute [rw] estimated_percent_monthly_savings # The estimated percentage of savings that might be realized if the # recommended operations are taken. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorCostOptimizingSummary AWS API Documentation # class TrustedAdvisorCostOptimizingSummary < Struct.new( :estimated_monthly_savings, :estimated_percent_monthly_savings) SENSITIVE = [] include Aws::Structure end # Contains information about a resource identified by a Trusted Advisor # check. # # @!attribute [rw] status # The status code for the resource identified in the Trusted Advisor # check. # @return [String] # # @!attribute [rw] region # The Amazon Web Services Region in which the identified resource is # located. # @return [String] # # @!attribute [rw] resource_id # The unique identifier for the identified resource. # @return [String] # # @!attribute [rw] is_suppressed # Specifies whether the Amazon Web Services resource was ignored by # Trusted Advisor because it was marked as suppressed by the user. # @return [Boolean] # # @!attribute [rw] metadata # Additional information about the identified resource. The exact # metadata and its order can be obtained by inspecting the # TrustedAdvisorCheckDescription object returned by the call to # DescribeTrustedAdvisorChecks. **Metadata** contains all the data # that is shown in the Excel download, even in those cases where the # UI shows just summary data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorResourceDetail AWS API Documentation # class TrustedAdvisorResourceDetail < Struct.new( :status, :region, :resource_id, :is_suppressed, :metadata) SENSITIVE = [] include Aws::Structure end # Details about Amazon Web Services resources that were analyzed in a # call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. # # @!attribute [rw] resources_processed # The number of Amazon Web Services resources that were analyzed by # the Trusted Advisor check. # @return [Integer] # # @!attribute [rw] resources_flagged # The number of Amazon Web Services resources that were flagged # (listed) by the Trusted Advisor check. # @return [Integer] # # @!attribute [rw] resources_ignored # The number of Amazon Web Services resources ignored by Trusted # Advisor because information was unavailable. # @return [Integer] # # @!attribute [rw] resources_suppressed # The number of Amazon Web Services resources ignored by Trusted # Advisor because they were marked as suppressed by the user. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/TrustedAdvisorResourcesSummary AWS API Documentation # class TrustedAdvisorResourcesSummary < Struct.new( :resources_processed, :resources_flagged, :resources_ignored, :resources_suppressed) SENSITIVE = [] include Aws::Structure end end end