support

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2015 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package support provides a client for AWS Support.

Index

Examples

Constants

View Source 
const ServiceName = "support"

A ServiceName is the name of the service the client will make API calls to.

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. The limit is 3 attachments per
	// set, and the size limit is 5 MB per attachment.
	Attachments []*Attachment `locationName:"attachments" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddAttachmentsToSetInput) GoString added in v0.6.6 

func (s AddAttachmentsToSetInput) GoString() string

GoString returns the string representation

func (AddAttachmentsToSetInput) String added in v0.6.6 

func (s AddAttachmentsToSetInput) String() string

String returns the string representation

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

func (s AddAttachmentsToSetOutput) GoString() string

GoString returns the string representation

func (AddAttachmentsToSetOutput) String added in v0.6.6 

func (s AddAttachmentsToSetOutput) String() string

String returns the string representation

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 AWS Support case ID requested or returned in the call. The case ID is
	// an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
	CaseId *string `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 *string `locationName:"communicationBody" type:"string" required:"true"`
	// contains filtered or unexported fields
}

To be written.

func (AddCommunicationToCaseInput) GoString added in v0.6.6 

func (s AddCommunicationToCaseInput) GoString() string

GoString returns the string representation

func (AddCommunicationToCaseInput) String added in v0.6.6 

func (s AddCommunicationToCaseInput) String() string

String returns the string representation

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

func (s AddCommunicationToCaseOutput) GoString() string

GoString returns the string representation

func (AddCommunicationToCaseOutput) String added in v0.6.6 

func (s AddCommunicationToCaseOutput) String() string

String returns the string representation

type Attachment 

type Attachment struct {
	// The content of the attachment file.
	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.6 

func (s Attachment) GoString() string

GoString returns the string representation

func (Attachment) String added in v0.6.6 

func (s Attachment) String() string

String returns the string representation

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

func (s AttachmentDetails) GoString() string

GoString returns the string representation

func (AttachmentDetails) String added in v0.6.6 

func (s AttachmentDetails) String() string

String returns the string representation

type CaseDetails 

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

	// The category of problem for the AWS 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 AWS Support Center. This is a numeric
	// string.
	DisplayId *string `locationName:"displayId" type:"string"`

	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
	// currently supports English ("en") and Japanese ("ja"). Language parameters
	// must be passed explicitly for operations that take them.
	Language *string `locationName:"language" type:"string"`

	// The five most recent communications between you and AWS Support Center, including
	// the IDs of any attachments to the communications. Also includes a nextToken
	// that you can use to retrieve earlier communications.
	RecentCommunications *RecentCaseCommunications `locationName:"recentCommunications" type:"structure"`

	// The code for the AWS service returned by the call to 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.
	Status *string `locationName:"status" type:"string"`

	// The subject line for the case in the AWS 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 case created in the AWS 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 the response from a DescribeCases request. CaseDetails contains the following fields: 

CaseID. The AWS Support case ID requested or returned in the call. The

case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47. 

CategoryCode. The category of problem for the AWS Support case. Corresponds

to the CategoryCode values returned by a call to DescribeServices. DisplayId. The identifier for the case on pages in the AWS Support Center. Language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. RecentCommunications. One or more Communication objects. Fields of these objects are Attachments, Body, CaseId, SubmittedBy, and TimeCreated. NextToken. A resumption point for pagination. ServiceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices. SeverityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. Status. The status of the case in the AWS Support Center. 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.6 

func (s CaseDetails) GoString() string

GoString returns the string representation

func (CaseDetails) String added in v0.6.6 

func (s CaseDetails) String() string

String returns the string representation

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 AWS service.

func (Category) GoString added in v0.6.6 

func (s Category) GoString() string

GoString returns the string representation

func (Category) String added in v0.6.6 

func (s Category) String() string

String returns the string representation

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 AWS Support.
	Body *string `locationName:"body" type:"string"`

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

	// The email address of the account that submitted the AWS Support case.
	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 an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

func (Communication) GoString added in v0.6.6 

func (s Communication) GoString() string

GoString returns the string representation

func (Communication) String added in v0.6.6 

func (s Communication) String() string

String returns the string representation

type CreateCaseInput 

type CreateCaseInput struct {
	// The ID of a set of one or more attachments for the case. Create the set by
	// using AddAttachmentsToSet.
	AttachmentSetId *string `locationName:"attachmentSetId" type:"string"`

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

	// A list of email addresses that AWS Support copies on case correspondence.
	CcEmailAddresses []*string `locationName:"ccEmailAddresses" type:"list"`

	// The communication body text when you create an AWS Support case by calling
	// CreateCase.
	CommunicationBody *string `locationName:"communicationBody" type:"string" required:"true"`

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

	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
	// currently supports English ("en") and Japanese ("ja"). Language parameters
	// must be passed explicitly for operations that take them.
	Language *string `locationName:"language" type:"string"`

	// The code for the AWS service returned by the call to DescribeServices.
	ServiceCode *string `locationName:"serviceCode" type:"string"`

	// The code for the severity level returned by the call to DescribeSeverityLevels.
	//
	// The availability of severity levels depends on each customer's support subscription.
	// In other words, your subscription may not necessarily require the urgent
	// level of response time.
	SeverityCode *string `locationName:"severityCode" type:"string"`

	// The title of the AWS Support case.
	Subject *string `locationName:"subject" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCaseInput) GoString added in v0.6.6 

func (s CreateCaseInput) GoString() string

GoString returns the string representation

func (CreateCaseInput) String added in v0.6.6 

func (s CreateCaseInput) String() string

String returns the string representation

type CreateCaseOutput 

type CreateCaseOutput struct {
	// The AWS Support case ID requested or returned in the call. The case ID is
	// an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
	CaseId *string `locationName:"caseId" type:"string"`
	// contains filtered or unexported fields
}

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

func (CreateCaseOutput) GoString added in v0.6.6 

func (s CreateCaseOutput) GoString() string

GoString returns the string representation

func (CreateCaseOutput) String added in v0.6.6 

func (s CreateCaseOutput) String() string

String returns the string representation

type DescribeAttachmentInput 

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

func (DescribeAttachmentInput) GoString added in v0.6.6 

func (s DescribeAttachmentInput) GoString() string

GoString returns the string representation

func (DescribeAttachmentInput) String added in v0.6.6 

func (s DescribeAttachmentInput) String() string

String returns the string representation

type DescribeAttachmentOutput 

type DescribeAttachmentOutput struct {
	// The attachment content and file name.
	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.6 

func (s DescribeAttachmentOutput) GoString() string

GoString returns the string representation

func (DescribeAttachmentOutput) String added in v0.6.6 

func (s DescribeAttachmentOutput) String() string

String returns the string representation

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 AWS Support Center user interface.
	DisplayId *string `locationName:"displayId" type:"string"`

	// Specifies whether communications should be included in the DescribeCases
	// results. The default is true.
	IncludeCommunications *bool `locationName:"includeCommunications" type:"boolean"`

	// Specifies whether resolved support cases should be included in the DescribeCases
	// results. The default is false.
	IncludeResolvedCases *bool `locationName:"includeResolvedCases" type:"boolean"`

	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
	// currently supports English ("en") and Japanese ("ja"). Language parameters
	// must be passed explicitly for operations that take them.
	Language *string `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.6 

func (s DescribeCasesInput) GoString() string

GoString returns the string representation

func (DescribeCasesInput) String added in v0.6.6 

func (s DescribeCasesInput) String() string

String returns the string representation

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 objects and a NextToken that defines a point for pagination in the result set.

func (DescribeCasesOutput) GoString added in v0.6.6 

func (s DescribeCasesOutput) GoString() string

GoString returns the string representation

func (DescribeCasesOutput) String added in v0.6.6 

func (s DescribeCasesOutput) String() string

String returns the string representation

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 AWS Support case ID requested or returned in the call. The case ID is
	// an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
	CaseId *string `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.6 

func (s DescribeCommunicationsInput) GoString() string

GoString returns the string representation

func (DescribeCommunicationsInput) String added in v0.6.6 

func (s DescribeCommunicationsInput) String() string

String returns the string representation

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

func (s DescribeCommunicationsOutput) GoString() string

GoString returns the string representation

func (DescribeCommunicationsOutput) String added in v0.6.6 

func (s DescribeCommunicationsOutput) String() string

String returns the string representation

type DescribeServicesInput 

type DescribeServicesInput struct {
	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
	// currently supports English ("en") and Japanese ("ja"). Language parameters
	// must be passed explicitly for operations that take them.
	Language *string `locationName:"language" type:"string"`

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

func (DescribeServicesInput) GoString added in v0.6.6 

func (s DescribeServicesInput) GoString() string

GoString returns the string representation

func (DescribeServicesInput) String added in v0.6.6 

func (s DescribeServicesInput) String() string

String returns the string representation

type DescribeServicesOutput 

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

The list of AWS services returned by the DescribeServices operation.

func (DescribeServicesOutput) GoString added in v0.6.6 

func (s DescribeServicesOutput) GoString() string

GoString returns the string representation

func (DescribeServicesOutput) String added in v0.6.6 

func (s DescribeServicesOutput) String() string

String returns the string representation

type DescribeSeverityLevelsInput 

type DescribeSeverityLevelsInput struct {
	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
	// currently supports English ("en") and Japanese ("ja"). Language parameters
	// must be passed explicitly for operations that take them.
	Language *string `locationName:"language" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSeverityLevelsInput) GoString added in v0.6.6 

func (s DescribeSeverityLevelsInput) GoString() string

GoString returns the string representation

func (DescribeSeverityLevelsInput) String added in v0.6.6 

func (s DescribeSeverityLevelsInput) String() string

String returns the string representation

type DescribeSeverityLevelsOutput 

type DescribeSeverityLevelsOutput struct {
	// The available severity levels for the support case. Available severity levels
	// are defined by your service level agreement with AWS.
	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.6 

func (s DescribeSeverityLevelsOutput) GoString() string

GoString returns the string representation

func (DescribeSeverityLevelsOutput) String added in v0.6.6 

func (s DescribeSeverityLevelsOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckRefreshStatusesInput 

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

func (DescribeTrustedAdvisorCheckRefreshStatusesInput) GoString added in v0.6.6 

func (s DescribeTrustedAdvisorCheckRefreshStatusesInput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorCheckRefreshStatusesInput) String added in v0.6.6 

func (s DescribeTrustedAdvisorCheckRefreshStatusesInput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckRefreshStatusesOutput 

type DescribeTrustedAdvisorCheckRefreshStatusesOutput struct {
	// The refresh status of the specified Trusted Advisor checks.
	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.6 

func (s DescribeTrustedAdvisorCheckRefreshStatusesOutput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorCheckRefreshStatusesOutput) String added in v0.6.6 

func (s DescribeTrustedAdvisorCheckRefreshStatusesOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckResultInput 

type DescribeTrustedAdvisorCheckResultInput struct {
	// The unique identifier for the Trusted Advisor check.
	CheckId *string `locationName:"checkId" type:"string" required:"true"`

	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
	// currently supports English ("en") and Japanese ("ja"). Language parameters
	// must be passed explicitly for operations that take them.
	Language *string `locationName:"language" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTrustedAdvisorCheckResultInput) GoString added in v0.6.6 

func (s DescribeTrustedAdvisorCheckResultInput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorCheckResultInput) String added in v0.6.6 

func (s DescribeTrustedAdvisorCheckResultInput) String() string

String returns the string representation

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

func (s DescribeTrustedAdvisorCheckResultOutput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorCheckResultOutput) String added in v0.6.6 

func (s DescribeTrustedAdvisorCheckResultOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckSummariesInput 

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

func (DescribeTrustedAdvisorCheckSummariesInput) GoString added in v0.6.6 

func (s DescribeTrustedAdvisorCheckSummariesInput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorCheckSummariesInput) String added in v0.6.6 

func (s DescribeTrustedAdvisorCheckSummariesInput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckSummariesOutput 

type DescribeTrustedAdvisorCheckSummariesOutput struct {
	// The summary information for the requested Trusted Advisor checks.
	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.6 

func (s DescribeTrustedAdvisorCheckSummariesOutput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorCheckSummariesOutput) String added in v0.6.6 

func (s DescribeTrustedAdvisorCheckSummariesOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorChecksInput 

type DescribeTrustedAdvisorChecksInput struct {
	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
	// currently supports English ("en") and Japanese ("ja"). Language parameters
	// must be passed explicitly for operations that take them.
	Language *string `locationName:"language" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTrustedAdvisorChecksInput) GoString added in v0.6.6 

func (s DescribeTrustedAdvisorChecksInput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorChecksInput) String added in v0.6.6 

func (s DescribeTrustedAdvisorChecksInput) String() string

String returns the string representation

type DescribeTrustedAdvisorChecksOutput 

type DescribeTrustedAdvisorChecksOutput struct {
	// Information about all available Trusted Advisor checks.
	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.6 

func (s DescribeTrustedAdvisorChecksOutput) GoString() string

GoString returns the string representation

func (DescribeTrustedAdvisorChecksOutput) String added in v0.6.6 

func (s DescribeTrustedAdvisorChecksOutput) String() string

String returns the string representation

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

func (s RecentCaseCommunications) GoString() string

GoString returns the string representation

func (RecentCaseCommunications) String added in v0.6.6 

func (s RecentCaseCommunications) String() string

String returns the string representation

type RefreshTrustedAdvisorCheckInput 

type RefreshTrustedAdvisorCheckInput struct {
	// The unique identifier for the Trusted Advisor check.
	CheckId *string `locationName:"checkId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RefreshTrustedAdvisorCheckInput) GoString added in v0.6.6 

func (s RefreshTrustedAdvisorCheckInput) GoString() string

GoString returns the string representation

func (RefreshTrustedAdvisorCheckInput) String added in v0.6.6 

func (s RefreshTrustedAdvisorCheckInput) String() string

String returns the string representation

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 *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.6 

func (s RefreshTrustedAdvisorCheckOutput) GoString() string

GoString returns the string representation

func (RefreshTrustedAdvisorCheckOutput) String added in v0.6.6 

func (s RefreshTrustedAdvisorCheckOutput) String() string

String returns the string representation

type ResolveCaseInput 

type ResolveCaseInput struct {
	// The AWS Support case ID requested or returned in the call. The case ID is
	// an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
	CaseId *string `locationName:"caseId" type:"string"`
	// contains filtered or unexported fields
}

func (ResolveCaseInput) GoString added in v0.6.6 

func (s ResolveCaseInput) GoString() string

GoString returns the string representation

func (ResolveCaseInput) String added in v0.6.6 

func (s ResolveCaseInput) String() string

String returns the string representation

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

func (s ResolveCaseOutput) GoString() string

GoString returns the string representation

func (ResolveCaseOutput) String added in v0.6.6 

func (s ResolveCaseOutput) String() string

String returns the string representation

type Service 

type Service struct {
	// A list of categories that describe the type of support issue a case describes.
	// Categories consist of a category name and a category code. Category names
	// and codes are passed to AWS Support when you call CreateCase.
	Categories []*Category `locationName:"categories" type:"list"`

	// The code for an AWS 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 AWS service. The Code element contains the corresponding
	// code.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Information about an AWS service returned by the DescribeServices operation.

func (Service) GoString added in v0.6.6 

func (s Service) GoString() string

GoString returns the string representation

func (Service) String added in v0.6.6 

func (s Service) String() string

String returns the string representation

type SeverityLevel 

type SeverityLevel struct {
	// One of four values: "low," "medium," "high," and "urgent". These values correspond
	// to response times returned to the caller in SeverityLevel.name.
	Code *string `locationName:"code" type:"string"`

	// The name of the severity level that corresponds to the severity level code.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

A code and name pair that represent a severity level that can be applied to a support case.

func (SeverityLevel) GoString added in v0.6.6 

func (s SeverityLevel) GoString() string

GoString returns the string representation

func (SeverityLevel) String added in v0.6.6 

func (s SeverityLevel) String() string

String returns the string representation

type Support 

type Support struct {
	*client.Client
}

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor (https://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 AWS Support case management operations: 

Service names, issue categories, and available severity levels. The DescribeServices

and DescribeSeverityLevels operations return AWS 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 AWS Support cases, retrieve information about cases, and resolve cases. Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases. The following list describes the operations available from the AWS Support service for Trusted Advisor: 

DescribeTrustedAdvisorChecks returns the list of checks that run against

your AWS resources. Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check 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, AWS Support uses Signature Version 4 Signing Process (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

See About the AWS Support API (http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html) in the AWS 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. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client'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: 

// 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)

Adds one or more attachments to an 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.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.AddAttachmentsToSetInput{
		Attachments: []*support.Attachment{ // Required
			{ // Required
				Data:     []byte("PAYLOAD"),
				FileName: aws.String("FileName"),
			},
			// More values...
		},
		AttachmentSetId: aws.String("AttachmentSetId"),
	}
	resp, err := svc.AddAttachmentsToSet(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) AddAttachmentsToSetRequest 

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

AddAttachmentsToSetRequest generates a request for the AddAttachmentsToSet operation.

func (*Support) AddCommunicationToCase 

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

Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.AddCommunicationToCaseInput{
		CommunicationBody: aws.String("CommunicationBody"), // Required
		AttachmentSetId:   aws.String("AttachmentSetId"),
		CaseId:            aws.String("CaseId"),
		CcEmailAddresses: []*string{
			aws.String("CcEmailAddress"), // Required
			// More values...
		},
	}
	resp, err := svc.AddCommunicationToCase(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) AddCommunicationToCaseRequest 

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

AddCommunicationToCaseRequest generates a request for the AddCommunicationToCase operation.

func (*Support) CreateCase 

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

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) page. Its parameters require you to specify the following information: 

IssueType. The type of issue for the case. You can specify either "customer-service"

or "technical." If you do not indicate a value, the default is "technical." 

ServiceCode. The code for an AWS service. You obtain the ServiceCode by

calling DescribeServices. CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes. SeverityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels. 

Subject. The Subject field on the AWS Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create)

page. CommunicationBody. The Description field on the AWS Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) page. 

AttachmentSetId. The ID of a set of attachments that has been created by

using AddAttachmentsToSet. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported. CcEmailAddresses. The AWS Support Center CC field on the Create Case (https://console.aws.amazon.com/support/home#/case/create) page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK (http://aws.amazon.com/tools/). 

To add additional communication or attachments to an existing case, use

AddCommunicationToCase. 

A successful CreateCase request returns an AWS Support case number. Case

numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.CreateCaseInput{
		CommunicationBody: aws.String("CommunicationBody"), // Required
		Subject:           aws.String("Subject"),           // Required
		AttachmentSetId:   aws.String("AttachmentSetId"),
		CategoryCode:      aws.String("CategoryCode"),
		CcEmailAddresses: []*string{
			aws.String("CcEmailAddress"), // Required
			// More values...
		},
		IssueType:    aws.String("IssueType"),
		Language:     aws.String("Language"),
		ServiceCode:  aws.String("ServiceCode"),
		SeverityCode: aws.String("SeverityCode"),
	}
	resp, err := svc.CreateCase(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) CreateCaseRequest 

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

CreateCaseRequest generates a request for the CreateCase operation.

func (*Support) DescribeAttachment 

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

Returns the attachment that has the specified ID. 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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeAttachmentInput{
		AttachmentId: aws.String("AttachmentId"), // Required
	}
	resp, err := svc.DescribeAttachment(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeAttachmentRequest 

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

DescribeAttachmentRequest generates a request for the DescribeAttachment operation.

func (*Support) DescribeCases 

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

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.

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.

The response returns the following in JSON format: 

One or more CaseDetails data types.  One or more NextToken values, which

specify where to paginate the returned records represented by the CaseDetails objects.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeCasesInput{
		AfterTime:  aws.String("AfterTime"),
		BeforeTime: aws.String("BeforeTime"),
		CaseIdList: []*string{
			aws.String("CaseId"), // Required
			// More values...
		},
		DisplayId:             aws.String("DisplayId"),
		IncludeCommunications: aws.Bool(true),
		IncludeResolvedCases:  aws.Bool(true),
		Language:              aws.String("Language"),
		MaxResults:            aws.Int64(1),
		NextToken:             aws.String("NextToken"),
	}
	resp, err := svc.DescribeCases(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeCasesPages 

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

func (*Support) DescribeCasesRequest 

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

DescribeCasesRequest generates a request for the DescribeCases operation.

func (*Support) DescribeCommunications 

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

Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular 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 result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeCommunicationsInput{
		CaseId:     aws.String("CaseId"), // Required
		AfterTime:  aws.String("AfterTime"),
		BeforeTime: aws.String("BeforeTime"),
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.DescribeCommunications(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeCommunicationsPages 

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

func (*Support) DescribeCommunicationsRequest 

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

DescribeCommunicationsRequest generates a request for the DescribeCommunications operation.

func (*Support) DescribeServices 

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

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeServicesInput{
		Language: aws.String("Language"),
		ServiceCodeList: []*string{
			aws.String("ServiceCode"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeServices(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeServicesRequest 

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

DescribeServicesRequest generates a request for the DescribeServices operation.

func (*Support) DescribeSeverityLevels 

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

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeSeverityLevelsInput{
		Language: aws.String("Language"),
	}
	resp, err := svc.DescribeSeverityLevels(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeSeverityLevelsRequest 

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

DescribeSeverityLevelsRequest generates a request for the DescribeSeverityLevels operation.

func (*Support) DescribeTrustedAdvisorCheckRefreshStatuses 

func (c *Support) DescribeTrustedAdvisorCheckRefreshStatuses(input *DescribeTrustedAdvisorCheckRefreshStatusesInput) (*DescribeTrustedAdvisorCheckRefreshStatusesOutput, error)

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeTrustedAdvisorCheckRefreshStatusesInput{
		CheckIds: []*string{ // Required
			aws.String("String"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeTrustedAdvisorCheckRefreshStatuses(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeTrustedAdvisorCheckRefreshStatusesRequest 

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

DescribeTrustedAdvisorCheckRefreshStatusesRequest generates a request for the DescribeTrustedAdvisorCheckRefreshStatuses operation.

func (*Support) DescribeTrustedAdvisorCheckResult 

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

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

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: "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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeTrustedAdvisorCheckResultInput{
		CheckId:  aws.String("String"), // Required
		Language: aws.String("String"),
	}
	resp, err := svc.DescribeTrustedAdvisorCheckResult(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeTrustedAdvisorCheckResultRequest 

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

DescribeTrustedAdvisorCheckResultRequest generates a request for the DescribeTrustedAdvisorCheckResult operation.

func (*Support) DescribeTrustedAdvisorCheckSummaries 

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

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeTrustedAdvisorCheckSummariesInput{
		CheckIds: []*string{ // Required
			aws.String("String"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeTrustedAdvisorCheckSummaries(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeTrustedAdvisorCheckSummariesRequest 

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

DescribeTrustedAdvisorCheckSummariesRequest generates a request for the DescribeTrustedAdvisorCheckSummaries operation.

func (*Support) DescribeTrustedAdvisorChecks 

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

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.DescribeTrustedAdvisorChecksInput{
		Language: aws.String("String"), // Required
	}
	resp, err := svc.DescribeTrustedAdvisorChecks(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) DescribeTrustedAdvisorChecksRequest 

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

DescribeTrustedAdvisorChecksRequest generates a request for the DescribeTrustedAdvisorChecks operation.

func (*Support) RefreshTrustedAdvisorCheck 

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

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields: 

Status. The refresh status of the check: "none", "enqueued", "processing",

"success", or "abandoned". MillisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh. CheckId. The unique identifier for the check.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.RefreshTrustedAdvisorCheckInput{
		CheckId: aws.String("String"), // Required
	}
	resp, err := svc.RefreshTrustedAdvisorCheck(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) RefreshTrustedAdvisorCheckRequest 

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

RefreshTrustedAdvisorCheckRequest generates a request for the RefreshTrustedAdvisorCheck operation.

func (*Support) ResolveCase 

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

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/support"
)

func main() {
	svc := support.New(session.New())

	params := &support.ResolveCaseInput{
		CaseId: aws.String("CaseId"),
	}
	resp, err := svc.ResolveCase(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Support) ResolveCaseRequest 

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

ResolveCaseRequest generates a request for the ResolveCase operation.

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

func (s TrustedAdvisorCategorySpecificSummary) GoString() string

GoString returns the string representation

func (TrustedAdvisorCategorySpecificSummary) String added in v0.6.6 

func (s TrustedAdvisorCategorySpecificSummary) String() string

String returns the string representation

type TrustedAdvisorCheckDescription 

type TrustedAdvisorCheckDescription struct {
	// The category of the Trusted Advisor check.
	Category *string `locationName:"category" type:"string" required:"true"`

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

	// The unique identifier for the Trusted Advisor check.
	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 []*string `locationName:"metadata" type:"list" required:"true"`

	// The display name for the Trusted Advisor check.
	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.6 

func (s TrustedAdvisorCheckDescription) GoString() string

GoString returns the string representation

func (TrustedAdvisorCheckDescription) String added in v0.6.6 

func (s TrustedAdvisorCheckDescription) String() string

String returns the string representation

type TrustedAdvisorCheckRefreshStatus 

type TrustedAdvisorCheckRefreshStatus struct {
	// The unique identifier for the Trusted Advisor check.
	CheckId *string `locationName:"checkId" type:"string" required:"true"`

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

	// The status of the Trusted Advisor check for which a refresh has been requested:
	// "none", "enqueued", "processing", "success", or "abandoned".
	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.6 

func (s TrustedAdvisorCheckRefreshStatus) GoString() string

GoString returns the string representation

func (TrustedAdvisorCheckRefreshStatus) String added in v0.6.6 

func (s TrustedAdvisorCheckRefreshStatus) String() string

String returns the string representation

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 *TrustedAdvisorCategorySpecificSummary `locationName:"categorySpecificSummary" type:"structure" required:"true"`

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

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

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

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

	// The time of the last refresh of the check.
	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.6 

func (s TrustedAdvisorCheckResult) GoString() string

GoString returns the string representation

func (TrustedAdvisorCheckResult) String added in v0.6.6 

func (s TrustedAdvisorCheckResult) String() string

String returns the string representation

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 *TrustedAdvisorCategorySpecificSummary `locationName:"categorySpecificSummary" type:"structure" required:"true"`

	// The unique identifier for the Trusted Advisor check.
	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 AWS resources that were analyzed in a call to Trusted Advisor
	// DescribeTrustedAdvisorCheckSummaries.
	ResourcesSummary *TrustedAdvisorResourcesSummary `locationName:"resourcesSummary" type:"structure" required:"true"`

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

	// The time of the last refresh of the check.
	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.6 

func (s TrustedAdvisorCheckSummary) GoString() string

GoString returns the string representation

func (TrustedAdvisorCheckSummary) String added in v0.6.6 

func (s TrustedAdvisorCheckSummary) String() string

String returns the string representation

type TrustedAdvisorCostOptimizingSummary 

type TrustedAdvisorCostOptimizingSummary struct {
	// The estimated monthly savings that might be realized if the recommended actions
	// are taken.
	EstimatedMonthlySavings *float64 `locationName:"estimatedMonthlySavings" type:"double" required:"true"`

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

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

func (TrustedAdvisorCostOptimizingSummary) GoString added in v0.6.6 

func (s TrustedAdvisorCostOptimizingSummary) GoString() string

GoString returns the string representation

func (TrustedAdvisorCostOptimizingSummary) String added in v0.6.6 

func (s TrustedAdvisorCostOptimizingSummary) String() string

String returns the string representation

type TrustedAdvisorResourceDetail 

type TrustedAdvisorResourceDetail struct {
	// Specifies whether the AWS 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 []*string `locationName:"metadata" type:"list" required:"true"`

	// The AWS region in which the identified resource is located.
	Region *string `locationName:"region" type:"string" required:"true"`

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

	// The status code for the resource identified in the Trusted Advisor check.
	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.6 

func (s TrustedAdvisorResourceDetail) GoString() string

GoString returns the string representation

func (TrustedAdvisorResourceDetail) String added in v0.6.6 

func (s TrustedAdvisorResourceDetail) String() string

String returns the string representation

type TrustedAdvisorResourcesSummary 

type TrustedAdvisorResourcesSummary struct {
	// The number of AWS resources that were flagged (listed) by the Trusted Advisor
	// check.
	ResourcesFlagged *int64 `locationName:"resourcesFlagged" type:"long" required:"true"`

	// The number of AWS resources ignored by Trusted Advisor because information
	// was unavailable.
	ResourcesIgnored *int64 `locationName:"resourcesIgnored" type:"long" required:"true"`

	// The number of AWS resources that were analyzed by the Trusted Advisor check.
	ResourcesProcessed *int64 `locationName:"resourcesProcessed" type:"long" required:"true"`

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

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

func (TrustedAdvisorResourcesSummary) GoString added in v0.6.6 

func (s TrustedAdvisorResourcesSummary) GoString() string

GoString returns the string representation

func (TrustedAdvisorResourcesSummary) String added in v0.6.6 

func (s TrustedAdvisorResourcesSummary) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package supportiface provides an interface for the AWS Support.
 Package supportiface provides an interface for the AWS Support.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.