Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Attachment

type Attachment struct {

	// The content of the attachment file.
	Data []byte

	// The name of the attachment file.
	FileName *string
}

    An attachment to a case communication. The attachment consists of the file name and the content of the file.

    type AttachmentDetails

    type AttachmentDetails struct {
    
    	// The ID of the attachment.
    	AttachmentId *string
    
    	// The file name of the attachment.
    	FileName *string
    }

      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.

      type AttachmentIdNotFound

      type AttachmentIdNotFound struct {
      	Message *string
      }

        An attachment with the specified ID could not be found.

        func (*AttachmentIdNotFound) Error

        func (e *AttachmentIdNotFound) Error() string

        func (*AttachmentIdNotFound) ErrorCode

        func (e *AttachmentIdNotFound) ErrorCode() string

        func (*AttachmentIdNotFound) ErrorFault

        func (e *AttachmentIdNotFound) ErrorFault() smithy.ErrorFault

        func (*AttachmentIdNotFound) ErrorMessage

        func (e *AttachmentIdNotFound) ErrorMessage() string

        type AttachmentLimitExceeded

        type AttachmentLimitExceeded struct {
        	Message *string
        }

          The limit for the number of attachment sets created in a short period of time has been exceeded.

          func (*AttachmentLimitExceeded) Error

          func (e *AttachmentLimitExceeded) Error() string

          func (*AttachmentLimitExceeded) ErrorCode

          func (e *AttachmentLimitExceeded) ErrorCode() string

          func (*AttachmentLimitExceeded) ErrorFault

          func (e *AttachmentLimitExceeded) ErrorFault() smithy.ErrorFault

          func (*AttachmentLimitExceeded) ErrorMessage

          func (e *AttachmentLimitExceeded) ErrorMessage() string

          type AttachmentSetExpired

          type AttachmentSetExpired struct {
          	Message *string
          }

            The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

            func (*AttachmentSetExpired) Error

            func (e *AttachmentSetExpired) Error() string

            func (*AttachmentSetExpired) ErrorCode

            func (e *AttachmentSetExpired) ErrorCode() string

            func (*AttachmentSetExpired) ErrorFault

            func (e *AttachmentSetExpired) ErrorFault() smithy.ErrorFault

            func (*AttachmentSetExpired) ErrorMessage

            func (e *AttachmentSetExpired) ErrorMessage() string

            type AttachmentSetIdNotFound

            type AttachmentSetIdNotFound struct {
            	Message *string
            }

              An attachment set with the specified ID could not be found.

              func (*AttachmentSetIdNotFound) Error

              func (e *AttachmentSetIdNotFound) Error() string

              func (*AttachmentSetIdNotFound) ErrorCode

              func (e *AttachmentSetIdNotFound) ErrorCode() string

              func (*AttachmentSetIdNotFound) ErrorFault

              func (e *AttachmentSetIdNotFound) ErrorFault() smithy.ErrorFault

              func (*AttachmentSetIdNotFound) ErrorMessage

              func (e *AttachmentSetIdNotFound) ErrorMessage() string

              type AttachmentSetSizeLimitExceeded

              type AttachmentSetSizeLimitExceeded struct {
              	Message *string
              }

                A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.

                func (*AttachmentSetSizeLimitExceeded) Error

                func (*AttachmentSetSizeLimitExceeded) ErrorCode

                func (e *AttachmentSetSizeLimitExceeded) ErrorCode() string

                func (*AttachmentSetSizeLimitExceeded) ErrorFault

                func (*AttachmentSetSizeLimitExceeded) ErrorMessage

                func (e *AttachmentSetSizeLimitExceeded) ErrorMessage() string

                type CaseCreationLimitExceeded

                type CaseCreationLimitExceeded struct {
                	Message *string
                }

                  The case creation limit for the account has been exceeded.

                  func (*CaseCreationLimitExceeded) Error

                  func (e *CaseCreationLimitExceeded) Error() string

                  func (*CaseCreationLimitExceeded) ErrorCode

                  func (e *CaseCreationLimitExceeded) ErrorCode() string

                  func (*CaseCreationLimitExceeded) ErrorFault

                  func (*CaseCreationLimitExceeded) ErrorMessage

                  func (e *CaseCreationLimitExceeded) ErrorMessage() string

                  type CaseDetails

                  type CaseDetails struct {
                  
                  	// The AWS 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
                  	CaseId *string
                  
                  	// The category of problem for the AWS Support case.
                  	CategoryCode *string
                  
                  	// The email addresses that receive copies of communication about the case.
                  	CcEmailAddresses []string
                  
                  	// The ID displayed for the case in the AWS Support Center. This is a numeric
                  	// string.
                  	DisplayId *string
                  
                  	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
                  	// currently supports English ("en") and Japanese ("ja"). Language parameters must
                  	// be passed explicitly for operations that take them.
                  	Language *string
                  
                  	// The five most recent communications between you and AWS Support Center,
                  	// including the IDs of any attachments to the communications. Also includes a
                  	// nextToken that you can use to retrieve earlier communications.
                  	RecentCommunications *RecentCaseCommunications
                  
                  	// The code for the AWS service. You can get a list of codes and the corresponding
                  	// service names by calling DescribeServices.
                  	ServiceCode *string
                  
                  	// The code for the severity level returned by the call to DescribeSeverityLevels.
                  	SeverityCode *string
                  
                  	// The status of the case. Valid values:
                  	//
                  	// * opened
                  	//
                  	// * pending-customer-action
                  	//
                  	// *
                  	// reopened
                  	//
                  	// * resolved
                  	//
                  	// * unassigned
                  	//
                  	// * work-in-progress
                  	Status *string
                  
                  	// The subject line for the case in the AWS Support Center.
                  	Subject *string
                  
                  	// The email address of the account that submitted the case.
                  	SubmittedBy *string
                  
                  	// The time that the case was created in the AWS Support Center.
                  	TimeCreated *string
                  }

                    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 AWS 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 AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

                    * displayId. The identifier for the case on pages in the AWS Support Center.

                    * language. The ISO 639-1 code for the language in which AWS provides support. AWS 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 AWS 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 AWS 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.

                    type CaseIdNotFound

                    type CaseIdNotFound struct {
                    	Message *string
                    }

                      The requested caseId could not be located.

                      func (*CaseIdNotFound) Error

                      func (e *CaseIdNotFound) Error() string

                      func (*CaseIdNotFound) ErrorCode

                      func (e *CaseIdNotFound) ErrorCode() string

                      func (*CaseIdNotFound) ErrorFault

                      func (e *CaseIdNotFound) ErrorFault() smithy.ErrorFault

                      func (*CaseIdNotFound) ErrorMessage

                      func (e *CaseIdNotFound) ErrorMessage() string

                      type Category

                      type Category struct {
                      
                      	// The category code for the support case.
                      	Code *string
                      
                      	// The category name for the support case.
                      	Name *string
                      }

                        A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

                        type Communication

                        type Communication struct {
                        
                        	// Information about the attachments to the case communication.
                        	AttachmentSet []AttachmentDetails
                        
                        	// The text of the communication between the customer and AWS Support.
                        	Body *string
                        
                        	// The AWS 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
                        	CaseId *string
                        
                        	// 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) . Entries from the AWS Support team display "Amazon
                        	// Web Services," and do not show an email address.
                        	SubmittedBy *string
                        
                        	// The time the communication was created.
                        	TimeCreated *string
                        }

                          A communication associated with an AWS 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.

                          type DescribeAttachmentLimitExceeded

                          type DescribeAttachmentLimitExceeded struct {
                          	Message *string
                          }

                            The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

                            func (*DescribeAttachmentLimitExceeded) Error

                            func (*DescribeAttachmentLimitExceeded) ErrorCode

                            func (e *DescribeAttachmentLimitExceeded) ErrorCode() string

                            func (*DescribeAttachmentLimitExceeded) ErrorFault

                            func (*DescribeAttachmentLimitExceeded) ErrorMessage

                            func (e *DescribeAttachmentLimitExceeded) ErrorMessage() string

                            type InternalServerError

                            type InternalServerError struct {
                            	Message *string
                            }

                              An internal server error occurred.

                              func (*InternalServerError) Error

                              func (e *InternalServerError) Error() string

                              func (*InternalServerError) ErrorCode

                              func (e *InternalServerError) ErrorCode() string

                              func (*InternalServerError) ErrorFault

                              func (e *InternalServerError) ErrorFault() smithy.ErrorFault

                              func (*InternalServerError) ErrorMessage

                              func (e *InternalServerError) ErrorMessage() string

                              type RecentCaseCommunications

                              type RecentCaseCommunications struct {
                              
                              	// The five most recent communications associated with the case.
                              	Communications []Communication
                              
                              	// A resumption point for pagination.
                              	NextToken *string
                              }

                                The five most recent communications associated with the case.

                                type Service

                                type Service struct {
                                
                                	// 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 AWS Support when you call CreateCase.
                                	Categories []Category
                                
                                	// The code for an AWS service returned by the DescribeServices response. The name
                                	// element contains the corresponding friendly name.
                                	Code *string
                                
                                	// The friendly name for an AWS service. The code element contains the
                                	// corresponding code.
                                	Name *string
                                }

                                  Information about an AWS service returned by the DescribeServices operation.

                                  type SeverityLevel

                                  type SeverityLevel struct {
                                  
                                  	// The code for case severity level. Valid values: low | normal | high | urgent |
                                  	// critical
                                  	Code *string
                                  
                                  	// The name of the severity level that corresponds to the severity level code. The
                                  	// values returned by the API differ from the values that are displayed in the AWS
                                  	// Support Center. For example, for the code "low", the API name is "Low", but the
                                  	// name in the Support Center is "General guidance". These are the Support Center
                                  	// code/name mappings:
                                  	//
                                  	// * 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
                                  	// (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity)
                                  	// in the AWS Support User Guide.
                                  	Name *string
                                  }

                                    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 (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity) in the AWS Support User Guide.

                                    type TrustedAdvisorCategorySpecificSummary

                                    type TrustedAdvisorCategorySpecificSummary struct {
                                    
                                    	// The summary information about cost savings for a Trusted Advisor check that is
                                    	// in the Cost Optimizing category.
                                    	CostOptimizing *TrustedAdvisorCostOptimizingSummary
                                    }

                                      The container for summary information that relates to the category of the Trusted Advisor check.

                                      type TrustedAdvisorCheckDescription

                                      type TrustedAdvisorCheckDescription struct {
                                      
                                      	// The category of the Trusted Advisor check.
                                      	//
                                      	// This member is required.
                                      	Category *string
                                      
                                      	// The description of the Trusted Advisor check, which includes the alert criteria
                                      	// and recommended operations (contains HTML markup).
                                      	//
                                      	// This member is required.
                                      	Description *string
                                      
                                      	// The unique identifier for the Trusted Advisor check.
                                      	//
                                      	// This member is required.
                                      	Id *string
                                      
                                      	// 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.
                                      	//
                                      	// This member is required.
                                      	Metadata []string
                                      
                                      	// The display name for the Trusted Advisor check.
                                      	//
                                      	// This member is required.
                                      	Name *string
                                      }

                                        The description and metadata for a Trusted Advisor check.

                                        type TrustedAdvisorCheckRefreshStatus

                                        type TrustedAdvisorCheckRefreshStatus struct {
                                        
                                        	// The unique identifier for the Trusted Advisor check.
                                        	//
                                        	// This member is required.
                                        	CheckId *string
                                        
                                        	// The amount of time, in milliseconds, until the Trusted Advisor check is eligible
                                        	// for refresh.
                                        	//
                                        	// This member is required.
                                        	MillisUntilNextRefreshable int64
                                        
                                        	// 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
                                        	//
                                        	// This member is required.
                                        	Status *string
                                        }

                                          The refresh status of a Trusted Advisor check.

                                          type TrustedAdvisorCheckResult

                                          type TrustedAdvisorCheckResult struct {
                                          
                                          	// Summary information that relates to the category of the check. Cost Optimizing
                                          	// is the only category that is currently supported.
                                          	//
                                          	// This member is required.
                                          	CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary
                                          
                                          	// The unique identifier for the Trusted Advisor check.
                                          	//
                                          	// This member is required.
                                          	CheckId *string
                                          
                                          	// The details about each resource listed in the check result.
                                          	//
                                          	// This member is required.
                                          	FlaggedResources []TrustedAdvisorResourceDetail
                                          
                                          	// Details about AWS resources that were analyzed in a call to Trusted Advisor
                                          	// DescribeTrustedAdvisorCheckSummaries.
                                          	//
                                          	// This member is required.
                                          	ResourcesSummary *TrustedAdvisorResourcesSummary
                                          
                                          	// The alert status of the check: "ok" (green), "warning" (yellow), "error" (red),
                                          	// or "not_available".
                                          	//
                                          	// This member is required.
                                          	Status *string
                                          
                                          	// The time of the last refresh of the check.
                                          	//
                                          	// This member is required.
                                          	Timestamp *string
                                          }

                                            The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

                                            type TrustedAdvisorCheckSummary

                                            type TrustedAdvisorCheckSummary struct {
                                            
                                            	// Summary information that relates to the category of the check. Cost Optimizing
                                            	// is the only category that is currently supported.
                                            	//
                                            	// This member is required.
                                            	CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary
                                            
                                            	// The unique identifier for the Trusted Advisor check.
                                            	//
                                            	// This member is required.
                                            	CheckId *string
                                            
                                            	// Details about AWS resources that were analyzed in a call to Trusted Advisor
                                            	// DescribeTrustedAdvisorCheckSummaries.
                                            	//
                                            	// This member is required.
                                            	ResourcesSummary *TrustedAdvisorResourcesSummary
                                            
                                            	// The alert status of the check: "ok" (green), "warning" (yellow), "error" (red),
                                            	// or "not_available".
                                            	//
                                            	// This member is required.
                                            	Status *string
                                            
                                            	// The time of the last refresh of the check.
                                            	//
                                            	// This member is required.
                                            	Timestamp *string
                                            
                                            	// Specifies whether the Trusted Advisor check has flagged resources.
                                            	HasFlaggedResources bool
                                            }

                                              A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

                                              type TrustedAdvisorCostOptimizingSummary

                                              type TrustedAdvisorCostOptimizingSummary struct {
                                              
                                              	// The estimated monthly savings that might be realized if the recommended
                                              	// operations are taken.
                                              	//
                                              	// This member is required.
                                              	EstimatedMonthlySavings float64
                                              
                                              	// The estimated percentage of savings that might be realized if the recommended
                                              	// operations are taken.
                                              	//
                                              	// This member is required.
                                              	EstimatedPercentMonthlySavings float64
                                              }

                                                The estimated cost savings that might be realized if the recommended operations are taken.

                                                type TrustedAdvisorResourceDetail

                                                type TrustedAdvisorResourceDetail struct {
                                                
                                                	// 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.
                                                	//
                                                	// This member is required.
                                                	Metadata []string
                                                
                                                	// The unique identifier for the identified resource.
                                                	//
                                                	// This member is required.
                                                	ResourceId *string
                                                
                                                	// The status code for the resource identified in the Trusted Advisor check.
                                                	//
                                                	// This member is required.
                                                	Status *string
                                                
                                                	// Specifies whether the AWS resource was ignored by Trusted Advisor because it was
                                                	// marked as suppressed by the user.
                                                	IsSuppressed bool
                                                
                                                	// The AWS region in which the identified resource is located.
                                                	Region *string
                                                }

                                                  Contains information about a resource identified by a Trusted Advisor check.

                                                  type TrustedAdvisorResourcesSummary

                                                  type TrustedAdvisorResourcesSummary struct {
                                                  
                                                  	// The number of AWS resources that were flagged (listed) by the Trusted Advisor
                                                  	// check.
                                                  	//
                                                  	// This member is required.
                                                  	ResourcesFlagged int64
                                                  
                                                  	// The number of AWS resources ignored by Trusted Advisor because information was
                                                  	// unavailable.
                                                  	//
                                                  	// This member is required.
                                                  	ResourcesIgnored int64
                                                  
                                                  	// The number of AWS resources that were analyzed by the Trusted Advisor check.
                                                  	//
                                                  	// This member is required.
                                                  	ResourcesProcessed int64
                                                  
                                                  	// The number of AWS resources ignored by Trusted Advisor because they were marked
                                                  	// as suppressed by the user.
                                                  	//
                                                  	// This member is required.
                                                  	ResourcesSuppressed int64
                                                  }

                                                    Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

                                                    Source Files