support

package
v1.42.34 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2022 License: Apache-2.0 Imports: 9 Imported by: 71

Documentation

Overview

Package support provides the client and types for making API requests to AWS Support.

The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

The Amazon Web Services Support service also exposes a set of Trusted Advisor (http://aws.amazon.com/premiumsupport/trustedadvisor/) features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the Amazon Web Services Support case management operations:

  • Service names, issue categories, and available severity levels - The DescribeServices and DescribeSeverityLevels operations return Amazon Web Services service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.

  • Case creation, case details, and case resolution - The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.

  • Case communication - The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.

The following list describes the operations available from the Amazon Web Services Support service for Trusted Advisor:

  • DescribeTrustedAdvisorChecks returns the list of checks that run against your Amazon Web Services resources.

  • Using the checkId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check that you specified.

  • DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.

  • RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check.

  • DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks.

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

See About the Amazon Web Services Support API (https://docs.aws.amazon.com/awssupport/latest/user/Welcome.html) in the Amazon Web Services Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

See https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15 for more information on this service.

See support package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/support/

Using the Client

To contact AWS Support with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Support client Support for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/support/#New

Index

Constants

View Source
const (

	// ErrCodeAttachmentIdNotFound for service response error code
	// "AttachmentIdNotFound".
	//
	// An attachment with the specified ID could not be found.
	ErrCodeAttachmentIdNotFound = "AttachmentIdNotFound"

	// ErrCodeAttachmentLimitExceeded for service response error code
	// "AttachmentLimitExceeded".
	//
	// The limit for the number of attachment sets created in a short period of
	// time has been exceeded.
	ErrCodeAttachmentLimitExceeded = "AttachmentLimitExceeded"

	// ErrCodeAttachmentSetExpired for service response error code
	// "AttachmentSetExpired".
	//
	// The expiration time of the attachment set has passed. The set expires 1 hour
	// after it is created.
	ErrCodeAttachmentSetExpired = "AttachmentSetExpired"

	// ErrCodeAttachmentSetIdNotFound for service response error code
	// "AttachmentSetIdNotFound".
	//
	// An attachment set with the specified ID could not be found.
	ErrCodeAttachmentSetIdNotFound = "AttachmentSetIdNotFound"

	// ErrCodeAttachmentSetSizeLimitExceeded for service response error code
	// "AttachmentSetSizeLimitExceeded".
	//
	// A limit for the size of an attachment set has been exceeded. The limits are
	// three attachments and 5 MB per attachment.
	ErrCodeAttachmentSetSizeLimitExceeded = "AttachmentSetSizeLimitExceeded"

	// ErrCodeCaseCreationLimitExceeded for service response error code
	// "CaseCreationLimitExceeded".
	//
	// The case creation limit for the account has been exceeded.
	ErrCodeCaseCreationLimitExceeded = "CaseCreationLimitExceeded"

	// ErrCodeCaseIdNotFound for service response error code
	// "CaseIdNotFound".
	//
	// The requested caseId couldn't be located.
	ErrCodeCaseIdNotFound = "CaseIdNotFound"

	// ErrCodeDescribeAttachmentLimitExceeded for service response error code
	// "DescribeAttachmentLimitExceeded".
	//
	// The limit for the number of DescribeAttachment requests in a short period
	// of time has been exceeded.
	ErrCodeDescribeAttachmentLimitExceeded = "DescribeAttachmentLimitExceeded"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// An internal server error occurred.
	ErrCodeInternalServerError = "InternalServerError"
)
View Source
const (
	ServiceName = "support"   // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Support"   // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AddAttachmentsToSetInput

type AddAttachmentsToSetInput struct {

	// 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.
	AttachmentSetId *string `locationName:"attachmentSetId" type:"string"`

	// 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.
	//
	// Attachments is a required field
	Attachments []*Attachment `locationName:"attachments" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddAttachmentsToSetInput) GoString added in v0.6.5

func (s AddAttachmentsToSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddAttachmentsToSetInput) SetAttachmentSetId added in v1.5.0

func (s *AddAttachmentsToSetInput) SetAttachmentSetId(v string) *AddAttachmentsToSetInput

SetAttachmentSetId sets the AttachmentSetId field's value.

func (*AddAttachmentsToSetInput) SetAttachments added in v1.5.0

SetAttachments sets the Attachments field's value.

func (AddAttachmentsToSetInput) String added in v0.6.5

func (s AddAttachmentsToSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddAttachmentsToSetInput) Validate added in v1.1.21

func (s *AddAttachmentsToSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddAttachmentsToSetOutput

type AddAttachmentsToSetOutput struct {

	// 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.
	AttachmentSetId *string `locationName:"attachmentSetId" type:"string"`

	// The time and date when the attachment set expires.
	ExpiryTime *string `locationName:"expiryTime" type:"string"`
	// contains filtered or unexported fields
}

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

func (AddAttachmentsToSetOutput) GoString added in v0.6.5

func (s AddAttachmentsToSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddAttachmentsToSetOutput) SetAttachmentSetId added in v1.5.0

SetAttachmentSetId sets the AttachmentSetId field's value.

func (*AddAttachmentsToSetOutput) SetExpiryTime added in v1.5.0

SetExpiryTime sets the ExpiryTime field's value.

func (AddAttachmentsToSetOutput) String added in v0.6.5

func (s AddAttachmentsToSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddCommunicationToCaseInput

type AddCommunicationToCaseInput struct {

	// The ID of a set of one or more attachments for the communication to add to
	// the case. Create the set by calling AddAttachmentsToSet
	AttachmentSetId *string `locationName:"attachmentSetId" type:"string"`

	// The support case ID requested or returned in the call. The case ID is an
	// alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
	CaseId *string `locationName:"caseId" type:"string"`

	// The email addresses in the CC line of an email to be added to the support
	// case.
	CcEmailAddresses []*string `locationName:"ccEmailAddresses" type:"list"`

	// The body of an email communication to add to the support case.
	//
	// CommunicationBody is a required field
	CommunicationBody *string `locationName:"communicationBody" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddCommunicationToCaseInput) GoString added in v0.6.5

func (s AddCommunicationToCaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddCommunicationToCaseInput) SetAttachmentSetId added in v1.5.0

SetAttachmentSetId sets the AttachmentSetId field's value.

func (*AddCommunicationToCaseInput) SetCaseId added in v1.5.0

SetCaseId sets the CaseId field's value.

func (*AddCommunicationToCaseInput) SetCcEmailAddresses added in v1.5.0

func (s *AddCommunicationToCaseInput) SetCcEmailAddresses(v []*string) *AddCommunicationToCaseInput

SetCcEmailAddresses sets the CcEmailAddresses field's value.

func (*AddCommunicationToCaseInput) SetCommunicationBody added in v1.5.0

SetCommunicationBody sets the CommunicationBody field's value.

func (AddCommunicationToCaseInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddCommunicationToCaseInput) Validate added in v1.1.21

func (s *AddCommunicationToCaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddCommunicationToCaseOutput

type AddCommunicationToCaseOutput struct {

	// True if AddCommunicationToCase succeeds. Otherwise, returns an error.
	Result *bool `locationName:"result" type:"boolean"`
	// contains filtered or unexported fields
}

The result of the AddCommunicationToCase operation.

func (AddCommunicationToCaseOutput) GoString added in v0.6.5

func (s AddCommunicationToCaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddCommunicationToCaseOutput) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (AddCommunicationToCaseOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Attachment

type Attachment struct {

	// The content of the attachment file.
	// Data is automatically base64 encoded/decoded by the SDK.
	Data []byte `locationName:"data" type:"blob"`

	// The name of the attachment file.
	FileName *string `locationName:"fileName" type:"string"`
	// contains filtered or unexported fields
}

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

func (Attachment) GoString added in v0.6.5

func (s Attachment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Attachment) SetData added in v1.5.0

func (s *Attachment) SetData(v []byte) *Attachment

SetData sets the Data field's value.

func (*Attachment) SetFileName added in v1.5.0

func (s *Attachment) SetFileName(v string) *Attachment

SetFileName sets the FileName field's value.

func (Attachment) String added in v0.6.5

func (s Attachment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachmentDetails

type AttachmentDetails struct {

	// The ID of the attachment.
	AttachmentId *string `locationName:"attachmentId" type:"string"`

	// The file name of the attachment.
	FileName *string `locationName:"fileName" type:"string"`
	// contains filtered or unexported fields
}

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.

func (AttachmentDetails) GoString added in v0.6.5

func (s AttachmentDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachmentDetails) SetAttachmentId added in v1.5.0

func (s *AttachmentDetails) SetAttachmentId(v string) *AttachmentDetails

SetAttachmentId sets the AttachmentId field's value.

func (*AttachmentDetails) SetFileName added in v1.5.0

func (s *AttachmentDetails) SetFileName(v string) *AttachmentDetails

SetFileName sets the FileName field's value.

func (AttachmentDetails) String added in v0.6.5

func (s AttachmentDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachmentIdNotFound added in v1.28.0

type AttachmentIdNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// An attachment with the specified ID could not be found.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An attachment with the specified ID could not be found.

func (*AttachmentIdNotFound) Code added in v1.28.0

func (s *AttachmentIdNotFound) Code() string

Code returns the exception type name.

func (*AttachmentIdNotFound) Error added in v1.28.0

func (s *AttachmentIdNotFound) Error() string

func (AttachmentIdNotFound) GoString added in v1.28.0

func (s AttachmentIdNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachmentIdNotFound) Message added in v1.28.0

func (s *AttachmentIdNotFound) Message() string

Message returns the exception's message.

func (*AttachmentIdNotFound) OrigErr added in v1.28.0

func (s *AttachmentIdNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AttachmentIdNotFound) RequestID added in v1.28.0

func (s *AttachmentIdNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AttachmentIdNotFound) StatusCode added in v1.28.0

func (s *AttachmentIdNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AttachmentIdNotFound) String added in v1.28.0

func (s AttachmentIdNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachmentLimitExceeded added in v1.28.0

type AttachmentLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The limit for the number of attachment sets created in a short period of
	// time has been exceeded.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*AttachmentLimitExceeded) Code added in v1.28.0

func (s *AttachmentLimitExceeded) Code() string

Code returns the exception type name.

func (*AttachmentLimitExceeded) Error added in v1.28.0

func (s *AttachmentLimitExceeded) Error() string

func (AttachmentLimitExceeded) GoString added in v1.28.0

func (s AttachmentLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachmentLimitExceeded) Message added in v1.28.0

func (s *AttachmentLimitExceeded) Message() string

Message returns the exception's message.

func (*AttachmentLimitExceeded) OrigErr added in v1.28.0

func (s *AttachmentLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AttachmentLimitExceeded) RequestID added in v1.28.0

func (s *AttachmentLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AttachmentLimitExceeded) StatusCode added in v1.28.0

func (s *AttachmentLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AttachmentLimitExceeded) String added in v1.28.0

func (s AttachmentLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachmentSetExpired added in v1.28.0

type AttachmentSetExpired struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The expiration time of the attachment set has passed. The set expires one
	// hour after it is created.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*AttachmentSetExpired) Code added in v1.28.0

func (s *AttachmentSetExpired) Code() string

Code returns the exception type name.

func (*AttachmentSetExpired) Error added in v1.28.0

func (s *AttachmentSetExpired) Error() string

func (AttachmentSetExpired) GoString added in v1.28.0

func (s AttachmentSetExpired) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachmentSetExpired) Message added in v1.28.0

func (s *AttachmentSetExpired) Message() string

Message returns the exception's message.

func (*AttachmentSetExpired) OrigErr added in v1.28.0

func (s *AttachmentSetExpired) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AttachmentSetExpired) RequestID added in v1.28.0

func (s *AttachmentSetExpired) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AttachmentSetExpired) StatusCode added in v1.28.0

func (s *AttachmentSetExpired) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AttachmentSetExpired) String added in v1.28.0

func (s AttachmentSetExpired) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachmentSetIdNotFound added in v1.28.0

type AttachmentSetIdNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// An attachment set with the specified ID could not be found.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*AttachmentSetIdNotFound) Code added in v1.28.0

func (s *AttachmentSetIdNotFound) Code() string

Code returns the exception type name.

func (*AttachmentSetIdNotFound) Error added in v1.28.0

func (s *AttachmentSetIdNotFound) Error() string

func (AttachmentSetIdNotFound) GoString added in v1.28.0

func (s AttachmentSetIdNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachmentSetIdNotFound) Message added in v1.28.0

func (s *AttachmentSetIdNotFound) Message() string

Message returns the exception's message.

func (*AttachmentSetIdNotFound) OrigErr added in v1.28.0

func (s *AttachmentSetIdNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AttachmentSetIdNotFound) RequestID added in v1.28.0

func (s *AttachmentSetIdNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AttachmentSetIdNotFound) StatusCode added in v1.28.0

func (s *AttachmentSetIdNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AttachmentSetIdNotFound) String added in v1.28.0

func (s AttachmentSetIdNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachmentSetSizeLimitExceeded added in v1.28.0

type AttachmentSetSizeLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A limit for the size of an attachment set has been exceeded. The limits are
	// three attachments and 5 MB per attachment.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*AttachmentSetSizeLimitExceeded) Code added in v1.28.0

Code returns the exception type name.

func (*AttachmentSetSizeLimitExceeded) Error added in v1.28.0

func (AttachmentSetSizeLimitExceeded) GoString added in v1.28.0

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachmentSetSizeLimitExceeded) Message added in v1.28.0

Message returns the exception's message.

func (*AttachmentSetSizeLimitExceeded) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AttachmentSetSizeLimitExceeded) RequestID added in v1.28.0

func (s *AttachmentSetSizeLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AttachmentSetSizeLimitExceeded) StatusCode added in v1.28.0

func (s *AttachmentSetSizeLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AttachmentSetSizeLimitExceeded) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CaseCreationLimitExceeded added in v1.28.0

type CaseCreationLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// An error message that indicates that you have exceeded the number of cases
	// you can have open.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The case creation limit for the account has been exceeded.

func (*CaseCreationLimitExceeded) Code added in v1.28.0

Code returns the exception type name.

func (*CaseCreationLimitExceeded) Error added in v1.28.0

func (s *CaseCreationLimitExceeded) Error() string

func (CaseCreationLimitExceeded) GoString added in v1.28.0

func (s CaseCreationLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CaseCreationLimitExceeded) Message added in v1.28.0

func (s *CaseCreationLimitExceeded) Message() string

Message returns the exception's message.

func (*CaseCreationLimitExceeded) OrigErr added in v1.28.0

func (s *CaseCreationLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CaseCreationLimitExceeded) RequestID added in v1.28.0

func (s *CaseCreationLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CaseCreationLimitExceeded) StatusCode added in v1.28.0

func (s *CaseCreationLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CaseCreationLimitExceeded) String added in v1.28.0

func (s CaseCreationLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CaseDetails

type CaseDetails struct {

	// 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
	CaseId *string `locationName:"caseId" type:"string"`

	// The category of problem for the support case.
	CategoryCode *string `locationName:"categoryCode" type:"string"`

	// The email addresses that receive copies of communication about the case.
	CcEmailAddresses []*string `locationName:"ccEmailAddresses" type:"list"`

	// The ID displayed for the case in the Amazon Web Services Support Center.
	// This is a numeric string.
	DisplayId *string `locationName:"displayId" type:"string"`

	// 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.
	Language *string `locationName:"language" type:"string"`

	// 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.
	RecentCommunications *RecentCaseCommunications `locationName:"recentCommunications" type:"structure"`

	// The code for the Amazon Web Services service. You can get a list of codes
	// and the corresponding service names by calling DescribeServices.
	ServiceCode *string `locationName:"serviceCode" type:"string"`

	// The code for the severity level returned by the call to DescribeSeverityLevels.
	SeverityCode *string `locationName:"severityCode" type:"string"`

	// The status of the case.
	//
	// Valid values:
	//
	//    * opened
	//
	//    * pending-customer-action
	//
	//    * reopened
	//
	//    * resolved
	//
	//    * unassigned
	//
	//    * work-in-progress
	Status *string `locationName:"status" type:"string"`

	// The subject line for the case in the Amazon Web Services Support Center.
	Subject *string `locationName:"subject" type:"string"`

	// The email address of the account that submitted the case.
	SubmittedBy *string `locationName:"submittedBy" type:"string"`

	// The time that the case was created in the Amazon Web Services Support Center.
	TimeCreated *string `locationName:"timeCreated" type:"string"`
	// contains filtered or unexported fields
}

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.

func (CaseDetails) GoString added in v0.6.5

func (s CaseDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CaseDetails) SetCaseId added in v1.5.0

func (s *CaseDetails) SetCaseId(v string) *CaseDetails

SetCaseId sets the CaseId field's value.

func (*CaseDetails) SetCategoryCode added in v1.5.0

func (s *CaseDetails) SetCategoryCode(v string) *CaseDetails

SetCategoryCode sets the CategoryCode field's value.

func (*CaseDetails) SetCcEmailAddresses added in v1.5.0

func (s *CaseDetails) SetCcEmailAddresses(v []*string) *CaseDetails

SetCcEmailAddresses sets the CcEmailAddresses field's value.

func (*CaseDetails) SetDisplayId added in v1.5.0

func (s *CaseDetails) SetDisplayId(v string) *CaseDetails

SetDisplayId sets the DisplayId field's value.

func (*CaseDetails) SetLanguage added in v1.5.0

func (s *CaseDetails) SetLanguage(v string) *CaseDetails

SetLanguage sets the Language field's value.

func (*CaseDetails) SetRecentCommunications added in v1.5.0

func (s *CaseDetails) SetRecentCommunications(v *RecentCaseCommunications) *CaseDetails

SetRecentCommunications sets the RecentCommunications field's value.

func (*CaseDetails) SetServiceCode added in v1.5.0

func (s *CaseDetails) SetServiceCode(v string) *CaseDetails

SetServiceCode sets the ServiceCode field's value.

func (*CaseDetails) SetSeverityCode added in v1.5.0

func (s *CaseDetails) SetSeverityCode(v string) *CaseDetails

SetSeverityCode sets the SeverityCode field's value.

func (*CaseDetails) SetStatus added in v1.5.0

func (s *CaseDetails) SetStatus(v string) *CaseDetails

SetStatus sets the Status field's value.

func (*CaseDetails) SetSubject added in v1.5.0

func (s *CaseDetails) SetSubject(v string) *CaseDetails

SetSubject sets the Subject field's value.

func (*CaseDetails) SetSubmittedBy added in v1.5.0

func (s *CaseDetails) SetSubmittedBy(v string) *CaseDetails

SetSubmittedBy sets the SubmittedBy field's value.

func (*CaseDetails) SetTimeCreated added in v1.5.0

func (s *CaseDetails) SetTimeCreated(v string) *CaseDetails

SetTimeCreated sets the TimeCreated field's value.

func (CaseDetails) String added in v0.6.5

func (s CaseDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CaseIdNotFound added in v1.28.0

type CaseIdNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The requested CaseId could not be located.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested caseId couldn't be located.

func (*CaseIdNotFound) Code added in v1.28.0

func (s *CaseIdNotFound) Code() string

Code returns the exception type name.

func (*CaseIdNotFound) Error added in v1.28.0

func (s *CaseIdNotFound) Error() string

func (CaseIdNotFound) GoString added in v1.28.0

func (s CaseIdNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CaseIdNotFound) Message added in v1.28.0

func (s *CaseIdNotFound) Message() string

Message returns the exception's message.

func (*CaseIdNotFound) OrigErr added in v1.28.0

func (s *CaseIdNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CaseIdNotFound) RequestID added in v1.28.0

func (s *CaseIdNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CaseIdNotFound) StatusCode added in v1.28.0

func (s *CaseIdNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CaseIdNotFound) String added in v1.28.0

func (s CaseIdNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Category

type Category struct {

	// The category code for the support case.
	Code *string `locationName:"code" type:"string"`

	// The category name for the support case.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

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.

func (Category) GoString added in v0.6.5

func (s Category) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Category) SetCode added in v1.5.0

func (s *Category) SetCode(v string) *Category

SetCode sets the Code field's value.

func (*Category) SetName added in v1.5.0

func (s *Category) SetName(v string) *Category

SetName sets the Name field's value.

func (Category) String added in v0.6.5

func (s Category) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Communication

type Communication struct {

	// Information about the attachments to the case communication.
	AttachmentSet []*AttachmentDetails `locationName:"attachmentSet" type:"list"`

	// The text of the communication between the customer and Amazon Web Services
	// Support.
	Body *string `locationName:"body" min:"1" type:"string"`

	// The support case ID requested or returned in the call. The case ID is an
	// alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
	CaseId *string `locationName:"caseId" type:"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) <janedoe@example.com>. Entries from
	// the Amazon Web Services Support team display "Amazon Web Services," and don't
	// show an email address.
	SubmittedBy *string `locationName:"submittedBy" type:"string"`

	// The time the communication was created.
	TimeCreated *string `locationName:"timeCreated" type:"string"`
	// contains filtered or unexported fields
}

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.

func (Communication) GoString added in v0.6.5

func (s Communication) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Communication) SetAttachmentSet added in v1.5.0

func (s *Communication) SetAttachmentSet(v []*AttachmentDetails) *Communication

SetAttachmentSet sets the AttachmentSet field's value.

func (*Communication) SetBody added in v1.5.0

func (s *Communication) SetBody(v string) *Communication

SetBody sets the Body field's value.

func (*Communication) SetCaseId added in v1.5.0

func (s *Communication) SetCaseId(v string) *Communication

SetCaseId sets the CaseId field's value.

func (*Communication) SetSubmittedBy added in v1.5.0

func (s *Communication) SetSubmittedBy(v string) *Communication

SetSubmittedBy sets the SubmittedBy field's value.

func (*Communication) SetTimeCreated added in v1.5.0

func (s *Communication) SetTimeCreated(v string) *Communication

SetTimeCreated sets the TimeCreated field's value.

func (Communication) String added in v0.6.5

func (s Communication) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCaseInput

type CreateCaseInput struct {

	// The ID of a set of one or more attachments for the case. Create the set by
	// using the AddAttachmentsToSet operation.
	AttachmentSetId *string `locationName:"attachmentSetId" type:"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.
	CategoryCode *string `locationName:"categoryCode" type:"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 (http://aws.amazon.com/tools/).
	CcEmailAddresses []*string `locationName:"ccEmailAddresses" type:"list"`

	// The communication body text that describes the issue. This text appears in
	// the Description field on the Amazon Web Services Support Center Create Case
	// (https://console.aws.amazon.com/support/home#/case/create) page.
	//
	// CommunicationBody is a required field
	CommunicationBody *string `locationName:"communicationBody" min:"1" type:"string" required:"true"`

	// The type of issue for the case. You can specify customer-service or technical.
	// If you don't specify a value, the default is technical.
	IssueType *string `locationName:"issueType" type:"string"`

	// 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.
	Language *string `locationName:"language" type:"string"`

	// The code for the Amazon Web Services service. You can use the DescribeServices
	// operation to get the possible serviceCode values.
	ServiceCode *string `locationName:"serviceCode" type:"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 (https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-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.
	SeverityCode *string `locationName:"severityCode" type:"string"`

	// The title of the support case. The title appears in the Subject field on
	// the Amazon Web Services Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create)
	// page.
	//
	// Subject is a required field
	Subject *string `locationName:"subject" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCaseInput) GoString added in v0.6.5

func (s CreateCaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCaseInput) SetAttachmentSetId added in v1.5.0

func (s *CreateCaseInput) SetAttachmentSetId(v string) *CreateCaseInput

SetAttachmentSetId sets the AttachmentSetId field's value.

func (*CreateCaseInput) SetCategoryCode added in v1.5.0

func (s *CreateCaseInput) SetCategoryCode(v string) *CreateCaseInput

SetCategoryCode sets the CategoryCode field's value.

func (*CreateCaseInput) SetCcEmailAddresses added in v1.5.0

func (s *CreateCaseInput) SetCcEmailAddresses(v []*string) *CreateCaseInput

SetCcEmailAddresses sets the CcEmailAddresses field's value.

func (*CreateCaseInput) SetCommunicationBody added in v1.5.0

func (s *CreateCaseInput) SetCommunicationBody(v string) *CreateCaseInput

SetCommunicationBody sets the CommunicationBody field's value.

func (*CreateCaseInput) SetIssueType added in v1.5.0

func (s *CreateCaseInput) SetIssueType(v string) *CreateCaseInput

SetIssueType sets the IssueType field's value.

func (*CreateCaseInput) SetLanguage added in v1.5.0

func (s *CreateCaseInput) SetLanguage(v string) *CreateCaseInput

SetLanguage sets the Language field's value.

func (*CreateCaseInput) SetServiceCode added in v1.5.0

func (s *CreateCaseInput) SetServiceCode(v string) *CreateCaseInput

SetServiceCode sets the ServiceCode field's value.

func (*CreateCaseInput) SetSeverityCode added in v1.5.0

func (s *CreateCaseInput) SetSeverityCode(v string) *CreateCaseInput

SetSeverityCode sets the SeverityCode field's value.

func (*CreateCaseInput) SetSubject added in v1.5.0

func (s *CreateCaseInput) SetSubject(v string) *CreateCaseInput

SetSubject sets the Subject field's value.

func (CreateCaseInput) String added in v0.6.5

func (s CreateCaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCaseInput) Validate added in v1.1.21

func (s *CreateCaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCaseOutput

type CreateCaseOutput struct {

	// 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
	CaseId *string `locationName:"caseId" type:"string"`
	// contains filtered or unexported fields
}

The support case ID returned by a successful completion of the CreateCase operation.

func (CreateCaseOutput) GoString added in v0.6.5

func (s CreateCaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCaseOutput) SetCaseId added in v1.5.0

func (s *CreateCaseOutput) SetCaseId(v string) *CreateCaseOutput

SetCaseId sets the CaseId field's value.

func (CreateCaseOutput) String added in v0.6.5

func (s CreateCaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAttachmentInput

type DescribeAttachmentInput struct {

	// The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications
	// operation.
	//
	// AttachmentId is a required field
	AttachmentId *string `locationName:"attachmentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAttachmentInput) GoString added in v0.6.5

func (s DescribeAttachmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAttachmentInput) SetAttachmentId added in v1.5.0

SetAttachmentId sets the AttachmentId field's value.

func (DescribeAttachmentInput) String added in v0.6.5

func (s DescribeAttachmentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAttachmentInput) Validate added in v1.1.21

func (s *DescribeAttachmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAttachmentLimitExceeded added in v1.28.0

type DescribeAttachmentLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The limit for the number of DescribeAttachment requests in a short period
	// of time has been exceeded.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*DescribeAttachmentLimitExceeded) Code added in v1.28.0

Code returns the exception type name.

func (*DescribeAttachmentLimitExceeded) Error added in v1.28.0

func (DescribeAttachmentLimitExceeded) GoString added in v1.28.0

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAttachmentLimitExceeded) Message added in v1.28.0

Message returns the exception's message.

func (*DescribeAttachmentLimitExceeded) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DescribeAttachmentLimitExceeded) RequestID added in v1.28.0

func (s *DescribeAttachmentLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DescribeAttachmentLimitExceeded) StatusCode added in v1.28.0

func (s *DescribeAttachmentLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DescribeAttachmentLimitExceeded) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAttachmentOutput

type DescribeAttachmentOutput struct {

	// 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.
	Attachment *Attachment `locationName:"attachment" type:"structure"`
	// contains filtered or unexported fields
}

The content and file name of the attachment returned by the DescribeAttachment operation.

func (DescribeAttachmentOutput) GoString added in v0.6.5

func (s DescribeAttachmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAttachmentOutput) SetAttachment added in v1.5.0

SetAttachment sets the Attachment field's value.

func (DescribeAttachmentOutput) String added in v0.6.5

func (s DescribeAttachmentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCasesInput

type DescribeCasesInput struct {

	// The start date for a filtered date search on support case communications.
	// Case communications are available for 12 months after creation.
	AfterTime *string `locationName:"afterTime" type:"string"`

	// The end date for a filtered date search on support case communications. Case
	// communications are available for 12 months after creation.
	BeforeTime *string `locationName:"beforeTime" type:"string"`

	// A list of ID numbers of the support cases you want returned. The maximum
	// number of cases is 100.
	CaseIdList []*string `locationName:"caseIdList" type:"list"`

	// The ID displayed for a case in the Amazon Web Services Support Center user
	// interface.
	DisplayId *string `locationName:"displayId" type:"string"`

	// Specifies whether to include communications in the DescribeCases response.
	// By default, communications are included.
	IncludeCommunications *bool `locationName:"includeCommunications" type:"boolean"`

	// Specifies whether to include resolved support cases in the DescribeCases
	// response. By default, resolved cases aren't included.
	IncludeResolvedCases *bool `locationName:"includeResolvedCases" type:"boolean"`

	// 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.
	Language *string `locationName:"language" type:"string"`

	// The maximum number of results to return before paginating.
	MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`

	// A resumption point for pagination.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCasesInput) GoString added in v0.6.5

func (s DescribeCasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCasesInput) SetAfterTime added in v1.5.0

func (s *DescribeCasesInput) SetAfterTime(v string) *DescribeCasesInput

SetAfterTime sets the AfterTime field's value.

func (*DescribeCasesInput) SetBeforeTime added in v1.5.0

func (s *DescribeCasesInput) SetBeforeTime(v string) *DescribeCasesInput

SetBeforeTime sets the BeforeTime field's value.

func (*DescribeCasesInput) SetCaseIdList added in v1.5.0

func (s *DescribeCasesInput) SetCaseIdList(v []*string) *DescribeCasesInput

SetCaseIdList sets the CaseIdList field's value.

func (*DescribeCasesInput) SetDisplayId added in v1.5.0

func (s *DescribeCasesInput) SetDisplayId(v string) *DescribeCasesInput

SetDisplayId sets the DisplayId field's value.

func (*DescribeCasesInput) SetIncludeCommunications added in v1.5.0

func (s *DescribeCasesInput) SetIncludeCommunications(v bool) *DescribeCasesInput

SetIncludeCommunications sets the IncludeCommunications field's value.

func (*DescribeCasesInput) SetIncludeResolvedCases added in v1.5.0

func (s *DescribeCasesInput) SetIncludeResolvedCases(v bool) *DescribeCasesInput

SetIncludeResolvedCases sets the IncludeResolvedCases field's value.

func (*DescribeCasesInput) SetLanguage added in v1.5.0

func (s *DescribeCasesInput) SetLanguage(v string) *DescribeCasesInput

SetLanguage sets the Language field's value.

func (*DescribeCasesInput) SetMaxResults added in v1.5.0

func (s *DescribeCasesInput) SetMaxResults(v int64) *DescribeCasesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeCasesInput) SetNextToken added in v1.5.0

func (s *DescribeCasesInput) SetNextToken(v string) *DescribeCasesInput

SetNextToken sets the NextToken field's value.

func (DescribeCasesInput) String added in v0.6.5

func (s DescribeCasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCasesInput) Validate added in v1.1.21

func (s *DescribeCasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCasesOutput

type DescribeCasesOutput struct {

	// The details for the cases that match the request.
	Cases []*CaseDetails `locationName:"cases" type:"list"`

	// A resumption point for pagination.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Returns an array of CaseDetails (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) objects and a nextToken that defines a point for pagination in the result set.

func (DescribeCasesOutput) GoString added in v0.6.5

func (s DescribeCasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCasesOutput) SetCases added in v1.5.0

SetCases sets the Cases field's value.

func (*DescribeCasesOutput) SetNextToken added in v1.5.0

func (s *DescribeCasesOutput) SetNextToken(v string) *DescribeCasesOutput

SetNextToken sets the NextToken field's value.

func (DescribeCasesOutput) String added in v0.6.5

func (s DescribeCasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCommunicationsInput

type DescribeCommunicationsInput struct {

	// The start date for a filtered date search on support case communications.
	// Case communications are available for 12 months after creation.
	AfterTime *string `locationName:"afterTime" type:"string"`

	// The end date for a filtered date search on support case communications. Case
	// communications are available for 12 months after creation.
	BeforeTime *string `locationName:"beforeTime" type:"string"`

	// The support case ID requested or returned in the call. The case ID is an
	// alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
	//
	// CaseId is a required field
	CaseId *string `locationName:"caseId" type:"string" required:"true"`

	// The maximum number of results to return before paginating.
	MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`

	// A resumption point for pagination.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCommunicationsInput) GoString added in v0.6.5

func (s DescribeCommunicationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCommunicationsInput) SetAfterTime added in v1.5.0

SetAfterTime sets the AfterTime field's value.

func (*DescribeCommunicationsInput) SetBeforeTime added in v1.5.0

SetBeforeTime sets the BeforeTime field's value.

func (*DescribeCommunicationsInput) SetCaseId added in v1.5.0

SetCaseId sets the CaseId field's value.

func (*DescribeCommunicationsInput) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeCommunicationsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeCommunicationsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCommunicationsInput) Validate added in v1.1.21

func (s *DescribeCommunicationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCommunicationsOutput

type DescribeCommunicationsOutput struct {

	// The communications for the case.
	Communications []*Communication `locationName:"communications" type:"list"`

	// A resumption point for pagination.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The communications returned by the DescribeCommunications operation.

func (DescribeCommunicationsOutput) GoString added in v0.6.5

func (s DescribeCommunicationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCommunicationsOutput) SetCommunications added in v1.5.0

SetCommunications sets the Communications field's value.

func (*DescribeCommunicationsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeCommunicationsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeServicesInput

type DescribeServicesInput struct {

	// 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.
	Language *string `locationName:"language" type:"string"`

	// A JSON-formatted list of service codes available for Amazon Web Services
	// services.
	ServiceCodeList []*string `locationName:"serviceCodeList" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServicesInput) GoString added in v0.6.5

func (s DescribeServicesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServicesInput) SetLanguage added in v1.5.0

SetLanguage sets the Language field's value.

func (*DescribeServicesInput) SetServiceCodeList added in v1.5.0

func (s *DescribeServicesInput) SetServiceCodeList(v []*string) *DescribeServicesInput

SetServiceCodeList sets the ServiceCodeList field's value.

func (DescribeServicesInput) String added in v0.6.5

func (s DescribeServicesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeServicesOutput

type DescribeServicesOutput struct {

	// A JSON-formatted list of Amazon Web Services services.
	Services []*Service `locationName:"services" type:"list"`
	// contains filtered or unexported fields
}

The list of Amazon Web Services services returned by the DescribeServices operation.

func (DescribeServicesOutput) GoString added in v0.6.5

func (s DescribeServicesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServicesOutput) SetServices added in v1.5.0

SetServices sets the Services field's value.

func (DescribeServicesOutput) String added in v0.6.5

func (s DescribeServicesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSeverityLevelsInput

type DescribeSeverityLevelsInput struct {

	// 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.
	Language *string `locationName:"language" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSeverityLevelsInput) GoString added in v0.6.5

func (s DescribeSeverityLevelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSeverityLevelsInput) SetLanguage added in v1.5.0

SetLanguage sets the Language field's value.

func (DescribeSeverityLevelsInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSeverityLevelsOutput

type DescribeSeverityLevelsOutput struct {

	// The available severity levels for the support case. Available severity levels
	// are defined by your service level agreement with Amazon Web Services.
	SeverityLevels []*SeverityLevel `locationName:"severityLevels" type:"list"`
	// contains filtered or unexported fields
}

The list of severity levels returned by the DescribeSeverityLevels operation.

func (DescribeSeverityLevelsOutput) GoString added in v0.6.5

func (s DescribeSeverityLevelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSeverityLevelsOutput) SetSeverityLevels added in v1.5.0

SetSeverityLevels sets the SeverityLevels field's value.

func (DescribeSeverityLevelsOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTrustedAdvisorCheckRefreshStatusesInput

type DescribeTrustedAdvisorCheckRefreshStatusesInput struct {

	// 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.
	//
	// CheckIds is a required field
	CheckIds []*string `locationName:"checkIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTrustedAdvisorCheckRefreshStatusesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckRefreshStatusesInput) SetCheckIds added in v1.5.0

SetCheckIds sets the CheckIds field's value.

func (DescribeTrustedAdvisorCheckRefreshStatusesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckRefreshStatusesInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeTrustedAdvisorCheckRefreshStatusesOutput

type DescribeTrustedAdvisorCheckRefreshStatusesOutput struct {

	// The refresh status of the specified Trusted Advisor checks.
	//
	// Statuses is a required field
	Statuses []*TrustedAdvisorCheckRefreshStatus `locationName:"statuses" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

func (DescribeTrustedAdvisorCheckRefreshStatusesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckRefreshStatusesOutput) SetStatuses added in v1.5.0

SetStatuses sets the Statuses field's value.

func (DescribeTrustedAdvisorCheckRefreshStatusesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTrustedAdvisorCheckResultInput

type DescribeTrustedAdvisorCheckResultInput struct {

	// The unique identifier for the Trusted Advisor check.
	//
	// CheckId is a required field
	CheckId *string `locationName:"checkId" type:"string" required:"true"`

	// 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.
	Language *string `locationName:"language" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTrustedAdvisorCheckResultInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckResultInput) SetCheckId added in v1.5.0

SetCheckId sets the CheckId field's value.

func (*DescribeTrustedAdvisorCheckResultInput) SetLanguage added in v1.5.0

SetLanguage sets the Language field's value.

func (DescribeTrustedAdvisorCheckResultInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckResultInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeTrustedAdvisorCheckResultOutput

type DescribeTrustedAdvisorCheckResultOutput struct {

	// The detailed results of the Trusted Advisor check.
	Result *TrustedAdvisorCheckResult `locationName:"result" type:"structure"`
	// contains filtered or unexported fields
}

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

func (DescribeTrustedAdvisorCheckResultOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckResultOutput) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (DescribeTrustedAdvisorCheckResultOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTrustedAdvisorCheckSummariesInput

type DescribeTrustedAdvisorCheckSummariesInput struct {

	// The IDs of the Trusted Advisor checks.
	//
	// CheckIds is a required field
	CheckIds []*string `locationName:"checkIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTrustedAdvisorCheckSummariesInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckSummariesInput) SetCheckIds added in v1.5.0

SetCheckIds sets the CheckIds field's value.

func (DescribeTrustedAdvisorCheckSummariesInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckSummariesInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeTrustedAdvisorCheckSummariesOutput

type DescribeTrustedAdvisorCheckSummariesOutput struct {

	// The summary information for the requested Trusted Advisor checks.
	//
	// Summaries is a required field
	Summaries []*TrustedAdvisorCheckSummary `locationName:"summaries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

func (DescribeTrustedAdvisorCheckSummariesOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorCheckSummariesOutput) SetSummaries added in v1.5.0

SetSummaries sets the Summaries field's value.

func (DescribeTrustedAdvisorCheckSummariesOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTrustedAdvisorChecksInput

type DescribeTrustedAdvisorChecksInput struct {

	// 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.
	//
	// Language is a required field
	Language *string `locationName:"language" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTrustedAdvisorChecksInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorChecksInput) SetLanguage added in v1.5.0

SetLanguage sets the Language field's value.

func (DescribeTrustedAdvisorChecksInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorChecksInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeTrustedAdvisorChecksOutput

type DescribeTrustedAdvisorChecksOutput struct {

	// Information about all available Trusted Advisor checks.
	//
	// Checks is a required field
	Checks []*TrustedAdvisorCheckDescription `locationName:"checks" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

func (DescribeTrustedAdvisorChecksOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTrustedAdvisorChecksOutput) SetChecks added in v1.5.0

SetChecks sets the Checks field's value.

func (DescribeTrustedAdvisorChecksOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError added in v1.28.0

type InternalServerError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// An internal server error occurred.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal server error occurred.

func (*InternalServerError) Code added in v1.28.0

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error added in v1.28.0

func (s *InternalServerError) Error() string

func (InternalServerError) GoString added in v1.28.0

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message added in v1.28.0

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr added in v1.28.0

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID added in v1.28.0

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode added in v1.28.0

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String added in v1.28.0

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecentCaseCommunications

type RecentCaseCommunications struct {

	// The five most recent communications associated with the case.
	Communications []*Communication `locationName:"communications" type:"list"`

	// A resumption point for pagination.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The five most recent communications associated with the case.

func (RecentCaseCommunications) GoString added in v0.6.5

func (s RecentCaseCommunications) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecentCaseCommunications) SetCommunications added in v1.5.0

SetCommunications sets the Communications field's value.

func (*RecentCaseCommunications) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (RecentCaseCommunications) String added in v0.6.5

func (s RecentCaseCommunications) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RefreshTrustedAdvisorCheckInput

type RefreshTrustedAdvisorCheckInput struct {

	// 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.
	//
	// CheckId is a required field
	CheckId *string `locationName:"checkId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RefreshTrustedAdvisorCheckInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTrustedAdvisorCheckInput) SetCheckId added in v1.5.0

SetCheckId sets the CheckId field's value.

func (RefreshTrustedAdvisorCheckInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTrustedAdvisorCheckInput) Validate added in v1.1.21

func (s *RefreshTrustedAdvisorCheckInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RefreshTrustedAdvisorCheckOutput

type RefreshTrustedAdvisorCheckOutput struct {

	// The current refresh status for a check, including the amount of time until
	// the check is eligible for refresh.
	//
	// Status is a required field
	Status *TrustedAdvisorCheckRefreshStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The current refresh status of a Trusted Advisor check.

func (RefreshTrustedAdvisorCheckOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTrustedAdvisorCheckOutput) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (RefreshTrustedAdvisorCheckOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResolveCaseInput

type ResolveCaseInput struct {

	// 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
	CaseId *string `locationName:"caseId" type:"string"`
	// contains filtered or unexported fields
}

func (ResolveCaseInput) GoString added in v0.6.5

func (s ResolveCaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResolveCaseInput) SetCaseId added in v1.5.0

func (s *ResolveCaseInput) SetCaseId(v string) *ResolveCaseInput

SetCaseId sets the CaseId field's value.

func (ResolveCaseInput) String added in v0.6.5

func (s ResolveCaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResolveCaseOutput

type ResolveCaseOutput struct {

	// The status of the case after the ResolveCase request was processed.
	FinalCaseStatus *string `locationName:"finalCaseStatus" type:"string"`

	// The status of the case when the ResolveCase request was sent.
	InitialCaseStatus *string `locationName:"initialCaseStatus" type:"string"`
	// contains filtered or unexported fields
}

The status of the case returned by the ResolveCase operation.

func (ResolveCaseOutput) GoString added in v0.6.5

func (s ResolveCaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResolveCaseOutput) SetFinalCaseStatus added in v1.5.0

func (s *ResolveCaseOutput) SetFinalCaseStatus(v string) *ResolveCaseOutput

SetFinalCaseStatus sets the FinalCaseStatus field's value.

func (*ResolveCaseOutput) SetInitialCaseStatus added in v1.5.0

func (s *ResolveCaseOutput) SetInitialCaseStatus(v string) *ResolveCaseOutput

SetInitialCaseStatus sets the InitialCaseStatus field's value.

func (ResolveCaseOutput) String added in v0.6.5

func (s ResolveCaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services Support when you call CreateCase.
	Categories []*Category `locationName:"categories" type:"list"`

	// The code for an Amazon Web Services service returned by the DescribeServices
	// response. The name element contains the corresponding friendly name.
	Code *string `locationName:"code" type:"string"`

	// The friendly name for an Amazon Web Services service. The code element contains
	// the corresponding code.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Information about an Amazon Web Services service returned by the DescribeServices operation.

func (Service) GoString added in v0.6.5

func (s Service) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Service) SetCategories added in v1.5.0

func (s *Service) SetCategories(v []*Category) *Service

SetCategories sets the Categories field's value.

func (*Service) SetCode added in v1.5.0

func (s *Service) SetCode(v string) *Service

SetCode sets the Code field's value.

func (*Service) SetName added in v1.5.0

func (s *Service) SetName(v string) *Service

SetName sets the Name field's value.

func (Service) String added in v0.6.5

func (s Service) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SeverityLevel

type SeverityLevel struct {

	// The code for case severity level.
	//
	// Valid values: low | normal | high | urgent | critical
	Code *string `locationName:"code" type:"string"`

	// 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 (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity)
	// in the Amazon Web Services Support User Guide.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

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 Amazon Web Services Support User Guide.

func (SeverityLevel) GoString added in v0.6.5

func (s SeverityLevel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SeverityLevel) SetCode added in v1.5.0

func (s *SeverityLevel) SetCode(v string) *SeverityLevel

SetCode sets the Code field's value.

func (*SeverityLevel) SetName added in v1.5.0

func (s *SeverityLevel) SetName(v string) *SeverityLevel

SetName sets the Name field's value.

func (SeverityLevel) String added in v0.6.5

func (s SeverityLevel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Support

type Support struct {
	*client.Client
}

Support provides the API operation methods for making requests to AWS Support. See this package's package overview docs for details on the service.

Support methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Support

New creates a new instance of the Support client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a Support client from just a session.
svc := support.New(mySession)

// Create a Support client with additional configuration
svc := support.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Support) AddAttachmentsToSet

func (c *Support) AddAttachmentsToSet(input *AddAttachmentsToSetInput) (*AddAttachmentsToSetOutput, error)

AddAttachmentsToSet API operation for AWS Support.

Adds one or more attachments to an attachment set.

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation AddAttachmentsToSet for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSet

func (*Support) AddAttachmentsToSetRequest

func (c *Support) AddAttachmentsToSetRequest(input *AddAttachmentsToSetInput) (req *request.Request, output *AddAttachmentsToSetOutput)

AddAttachmentsToSetRequest generates a "aws/request.Request" representing the client's request for the AddAttachmentsToSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddAttachmentsToSet for more information on using the AddAttachmentsToSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddAttachmentsToSetRequest method.
req, resp := client.AddAttachmentsToSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddAttachmentsToSet

func (*Support) AddAttachmentsToSetWithContext added in v1.8.0

func (c *Support) AddAttachmentsToSetWithContext(ctx aws.Context, input *AddAttachmentsToSetInput, opts ...request.Option) (*AddAttachmentsToSetOutput, error)

AddAttachmentsToSetWithContext is the same as AddAttachmentsToSet with the addition of the ability to pass a context and additional request options.

See AddAttachmentsToSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) AddCommunicationToCase

func (c *Support) AddCommunicationToCase(input *AddCommunicationToCaseInput) (*AddCommunicationToCaseOutput, error)

AddCommunicationToCase API operation for AWS Support.

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation AddCommunicationToCase for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

  • CaseIdNotFound The requested caseId couldn't be located.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddCommunicationToCase

func (*Support) AddCommunicationToCaseRequest

func (c *Support) AddCommunicationToCaseRequest(input *AddCommunicationToCaseInput) (req *request.Request, output *AddCommunicationToCaseOutput)

AddCommunicationToCaseRequest generates a "aws/request.Request" representing the client's request for the AddCommunicationToCase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddCommunicationToCase for more information on using the AddCommunicationToCase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddCommunicationToCaseRequest method.
req, resp := client.AddCommunicationToCaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/AddCommunicationToCase

func (*Support) AddCommunicationToCaseWithContext added in v1.8.0

func (c *Support) AddCommunicationToCaseWithContext(ctx aws.Context, input *AddCommunicationToCaseInput, opts ...request.Option) (*AddCommunicationToCaseOutput, error)

AddCommunicationToCaseWithContext is the same as AddCommunicationToCase with the addition of the ability to pass a context and additional request options.

See AddCommunicationToCase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) CreateCase

func (c *Support) CreateCase(input *CreateCaseInput) (*CreateCaseOutput, error)

CreateCase API operation for AWS Support.

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 (https://console.aws.amazon.com/support/home#/case/create) page.

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

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

The caseId is separate from the displayId that appears in the Amazon Web Services Support Center (https://console.aws.amazon.com/support). Use the DescribeCases operation to get the displayId.

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation CreateCase for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

  • CaseCreationLimitExceeded The case creation limit for the account has been exceeded.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCase

func (*Support) CreateCaseRequest

func (c *Support) CreateCaseRequest(input *CreateCaseInput) (req *request.Request, output *CreateCaseOutput)

CreateCaseRequest generates a "aws/request.Request" representing the client's request for the CreateCase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCase for more information on using the CreateCase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCaseRequest method.
req, resp := client.CreateCaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/CreateCase

func (*Support) CreateCaseWithContext added in v1.8.0

func (c *Support) CreateCaseWithContext(ctx aws.Context, input *CreateCaseInput, opts ...request.Option) (*CreateCaseOutput, error)

CreateCaseWithContext is the same as CreateCase with the addition of the ability to pass a context and additional request options.

See CreateCase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeAttachment

func (c *Support) DescribeAttachment(input *DescribeAttachmentInput) (*DescribeAttachmentOutput, error)

DescribeAttachment API operation for AWS Support.

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeAttachment for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

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

  • AttachmentIdNotFound An attachment with the specified ID could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachment

func (*Support) DescribeAttachmentRequest

func (c *Support) DescribeAttachmentRequest(input *DescribeAttachmentInput) (req *request.Request, output *DescribeAttachmentOutput)

DescribeAttachmentRequest generates a "aws/request.Request" representing the client's request for the DescribeAttachment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAttachment for more information on using the DescribeAttachment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAttachmentRequest method.
req, resp := client.DescribeAttachmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeAttachment

func (*Support) DescribeAttachmentWithContext added in v1.8.0

func (c *Support) DescribeAttachmentWithContext(ctx aws.Context, input *DescribeAttachmentInput, opts ...request.Option) (*DescribeAttachmentOutput, error)

DescribeAttachmentWithContext is the same as DescribeAttachment with the addition of the ability to pass a context and additional request options.

See DescribeAttachment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeCases

func (c *Support) DescribeCases(input *DescribeCasesInput) (*DescribeCasesOutput, error)

DescribeCases API operation for AWS Support.

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:

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeCases for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

  • CaseIdNotFound The requested caseId couldn't be located.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCases

func (*Support) DescribeCasesPages

func (c *Support) DescribeCasesPages(input *DescribeCasesInput, fn func(*DescribeCasesOutput, bool) bool) error

DescribeCasesPages iterates over the pages of a DescribeCases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCases operation.
pageNum := 0
err := client.DescribeCasesPages(params,
    func(page *support.DescribeCasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Support) DescribeCasesPagesWithContext added in v1.8.0

func (c *Support) DescribeCasesPagesWithContext(ctx aws.Context, input *DescribeCasesInput, fn func(*DescribeCasesOutput, bool) bool, opts ...request.Option) error

DescribeCasesPagesWithContext same as DescribeCasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeCasesRequest

func (c *Support) DescribeCasesRequest(input *DescribeCasesInput) (req *request.Request, output *DescribeCasesOutput)

DescribeCasesRequest generates a "aws/request.Request" representing the client's request for the DescribeCases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCases for more information on using the DescribeCases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCasesRequest method.
req, resp := client.DescribeCasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCases

func (*Support) DescribeCasesWithContext added in v1.8.0

func (c *Support) DescribeCasesWithContext(ctx aws.Context, input *DescribeCasesInput, opts ...request.Option) (*DescribeCasesOutput, error)

DescribeCasesWithContext is the same as DescribeCases with the addition of the ability to pass a context and additional request options.

See DescribeCases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeCommunications

func (c *Support) DescribeCommunications(input *DescribeCommunicationsInput) (*DescribeCommunicationsOutput, error)

DescribeCommunications API operation for AWS Support.

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

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

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeCommunications for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

  • CaseIdNotFound The requested caseId couldn't be located.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunications

func (*Support) DescribeCommunicationsPages

func (c *Support) DescribeCommunicationsPages(input *DescribeCommunicationsInput, fn func(*DescribeCommunicationsOutput, bool) bool) error

DescribeCommunicationsPages iterates over the pages of a DescribeCommunications operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCommunications method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCommunications operation.
pageNum := 0
err := client.DescribeCommunicationsPages(params,
    func(page *support.DescribeCommunicationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Support) DescribeCommunicationsPagesWithContext added in v1.8.0

func (c *Support) DescribeCommunicationsPagesWithContext(ctx aws.Context, input *DescribeCommunicationsInput, fn func(*DescribeCommunicationsOutput, bool) bool, opts ...request.Option) error

DescribeCommunicationsPagesWithContext same as DescribeCommunicationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeCommunicationsRequest

func (c *Support) DescribeCommunicationsRequest(input *DescribeCommunicationsInput) (req *request.Request, output *DescribeCommunicationsOutput)

DescribeCommunicationsRequest generates a "aws/request.Request" representing the client's request for the DescribeCommunications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCommunications for more information on using the DescribeCommunications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCommunicationsRequest method.
req, resp := client.DescribeCommunicationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCommunications

func (*Support) DescribeCommunicationsWithContext added in v1.8.0

func (c *Support) DescribeCommunicationsWithContext(ctx aws.Context, input *DescribeCommunicationsInput, opts ...request.Option) (*DescribeCommunicationsOutput, error)

DescribeCommunicationsWithContext is the same as DescribeCommunications with the addition of the ability to pass a context and additional request options.

See DescribeCommunications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeServices

func (c *Support) DescribeServices(input *DescribeServicesInput) (*DescribeServicesOutput, error)

DescribeServices API operation for AWS Support.

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 (https://console.aws.amazon.com/support/home#/case/create) page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeServices for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeServices

func (*Support) DescribeServicesRequest

func (c *Support) DescribeServicesRequest(input *DescribeServicesInput) (req *request.Request, output *DescribeServicesOutput)

DescribeServicesRequest generates a "aws/request.Request" representing the client's request for the DescribeServices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeServices for more information on using the DescribeServices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeServicesRequest method.
req, resp := client.DescribeServicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeServices

func (*Support) DescribeServicesWithContext added in v1.8.0

func (c *Support) DescribeServicesWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...request.Option) (*DescribeServicesOutput, error)

DescribeServicesWithContext is the same as DescribeServices with the addition of the ability to pass a context and additional request options.

See DescribeServices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeSeverityLevels

func (c *Support) DescribeSeverityLevels(input *DescribeSeverityLevelsInput) (*DescribeSeverityLevelsOutput, error)

DescribeSeverityLevels API operation for AWS Support.

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeSeverityLevels for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeSeverityLevels

func (*Support) DescribeSeverityLevelsRequest

func (c *Support) DescribeSeverityLevelsRequest(input *DescribeSeverityLevelsInput) (req *request.Request, output *DescribeSeverityLevelsOutput)

DescribeSeverityLevelsRequest generates a "aws/request.Request" representing the client's request for the DescribeSeverityLevels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSeverityLevels for more information on using the DescribeSeverityLevels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSeverityLevelsRequest method.
req, resp := client.DescribeSeverityLevelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeSeverityLevels

func (*Support) DescribeSeverityLevelsWithContext added in v1.8.0

func (c *Support) DescribeSeverityLevelsWithContext(ctx aws.Context, input *DescribeSeverityLevelsInput, opts ...request.Option) (*DescribeSeverityLevelsOutput, error)

DescribeSeverityLevelsWithContext is the same as DescribeSeverityLevels with the addition of the ability to pass a context and additional request options.

See DescribeSeverityLevels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeTrustedAdvisorCheckRefreshStatuses

DescribeTrustedAdvisorCheckRefreshStatuses API operation for AWS Support.

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

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeTrustedAdvisorCheckRefreshStatuses for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses

func (*Support) DescribeTrustedAdvisorCheckRefreshStatusesRequest

func (c *Support) DescribeTrustedAdvisorCheckRefreshStatusesRequest(input *DescribeTrustedAdvisorCheckRefreshStatusesInput) (req *request.Request, output *DescribeTrustedAdvisorCheckRefreshStatusesOutput)

DescribeTrustedAdvisorCheckRefreshStatusesRequest generates a "aws/request.Request" representing the client's request for the DescribeTrustedAdvisorCheckRefreshStatuses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTrustedAdvisorCheckRefreshStatuses for more information on using the DescribeTrustedAdvisorCheckRefreshStatuses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTrustedAdvisorCheckRefreshStatusesRequest method.
req, resp := client.DescribeTrustedAdvisorCheckRefreshStatusesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses

func (*Support) DescribeTrustedAdvisorCheckRefreshStatusesWithContext added in v1.8.0

func (c *Support) DescribeTrustedAdvisorCheckRefreshStatusesWithContext(ctx aws.Context, input *DescribeTrustedAdvisorCheckRefreshStatusesInput, opts ...request.Option) (*DescribeTrustedAdvisorCheckRefreshStatusesOutput, error)

DescribeTrustedAdvisorCheckRefreshStatusesWithContext is the same as DescribeTrustedAdvisorCheckRefreshStatuses with the addition of the ability to pass a context and additional request options.

See DescribeTrustedAdvisorCheckRefreshStatuses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeTrustedAdvisorCheckResult

func (c *Support) DescribeTrustedAdvisorCheckResult(input *DescribeTrustedAdvisorCheckResultInput) (*DescribeTrustedAdvisorCheckResultOutput, error)

DescribeTrustedAdvisorCheckResult API operation for AWS Support.

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

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

  • TrustedAdvisorCategorySpecificSummary

  • TrustedAdvisorResourceDetail

  • TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

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

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

  • checkId - The unique identifier for the check.

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeTrustedAdvisorCheckResult for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckResult

func (*Support) DescribeTrustedAdvisorCheckResultRequest

func (c *Support) DescribeTrustedAdvisorCheckResultRequest(input *DescribeTrustedAdvisorCheckResultInput) (req *request.Request, output *DescribeTrustedAdvisorCheckResultOutput)

DescribeTrustedAdvisorCheckResultRequest generates a "aws/request.Request" representing the client's request for the DescribeTrustedAdvisorCheckResult operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTrustedAdvisorCheckResult for more information on using the DescribeTrustedAdvisorCheckResult API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTrustedAdvisorCheckResultRequest method.
req, resp := client.DescribeTrustedAdvisorCheckResultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckResult

func (*Support) DescribeTrustedAdvisorCheckResultWithContext added in v1.8.0

func (c *Support) DescribeTrustedAdvisorCheckResultWithContext(ctx aws.Context, input *DescribeTrustedAdvisorCheckResultInput, opts ...request.Option) (*DescribeTrustedAdvisorCheckResultOutput, error)

DescribeTrustedAdvisorCheckResultWithContext is the same as DescribeTrustedAdvisorCheckResult with the addition of the ability to pass a context and additional request options.

See DescribeTrustedAdvisorCheckResult for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeTrustedAdvisorCheckSummaries

func (c *Support) DescribeTrustedAdvisorCheckSummaries(input *DescribeTrustedAdvisorCheckSummariesInput) (*DescribeTrustedAdvisorCheckSummariesOutput, error)

DescribeTrustedAdvisorCheckSummaries API operation for AWS Support.

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

The response contains an array of TrustedAdvisorCheckSummary objects.

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeTrustedAdvisorCheckSummaries for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries

func (*Support) DescribeTrustedAdvisorCheckSummariesRequest

func (c *Support) DescribeTrustedAdvisorCheckSummariesRequest(input *DescribeTrustedAdvisorCheckSummariesInput) (req *request.Request, output *DescribeTrustedAdvisorCheckSummariesOutput)

DescribeTrustedAdvisorCheckSummariesRequest generates a "aws/request.Request" representing the client's request for the DescribeTrustedAdvisorCheckSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTrustedAdvisorCheckSummaries for more information on using the DescribeTrustedAdvisorCheckSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTrustedAdvisorCheckSummariesRequest method.
req, resp := client.DescribeTrustedAdvisorCheckSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries

func (*Support) DescribeTrustedAdvisorCheckSummariesWithContext added in v1.8.0

func (c *Support) DescribeTrustedAdvisorCheckSummariesWithContext(ctx aws.Context, input *DescribeTrustedAdvisorCheckSummariesInput, opts ...request.Option) (*DescribeTrustedAdvisorCheckSummariesOutput, error)

DescribeTrustedAdvisorCheckSummariesWithContext is the same as DescribeTrustedAdvisorCheckSummaries with the addition of the ability to pass a context and additional request options.

See DescribeTrustedAdvisorCheckSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) DescribeTrustedAdvisorChecks

func (c *Support) DescribeTrustedAdvisorChecks(input *DescribeTrustedAdvisorChecksInput) (*DescribeTrustedAdvisorChecksOutput, error)

DescribeTrustedAdvisorChecks API operation for AWS Support.

Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The Amazon Web Services Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation DescribeTrustedAdvisorChecks for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorChecks

func (*Support) DescribeTrustedAdvisorChecksRequest

func (c *Support) DescribeTrustedAdvisorChecksRequest(input *DescribeTrustedAdvisorChecksInput) (req *request.Request, output *DescribeTrustedAdvisorChecksOutput)

DescribeTrustedAdvisorChecksRequest generates a "aws/request.Request" representing the client's request for the DescribeTrustedAdvisorChecks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTrustedAdvisorChecks for more information on using the DescribeTrustedAdvisorChecks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTrustedAdvisorChecksRequest method.
req, resp := client.DescribeTrustedAdvisorChecksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorChecks

func (*Support) DescribeTrustedAdvisorChecksWithContext added in v1.8.0

func (c *Support) DescribeTrustedAdvisorChecksWithContext(ctx aws.Context, input *DescribeTrustedAdvisorChecksInput, opts ...request.Option) (*DescribeTrustedAdvisorChecksOutput, error)

DescribeTrustedAdvisorChecksWithContext is the same as DescribeTrustedAdvisorChecks with the addition of the ability to pass a context and additional request options.

See DescribeTrustedAdvisorChecks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) RefreshTrustedAdvisorCheck

func (c *Support) RefreshTrustedAdvisorCheck(input *RefreshTrustedAdvisorCheckInput) (*RefreshTrustedAdvisorCheckOutput, error)

RefreshTrustedAdvisorCheck API operation for AWS Support.

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

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

The response contains a TrustedAdvisorCheckRefreshStatus object.

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation RefreshTrustedAdvisorCheck for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheck

func (*Support) RefreshTrustedAdvisorCheckRequest

func (c *Support) RefreshTrustedAdvisorCheckRequest(input *RefreshTrustedAdvisorCheckInput) (req *request.Request, output *RefreshTrustedAdvisorCheckOutput)

RefreshTrustedAdvisorCheckRequest generates a "aws/request.Request" representing the client's request for the RefreshTrustedAdvisorCheck operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RefreshTrustedAdvisorCheck for more information on using the RefreshTrustedAdvisorCheck API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RefreshTrustedAdvisorCheckRequest method.
req, resp := client.RefreshTrustedAdvisorCheckRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/RefreshTrustedAdvisorCheck

func (*Support) RefreshTrustedAdvisorCheckWithContext added in v1.8.0

func (c *Support) RefreshTrustedAdvisorCheckWithContext(ctx aws.Context, input *RefreshTrustedAdvisorCheckInput, opts ...request.Option) (*RefreshTrustedAdvisorCheckOutput, error)

RefreshTrustedAdvisorCheckWithContext is the same as RefreshTrustedAdvisorCheck with the addition of the ability to pass a context and additional request options.

See RefreshTrustedAdvisorCheck for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Support) ResolveCase

func (c *Support) ResolveCase(input *ResolveCaseInput) (*ResolveCaseOutput, error)

ResolveCase API operation for AWS Support.

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

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

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Support's API operation ResolveCase for usage and error information.

Returned Error Types:

  • InternalServerError An internal server error occurred.

  • CaseIdNotFound The requested caseId couldn't be located.

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/ResolveCase

func (*Support) ResolveCaseRequest

func (c *Support) ResolveCaseRequest(input *ResolveCaseInput) (req *request.Request, output *ResolveCaseOutput)

ResolveCaseRequest generates a "aws/request.Request" representing the client's request for the ResolveCase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResolveCase for more information on using the ResolveCase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResolveCaseRequest method.
req, resp := client.ResolveCaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/ResolveCase

func (*Support) ResolveCaseWithContext added in v1.8.0

func (c *Support) ResolveCaseWithContext(ctx aws.Context, input *ResolveCaseInput, opts ...request.Option) (*ResolveCaseOutput, error)

ResolveCaseWithContext is the same as ResolveCase with the addition of the ability to pass a context and additional request options.

See ResolveCase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 `locationName:"costOptimizing" type:"structure"`
	// contains filtered or unexported fields
}

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

func (TrustedAdvisorCategorySpecificSummary) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorCategorySpecificSummary) SetCostOptimizing added in v1.5.0

SetCostOptimizing sets the CostOptimizing field's value.

func (TrustedAdvisorCategorySpecificSummary) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrustedAdvisorCheckDescription

type TrustedAdvisorCheckDescription struct {

	// The category of the Trusted Advisor check.
	//
	// Category is a required field
	Category *string `locationName:"category" type:"string" required:"true"`

	// The description of the Trusted Advisor check, which includes the alert criteria
	// and recommended operations (contains HTML markup).
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// The unique identifier for the Trusted Advisor check.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// 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.
	//
	// Metadata is a required field
	Metadata []*string `locationName:"metadata" type:"list" required:"true"`

	// The display name for the Trusted Advisor check.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The description and metadata for a Trusted Advisor check.

func (TrustedAdvisorCheckDescription) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorCheckDescription) SetCategory added in v1.5.0

SetCategory sets the Category field's value.

func (*TrustedAdvisorCheckDescription) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*TrustedAdvisorCheckDescription) SetId added in v1.5.0

SetId sets the Id field's value.

func (*TrustedAdvisorCheckDescription) SetMetadata added in v1.5.0

SetMetadata sets the Metadata field's value.

func (*TrustedAdvisorCheckDescription) SetName added in v1.5.0

SetName sets the Name field's value.

func (TrustedAdvisorCheckDescription) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrustedAdvisorCheckRefreshStatus

type TrustedAdvisorCheckRefreshStatus struct {

	// The unique identifier for the Trusted Advisor check.
	//
	// CheckId is a required field
	CheckId *string `locationName:"checkId" type:"string" required:"true"`

	// The amount of time, in milliseconds, until the Trusted Advisor check is eligible
	// for refresh.
	//
	// MillisUntilNextRefreshable is a required field
	MillisUntilNextRefreshable *int64 `locationName:"millisUntilNextRefreshable" type:"long" required:"true"`

	// 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
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The refresh status of a Trusted Advisor check.

func (TrustedAdvisorCheckRefreshStatus) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorCheckRefreshStatus) SetCheckId added in v1.5.0

SetCheckId sets the CheckId field's value.

func (*TrustedAdvisorCheckRefreshStatus) SetMillisUntilNextRefreshable added in v1.5.0

func (s *TrustedAdvisorCheckRefreshStatus) SetMillisUntilNextRefreshable(v int64) *TrustedAdvisorCheckRefreshStatus

SetMillisUntilNextRefreshable sets the MillisUntilNextRefreshable field's value.

func (*TrustedAdvisorCheckRefreshStatus) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (TrustedAdvisorCheckRefreshStatus) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// CategorySpecificSummary is a required field
	CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary `locationName:"categorySpecificSummary" type:"structure" required:"true"`

	// The unique identifier for the Trusted Advisor check.
	//
	// CheckId is a required field
	CheckId *string `locationName:"checkId" type:"string" required:"true"`

	// The details about each resource listed in the check result.
	//
	// FlaggedResources is a required field
	FlaggedResources []*TrustedAdvisorResourceDetail `locationName:"flaggedResources" type:"list" required:"true"`

	// Details about Amazon Web Services resources that were analyzed in a call
	// to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
	//
	// ResourcesSummary is a required field
	ResourcesSummary *TrustedAdvisorResourcesSummary `locationName:"resourcesSummary" type:"structure" required:"true"`

	// The alert status of the check: "ok" (green), "warning" (yellow), "error"
	// (red), or "not_available".
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`

	// The time of the last refresh of the check.
	//
	// Timestamp is a required field
	Timestamp *string `locationName:"timestamp" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

func (TrustedAdvisorCheckResult) GoString added in v0.6.5

func (s TrustedAdvisorCheckResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorCheckResult) SetCategorySpecificSummary added in v1.5.0

SetCategorySpecificSummary sets the CategorySpecificSummary field's value.

func (*TrustedAdvisorCheckResult) SetCheckId added in v1.5.0

SetCheckId sets the CheckId field's value.

func (*TrustedAdvisorCheckResult) SetFlaggedResources added in v1.5.0

SetFlaggedResources sets the FlaggedResources field's value.

func (*TrustedAdvisorCheckResult) SetResourcesSummary added in v1.5.0

SetResourcesSummary sets the ResourcesSummary field's value.

func (*TrustedAdvisorCheckResult) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*TrustedAdvisorCheckResult) SetTimestamp added in v1.5.0

SetTimestamp sets the Timestamp field's value.

func (TrustedAdvisorCheckResult) String added in v0.6.5

func (s TrustedAdvisorCheckResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// CategorySpecificSummary is a required field
	CategorySpecificSummary *TrustedAdvisorCategorySpecificSummary `locationName:"categorySpecificSummary" type:"structure" required:"true"`

	// The unique identifier for the Trusted Advisor check.
	//
	// CheckId is a required field
	CheckId *string `locationName:"checkId" type:"string" required:"true"`

	// Specifies whether the Trusted Advisor check has flagged resources.
	HasFlaggedResources *bool `locationName:"hasFlaggedResources" type:"boolean"`

	// Details about Amazon Web Services resources that were analyzed in a call
	// to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
	//
	// ResourcesSummary is a required field
	ResourcesSummary *TrustedAdvisorResourcesSummary `locationName:"resourcesSummary" type:"structure" required:"true"`

	// The alert status of the check: "ok" (green), "warning" (yellow), "error"
	// (red), or "not_available".
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`

	// The time of the last refresh of the check.
	//
	// Timestamp is a required field
	Timestamp *string `locationName:"timestamp" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (TrustedAdvisorCheckSummary) GoString added in v0.6.5

func (s TrustedAdvisorCheckSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorCheckSummary) SetCategorySpecificSummary added in v1.5.0

SetCategorySpecificSummary sets the CategorySpecificSummary field's value.

func (*TrustedAdvisorCheckSummary) SetCheckId added in v1.5.0

SetCheckId sets the CheckId field's value.

func (*TrustedAdvisorCheckSummary) SetHasFlaggedResources added in v1.5.0

func (s *TrustedAdvisorCheckSummary) SetHasFlaggedResources(v bool) *TrustedAdvisorCheckSummary

SetHasFlaggedResources sets the HasFlaggedResources field's value.

func (*TrustedAdvisorCheckSummary) SetResourcesSummary added in v1.5.0

SetResourcesSummary sets the ResourcesSummary field's value.

func (*TrustedAdvisorCheckSummary) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*TrustedAdvisorCheckSummary) SetTimestamp added in v1.5.0

SetTimestamp sets the Timestamp field's value.

func (TrustedAdvisorCheckSummary) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrustedAdvisorCostOptimizingSummary

type TrustedAdvisorCostOptimizingSummary struct {

	// The estimated monthly savings that might be realized if the recommended operations
	// are taken.
	//
	// EstimatedMonthlySavings is a required field
	EstimatedMonthlySavings *float64 `locationName:"estimatedMonthlySavings" type:"double" required:"true"`

	// The estimated percentage of savings that might be realized if the recommended
	// operations are taken.
	//
	// EstimatedPercentMonthlySavings is a required field
	EstimatedPercentMonthlySavings *float64 `locationName:"estimatedPercentMonthlySavings" type:"double" required:"true"`
	// contains filtered or unexported fields
}

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

func (TrustedAdvisorCostOptimizingSummary) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorCostOptimizingSummary) SetEstimatedMonthlySavings added in v1.5.0

SetEstimatedMonthlySavings sets the EstimatedMonthlySavings field's value.

func (*TrustedAdvisorCostOptimizingSummary) SetEstimatedPercentMonthlySavings added in v1.5.0

func (s *TrustedAdvisorCostOptimizingSummary) SetEstimatedPercentMonthlySavings(v float64) *TrustedAdvisorCostOptimizingSummary

SetEstimatedPercentMonthlySavings sets the EstimatedPercentMonthlySavings field's value.

func (TrustedAdvisorCostOptimizingSummary) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrustedAdvisorResourceDetail

type TrustedAdvisorResourceDetail struct {

	// Specifies whether the Amazon Web Services resource was ignored by Trusted
	// Advisor because it was marked as suppressed by the user.
	IsSuppressed *bool `locationName:"isSuppressed" type:"boolean"`

	// 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.
	//
	// Metadata is a required field
	Metadata []*string `locationName:"metadata" type:"list" required:"true"`

	// The Amazon Web Services Region in which the identified resource is located.
	Region *string `locationName:"region" type:"string"`

	// The unique identifier for the identified resource.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The status code for the resource identified in the Trusted Advisor check.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (TrustedAdvisorResourceDetail) GoString added in v0.6.5

func (s TrustedAdvisorResourceDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorResourceDetail) SetIsSuppressed added in v1.5.0

SetIsSuppressed sets the IsSuppressed field's value.

func (*TrustedAdvisorResourceDetail) SetMetadata added in v1.5.0

SetMetadata sets the Metadata field's value.

func (*TrustedAdvisorResourceDetail) SetRegion added in v1.5.0

SetRegion sets the Region field's value.

func (*TrustedAdvisorResourceDetail) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*TrustedAdvisorResourceDetail) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (TrustedAdvisorResourceDetail) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrustedAdvisorResourcesSummary

type TrustedAdvisorResourcesSummary struct {

	// The number of Amazon Web Services resources that were flagged (listed) by
	// the Trusted Advisor check.
	//
	// ResourcesFlagged is a required field
	ResourcesFlagged *int64 `locationName:"resourcesFlagged" type:"long" required:"true"`

	// The number of Amazon Web Services resources ignored by Trusted Advisor because
	// information was unavailable.
	//
	// ResourcesIgnored is a required field
	ResourcesIgnored *int64 `locationName:"resourcesIgnored" type:"long" required:"true"`

	// The number of Amazon Web Services resources that were analyzed by the Trusted
	// Advisor check.
	//
	// ResourcesProcessed is a required field
	ResourcesProcessed *int64 `locationName:"resourcesProcessed" type:"long" required:"true"`

	// The number of Amazon Web Services resources ignored by Trusted Advisor because
	// they were marked as suppressed by the user.
	//
	// ResourcesSuppressed is a required field
	ResourcesSuppressed *int64 `locationName:"resourcesSuppressed" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

func (TrustedAdvisorResourcesSummary) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrustedAdvisorResourcesSummary) SetResourcesFlagged added in v1.5.0

SetResourcesFlagged sets the ResourcesFlagged field's value.

func (*TrustedAdvisorResourcesSummary) SetResourcesIgnored added in v1.5.0

SetResourcesIgnored sets the ResourcesIgnored field's value.

func (*TrustedAdvisorResourcesSummary) SetResourcesProcessed added in v1.5.0

SetResourcesProcessed sets the ResourcesProcessed field's value.

func (*TrustedAdvisorResourcesSummary) SetResourcesSuppressed added in v1.5.0

SetResourcesSuppressed sets the ResourcesSuppressed field's value.

func (TrustedAdvisorResourcesSummary) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package supportiface provides an interface to enable mocking the AWS Support service client for testing your code.
Package supportiface provides an interface to enable mocking the AWS Support service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL