support

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 6 Imported by: 34

Documentation

Overview

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

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.

  • You must have a Business or Enterprise support plan to use the AWS Support API.

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

The AWS Support service also exposes a set of AWS 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 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 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, AWS Support uses Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

See About the AWS Support API (https://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.

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 use 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 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 (
	ServiceName = "AWS Support" // Service's name
	ServiceID   = "Support"     // Service's identifier
	EndpointsID = "support"     // Service's Endpoint identifier
)
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 could not 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"
)

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

func (s AddAttachmentsToSetInput) String() string

String returns the string representation

func (*AddAttachmentsToSetInput) Validate 

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

func (s AddAttachmentsToSetOutput) String() string

String returns the string representation

type AddAttachmentsToSetRequest 

type AddAttachmentsToSetRequest struct {
	*aws.Request
	Input *AddAttachmentsToSetInput
	Copy  func(*AddAttachmentsToSetInput) AddAttachmentsToSetRequest
}

AddAttachmentsToSetRequest is the request type for the AddAttachmentsToSet API operation.

func (AddAttachmentsToSetRequest) Send 

func (r AddAttachmentsToSetRequest) Send(ctx context.Context) (*AddAttachmentsToSetResponse, error)

Send marshals and sends the AddAttachmentsToSet API request.

type AddAttachmentsToSetResponse added in v0.9.0 

type AddAttachmentsToSetResponse struct {
	*AddAttachmentsToSetOutput
	// contains filtered or unexported fields
}

AddAttachmentsToSetResponse is the response type for the AddAttachmentsToSet API operation.

func (*AddAttachmentsToSetResponse) SDKResponseMetdata added in v0.9.0 

func (r *AddAttachmentsToSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddAttachmentsToSet request.

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

func (AddCommunicationToCaseInput) String 

func (s AddCommunicationToCaseInput) String() string

String returns the string representation

func (*AddCommunicationToCaseInput) Validate 

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

func (s AddCommunicationToCaseOutput) String() string

String returns the string representation

type AddCommunicationToCaseRequest 

type AddCommunicationToCaseRequest struct {
	*aws.Request
	Input *AddCommunicationToCaseInput
	Copy  func(*AddCommunicationToCaseInput) AddCommunicationToCaseRequest
}

AddCommunicationToCaseRequest is the request type for the AddCommunicationToCase API operation.

func (AddCommunicationToCaseRequest) Send 

func (r AddCommunicationToCaseRequest) Send(ctx context.Context) (*AddCommunicationToCaseResponse, error)

Send marshals and sends the AddCommunicationToCase API request.

type AddCommunicationToCaseResponse added in v0.9.0 

type AddCommunicationToCaseResponse struct {
	*AddCommunicationToCaseOutput
	// contains filtered or unexported fields
}

AddCommunicationToCaseResponse is the response type for the AddCommunicationToCase API operation.

func (*AddCommunicationToCaseResponse) SDKResponseMetdata added in v0.9.0 

func (r *AddCommunicationToCaseResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddCommunicationToCase request.

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

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

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. 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 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 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 in the response from a DescribeCases request. CaseDetails contains the following fields:

  • caseId. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.

  • categoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

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

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

  • nextToken. A resumption point for pagination.

  • recentCommunications. One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.

  • serviceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.

  • severityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.

  • status. The status of the case in the AWS Support Center. Valid values: opened pending-customer-action reopened resolved unassigned work-in-progress

  • subject. The subject line of the case.

  • submittedBy. The email address of the account that submitted the case.

  • timeCreated. The time the case was created, in ISO-8601 format.

func (CaseDetails) String 

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

func (s Category) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := support.New(myConfig)

func (*Client) AddAttachmentsToSetRequest added in v0.9.0 

func (c *Client) AddAttachmentsToSetRequest(input *AddAttachmentsToSetInput) AddAttachmentsToSetRequest

AddAttachmentsToSetRequest returns a request value for making 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using AddAttachmentsToSetRequest. req := client.AddAttachmentsToSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) AddCommunicationToCaseRequest added in v0.9.0 

func (c *Client) AddCommunicationToCaseRequest(input *AddCommunicationToCaseInput) AddCommunicationToCaseRequest

AddCommunicationToCaseRequest returns a request value for making API operation for AWS Support.

Adds additional customer communication to an AWS 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using AddCommunicationToCaseRequest. req := client.AddCommunicationToCaseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) CreateCaseRequest added in v0.9.0 

func (c *Client) CreateCaseRequest(input *CreateCaseInput) CreateCaseRequest

CreateCaseRequest returns a request value for making API operation for AWS Support.

Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) page.

The AWS 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 AWS Support case number. You can use the DescribeCases operation and specify the case number to get existing AWS 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 AWS Support Center (https://console.aws.amazon.com/support). Use the DescribeCases operation to get the displayId.

  • You must have a Business or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using CreateCaseRequest. req := client.CreateCaseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeAttachmentRequest added in v0.9.0 

func (c *Client) DescribeAttachmentRequest(input *DescribeAttachmentInput) DescribeAttachmentRequest

DescribeAttachmentRequest returns a request value for making 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeAttachmentRequest. req := client.DescribeAttachmentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeCasesRequest added in v0.9.0 

func (c *Client) DescribeCasesRequest(input *DescribeCasesInput) DescribeCasesRequest

DescribeCasesRequest returns a request value for making 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeCasesRequest. req := client.DescribeCasesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeCommunicationsRequest added in v0.9.0 

func (c *Client) DescribeCommunicationsRequest(input *DescribeCommunicationsInput) DescribeCommunicationsRequest

DescribeCommunicationsRequest returns a request value for making 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeCommunicationsRequest. req := client.DescribeCommunicationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeServicesRequest added in v0.9.0 

func (c *Client) DescribeServicesRequest(input *DescribeServicesInput) DescribeServicesRequest

DescribeServicesRequest returns a request value for making API operation for AWS Support.

Returns the current list of AWS services and a list of service categories for each service. 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 appear in the Service and Category lists on the AWS 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeServicesRequest. req := client.DescribeServicesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeSeverityLevelsRequest added in v0.9.0 

func (c *Client) DescribeSeverityLevelsRequest(input *DescribeSeverityLevelsInput) DescribeSeverityLevelsRequest

DescribeSeverityLevelsRequest returns a request value for making API operation for AWS Support.

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 that you include for a CreateCase request.

  • You must have a Business or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeSeverityLevelsRequest. req := client.DescribeSeverityLevelsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeTrustedAdvisorCheckRefreshStatusesRequest added in v0.9.0 

func (c *Client) DescribeTrustedAdvisorCheckRefreshStatusesRequest(input *DescribeTrustedAdvisorCheckRefreshStatusesInput) DescribeTrustedAdvisorCheckRefreshStatusesRequest

DescribeTrustedAdvisorCheckRefreshStatusesRequest returns a request value for making API operation for AWS Support.

Returns the refresh status of the AWS 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeTrustedAdvisorCheckRefreshStatusesRequest. req := client.DescribeTrustedAdvisorCheckRefreshStatusesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeTrustedAdvisorCheckResultRequest added in v0.9.0 

func (c *Client) DescribeTrustedAdvisorCheckResultRequest(input *DescribeTrustedAdvisorCheckResultInput) DescribeTrustedAdvisorCheckResultRequest

DescribeTrustedAdvisorCheckResultRequest returns a request value for making API operation for AWS Support.

Returns the results of the AWS 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: "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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeTrustedAdvisorCheckResultRequest. req := client.DescribeTrustedAdvisorCheckResultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeTrustedAdvisorCheckSummariesRequest added in v0.9.0 

func (c *Client) DescribeTrustedAdvisorCheckSummariesRequest(input *DescribeTrustedAdvisorCheckSummariesInput) DescribeTrustedAdvisorCheckSummariesRequest

DescribeTrustedAdvisorCheckSummariesRequest returns a request value for making API operation for AWS Support.

Returns the results for the AWS 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeTrustedAdvisorCheckSummariesRequest. req := client.DescribeTrustedAdvisorCheckSummariesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) DescribeTrustedAdvisorChecksRequest added in v0.9.0 

func (c *Client) DescribeTrustedAdvisorChecksRequest(input *DescribeTrustedAdvisorChecksInput) DescribeTrustedAdvisorChecksRequest

DescribeTrustedAdvisorChecksRequest returns a request value for making API operation for AWS Support.

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

  • You must have a Business or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using DescribeTrustedAdvisorChecksRequest. req := client.DescribeTrustedAdvisorChecksRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) RefreshTrustedAdvisorCheckRequest added in v0.9.0 

func (c *Client) RefreshTrustedAdvisorCheckRequest(input *RefreshTrustedAdvisorCheckInput) RefreshTrustedAdvisorCheckRequest

RefreshTrustedAdvisorCheckRequest returns a request value for making API operation for AWS Support.

Refreshes the AWS 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using RefreshTrustedAdvisorCheckRequest. req := client.RefreshTrustedAdvisorCheckRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) ResolveCaseRequest added in v0.9.0 

func (c *Client) ResolveCaseRequest(input *ResolveCaseInput) ResolveCaseRequest

ResolveCaseRequest returns a request value for making 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 or Enterprise support plan to use the AWS Support API.

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

    // Example sending a request using ResolveCaseRequest. req := client.ResolveCaseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

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" min:"1" 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 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) <someone@example.com>. Entries from
	// the AWS Support team display "Amazon Web Services," and do not 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 an AWS Support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

func (Communication) String 

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

	// The category of problem for the AWS Support case. You also use the DescribeServices
	// operation to get the category code for a service. Each AWS service defines
	// its own set of category codes.
	CategoryCode *string `locationName:"categoryCode" type:"string"`

	// A list of email addresses that AWS Support copies on case correspondence.
	// AWS Support identifies the account that creates the case when you specify
	// your AWS credentials in an HTTP POST method or use the AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Support User Guide.
	//
	// The availability of severity levels depends on the support plan for the AWS
	// account.
	SeverityCode *string `locationName:"severityCode" type:"string"`

	// The title of the AWS Support case. The title appears in the Subject field
	// on the AWS 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) String 

func (s CreateCaseInput) String() string

String returns the string representation

func (*CreateCaseInput) Validate 

func (s *CreateCaseInput) Validate() error

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

type CreateCaseOutput 

type CreateCaseOutput struct {

	// The AWS 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 AWS Support case ID returned by a successful completion of the CreateCase operation.

func (CreateCaseOutput) String 

func (s CreateCaseOutput) String() string

String returns the string representation

type CreateCaseRequest 

type CreateCaseRequest struct {
	*aws.Request
	Input *CreateCaseInput
	Copy  func(*CreateCaseInput) CreateCaseRequest
}

CreateCaseRequest is the request type for the CreateCase API operation.

func (CreateCaseRequest) Send 

func (r CreateCaseRequest) Send(ctx context.Context) (*CreateCaseResponse, error)

Send marshals and sends the CreateCase API request.

type CreateCaseResponse added in v0.9.0 

type CreateCaseResponse struct {
	*CreateCaseOutput
	// contains filtered or unexported fields
}

CreateCaseResponse is the response type for the CreateCase API operation.

func (*CreateCaseResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateCaseResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCase request.

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

func (s DescribeAttachmentInput) String() string

String returns the string representation

func (*DescribeAttachmentInput) Validate 

func (s *DescribeAttachmentInput) Validate() error

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

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

func (s DescribeAttachmentOutput) String() string

String returns the string representation

type DescribeAttachmentRequest 

type DescribeAttachmentRequest struct {
	*aws.Request
	Input *DescribeAttachmentInput
	Copy  func(*DescribeAttachmentInput) DescribeAttachmentRequest
}

DescribeAttachmentRequest is the request type for the DescribeAttachment API operation.

func (DescribeAttachmentRequest) Send 

func (r DescribeAttachmentRequest) Send(ctx context.Context) (*DescribeAttachmentResponse, error)

Send marshals and sends the DescribeAttachment API request.

type DescribeAttachmentResponse added in v0.9.0 

type DescribeAttachmentResponse struct {
	*DescribeAttachmentOutput
	// contains filtered or unexported fields
}

DescribeAttachmentResponse is the response type for the DescribeAttachment API operation.

func (*DescribeAttachmentResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeAttachmentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAttachment request.

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 to include communications in the DescribeCases response.
	// By default, communications are incuded.
	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 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) String 

func (s DescribeCasesInput) String() string

String returns the string representation

func (*DescribeCasesInput) Validate 

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

func (s DescribeCasesOutput) String() string

String returns the string representation

type DescribeCasesPaginator added in v0.9.0 

type DescribeCasesPaginator struct {
	aws.Pager
}

DescribeCasesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCasesPaginator added in v0.9.0 

func NewDescribeCasesPaginator(req DescribeCasesRequest) DescribeCasesPaginator

NewDescribeCasesRequestPaginator returns a paginator for DescribeCases. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeCasesRequest(input)
p := support.NewDescribeCasesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCasesPaginator) CurrentPage added in v0.9.0 

func (p *DescribeCasesPaginator) CurrentPage() *DescribeCasesOutput

type DescribeCasesRequest 

type DescribeCasesRequest struct {
	*aws.Request
	Input *DescribeCasesInput
	Copy  func(*DescribeCasesInput) DescribeCasesRequest
}

DescribeCasesRequest is the request type for the DescribeCases API operation.

func (DescribeCasesRequest) Send 

func (r DescribeCasesRequest) Send(ctx context.Context) (*DescribeCasesResponse, error)

Send marshals and sends the DescribeCases API request.

type DescribeCasesResponse added in v0.9.0 

type DescribeCasesResponse struct {
	*DescribeCasesOutput
	// contains filtered or unexported fields
}

DescribeCasesResponse is the response type for the DescribeCases API operation.

func (*DescribeCasesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeCasesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCases request.

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

func (s DescribeCommunicationsInput) String() string

String returns the string representation

func (*DescribeCommunicationsInput) Validate 

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

func (s DescribeCommunicationsOutput) String() string

String returns the string representation

type DescribeCommunicationsPaginator added in v0.9.0 

type DescribeCommunicationsPaginator struct {
	aws.Pager
}

DescribeCommunicationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCommunicationsPaginator added in v0.9.0 

func NewDescribeCommunicationsPaginator(req DescribeCommunicationsRequest) DescribeCommunicationsPaginator

NewDescribeCommunicationsRequestPaginator returns a paginator for DescribeCommunications. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeCommunicationsRequest(input)
p := support.NewDescribeCommunicationsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCommunicationsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeCommunicationsPaginator) CurrentPage() *DescribeCommunicationsOutput

type DescribeCommunicationsRequest 

type DescribeCommunicationsRequest struct {
	*aws.Request
	Input *DescribeCommunicationsInput
	Copy  func(*DescribeCommunicationsInput) DescribeCommunicationsRequest
}

DescribeCommunicationsRequest is the request type for the DescribeCommunications API operation.

func (DescribeCommunicationsRequest) Send 

func (r DescribeCommunicationsRequest) Send(ctx context.Context) (*DescribeCommunicationsResponse, error)

Send marshals and sends the DescribeCommunications API request.

type DescribeCommunicationsResponse added in v0.9.0 

type DescribeCommunicationsResponse struct {
	*DescribeCommunicationsOutput
	// contains filtered or unexported fields
}

DescribeCommunicationsResponse is the response type for the DescribeCommunications API operation.

func (*DescribeCommunicationsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeCommunicationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCommunications request.

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

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

func (s DescribeServicesOutput) String() string

String returns the string representation

type DescribeServicesRequest 

type DescribeServicesRequest struct {
	*aws.Request
	Input *DescribeServicesInput
	Copy  func(*DescribeServicesInput) DescribeServicesRequest
}

DescribeServicesRequest is the request type for the DescribeServices API operation.

func (DescribeServicesRequest) Send 

func (r DescribeServicesRequest) Send(ctx context.Context) (*DescribeServicesResponse, error)

Send marshals and sends the DescribeServices API request.

type DescribeServicesResponse added in v0.9.0 

type DescribeServicesResponse struct {
	*DescribeServicesOutput
	// contains filtered or unexported fields
}

DescribeServicesResponse is the response type for the DescribeServices API operation.

func (*DescribeServicesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeServicesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeServices request.

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

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

func (s DescribeSeverityLevelsOutput) String() string

String returns the string representation

type DescribeSeverityLevelsRequest 

type DescribeSeverityLevelsRequest struct {
	*aws.Request
	Input *DescribeSeverityLevelsInput
	Copy  func(*DescribeSeverityLevelsInput) DescribeSeverityLevelsRequest
}

DescribeSeverityLevelsRequest is the request type for the DescribeSeverityLevels API operation.

func (DescribeSeverityLevelsRequest) Send 

func (r DescribeSeverityLevelsRequest) Send(ctx context.Context) (*DescribeSeverityLevelsResponse, error)

Send marshals and sends the DescribeSeverityLevels API request.

type DescribeSeverityLevelsResponse added in v0.9.0 

type DescribeSeverityLevelsResponse struct {
	*DescribeSeverityLevelsOutput
	// contains filtered or unexported fields
}

DescribeSeverityLevelsResponse is the response type for the DescribeSeverityLevels API operation.

func (*DescribeSeverityLevelsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeSeverityLevelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSeverityLevels request.

type DescribeTrustedAdvisorCheckRefreshStatusesInput 

type DescribeTrustedAdvisorCheckRefreshStatusesInput struct {

	// The IDs of the Trusted Advisor checks to get the status of.
	//
	// 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) String 

func (s DescribeTrustedAdvisorCheckRefreshStatusesInput) String() string

String returns the string representation

func (*DescribeTrustedAdvisorCheckRefreshStatusesInput) Validate 

func (s *DescribeTrustedAdvisorCheckRefreshStatusesInput) Validate() error

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

func (s DescribeTrustedAdvisorCheckRefreshStatusesOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckRefreshStatusesRequest 

type DescribeTrustedAdvisorCheckRefreshStatusesRequest struct {
	*aws.Request
	Input *DescribeTrustedAdvisorCheckRefreshStatusesInput
	Copy  func(*DescribeTrustedAdvisorCheckRefreshStatusesInput) DescribeTrustedAdvisorCheckRefreshStatusesRequest
}

DescribeTrustedAdvisorCheckRefreshStatusesRequest is the request type for the DescribeTrustedAdvisorCheckRefreshStatuses API operation.

func (DescribeTrustedAdvisorCheckRefreshStatusesRequest) Send 

func (r DescribeTrustedAdvisorCheckRefreshStatusesRequest) Send(ctx context.Context) (*DescribeTrustedAdvisorCheckRefreshStatusesResponse, error)

Send marshals and sends the DescribeTrustedAdvisorCheckRefreshStatuses API request.

type DescribeTrustedAdvisorCheckRefreshStatusesResponse added in v0.9.0 

type DescribeTrustedAdvisorCheckRefreshStatusesResponse struct {
	*DescribeTrustedAdvisorCheckRefreshStatusesOutput
	// contains filtered or unexported fields
}

DescribeTrustedAdvisorCheckRefreshStatusesResponse is the response type for the DescribeTrustedAdvisorCheckRefreshStatuses API operation.

func (*DescribeTrustedAdvisorCheckRefreshStatusesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeTrustedAdvisorCheckRefreshStatusesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTrustedAdvisorCheckRefreshStatuses request.

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

func (s DescribeTrustedAdvisorCheckResultInput) String() string

String returns the string representation

func (*DescribeTrustedAdvisorCheckResultInput) Validate 

func (s *DescribeTrustedAdvisorCheckResultInput) Validate() error

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

func (s DescribeTrustedAdvisorCheckResultOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckResultRequest 

type DescribeTrustedAdvisorCheckResultRequest struct {
	*aws.Request
	Input *DescribeTrustedAdvisorCheckResultInput
	Copy  func(*DescribeTrustedAdvisorCheckResultInput) DescribeTrustedAdvisorCheckResultRequest
}

DescribeTrustedAdvisorCheckResultRequest is the request type for the DescribeTrustedAdvisorCheckResult API operation.

func (DescribeTrustedAdvisorCheckResultRequest) Send 

func (r DescribeTrustedAdvisorCheckResultRequest) Send(ctx context.Context) (*DescribeTrustedAdvisorCheckResultResponse, error)

Send marshals and sends the DescribeTrustedAdvisorCheckResult API request.

type DescribeTrustedAdvisorCheckResultResponse added in v0.9.0 

type DescribeTrustedAdvisorCheckResultResponse struct {
	*DescribeTrustedAdvisorCheckResultOutput
	// contains filtered or unexported fields
}

DescribeTrustedAdvisorCheckResultResponse is the response type for the DescribeTrustedAdvisorCheckResult API operation.

func (*DescribeTrustedAdvisorCheckResultResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeTrustedAdvisorCheckResultResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTrustedAdvisorCheckResult request.

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

func (s DescribeTrustedAdvisorCheckSummariesInput) String() string

String returns the string representation

func (*DescribeTrustedAdvisorCheckSummariesInput) Validate 

func (s *DescribeTrustedAdvisorCheckSummariesInput) Validate() error

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

func (s DescribeTrustedAdvisorCheckSummariesOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorCheckSummariesRequest 

type DescribeTrustedAdvisorCheckSummariesRequest struct {
	*aws.Request
	Input *DescribeTrustedAdvisorCheckSummariesInput
	Copy  func(*DescribeTrustedAdvisorCheckSummariesInput) DescribeTrustedAdvisorCheckSummariesRequest
}

DescribeTrustedAdvisorCheckSummariesRequest is the request type for the DescribeTrustedAdvisorCheckSummaries API operation.

func (DescribeTrustedAdvisorCheckSummariesRequest) Send 

func (r DescribeTrustedAdvisorCheckSummariesRequest) Send(ctx context.Context) (*DescribeTrustedAdvisorCheckSummariesResponse, error)

Send marshals and sends the DescribeTrustedAdvisorCheckSummaries API request.

type DescribeTrustedAdvisorCheckSummariesResponse added in v0.9.0 

type DescribeTrustedAdvisorCheckSummariesResponse struct {
	*DescribeTrustedAdvisorCheckSummariesOutput
	// contains filtered or unexported fields
}

DescribeTrustedAdvisorCheckSummariesResponse is the response type for the DescribeTrustedAdvisorCheckSummaries API operation.

func (*DescribeTrustedAdvisorCheckSummariesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeTrustedAdvisorCheckSummariesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTrustedAdvisorCheckSummaries request.

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

func (DescribeTrustedAdvisorChecksInput) String 

func (s DescribeTrustedAdvisorChecksInput) String() string

String returns the string representation

func (*DescribeTrustedAdvisorChecksInput) Validate 

func (s *DescribeTrustedAdvisorChecksInput) Validate() error

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

func (s DescribeTrustedAdvisorChecksOutput) String() string

String returns the string representation

type DescribeTrustedAdvisorChecksRequest 

type DescribeTrustedAdvisorChecksRequest struct {
	*aws.Request
	Input *DescribeTrustedAdvisorChecksInput
	Copy  func(*DescribeTrustedAdvisorChecksInput) DescribeTrustedAdvisorChecksRequest
}

DescribeTrustedAdvisorChecksRequest is the request type for the DescribeTrustedAdvisorChecks API operation.

func (DescribeTrustedAdvisorChecksRequest) Send 

func (r DescribeTrustedAdvisorChecksRequest) Send(ctx context.Context) (*DescribeTrustedAdvisorChecksResponse, error)

Send marshals and sends the DescribeTrustedAdvisorChecks API request.

type DescribeTrustedAdvisorChecksResponse added in v0.9.0 

type DescribeTrustedAdvisorChecksResponse struct {
	*DescribeTrustedAdvisorChecksOutput
	// contains filtered or unexported fields
}

DescribeTrustedAdvisorChecksResponse is the response type for the DescribeTrustedAdvisorChecks API operation.

func (*DescribeTrustedAdvisorChecksResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeTrustedAdvisorChecksResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTrustedAdvisorChecks request.

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

func (s RecentCaseCommunications) String() string

String returns the string representation

type RefreshTrustedAdvisorCheckInput 

type RefreshTrustedAdvisorCheckInput struct {

	// The unique identifier for the Trusted Advisor check to refresh. Note: 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) String 

func (s RefreshTrustedAdvisorCheckInput) String() string

String returns the string representation

func (*RefreshTrustedAdvisorCheckInput) Validate 

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

func (s RefreshTrustedAdvisorCheckOutput) String() string

String returns the string representation

type RefreshTrustedAdvisorCheckRequest 

type RefreshTrustedAdvisorCheckRequest struct {
	*aws.Request
	Input *RefreshTrustedAdvisorCheckInput
	Copy  func(*RefreshTrustedAdvisorCheckInput) RefreshTrustedAdvisorCheckRequest
}

RefreshTrustedAdvisorCheckRequest is the request type for the RefreshTrustedAdvisorCheck API operation.

func (RefreshTrustedAdvisorCheckRequest) Send 

func (r RefreshTrustedAdvisorCheckRequest) Send(ctx context.Context) (*RefreshTrustedAdvisorCheckResponse, error)

Send marshals and sends the RefreshTrustedAdvisorCheck API request.

type RefreshTrustedAdvisorCheckResponse added in v0.9.0 

type RefreshTrustedAdvisorCheckResponse struct {
	*RefreshTrustedAdvisorCheckOutput
	// contains filtered or unexported fields
}

RefreshTrustedAdvisorCheckResponse is the response type for the RefreshTrustedAdvisorCheck API operation.

func (*RefreshTrustedAdvisorCheckResponse) SDKResponseMetdata added in v0.9.0 

func (r *RefreshTrustedAdvisorCheckResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RefreshTrustedAdvisorCheck request.

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

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

func (s ResolveCaseOutput) String() string

String returns the string representation

type ResolveCaseRequest 

type ResolveCaseRequest struct {
	*aws.Request
	Input *ResolveCaseInput
	Copy  func(*ResolveCaseInput) ResolveCaseRequest
}

ResolveCaseRequest is the request type for the ResolveCase API operation.

func (ResolveCaseRequest) Send 

func (r ResolveCaseRequest) Send(ctx context.Context) (*ResolveCaseResponse, error)

Send marshals and sends the ResolveCase API request.

type ResolveCaseResponse added in v0.9.0 

type ResolveCaseResponse struct {
	*ResolveCaseOutput
	// contains filtered or unexported fields
}

ResolveCaseResponse is the response type for the ResolveCase API operation.

func (*ResolveCaseResponse) SDKResponseMetdata added in v0.9.0 

func (r *ResolveCaseResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ResolveCase request.

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

func (s Service) String() string

String returns the string representation

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 differ from the values that are displayed
	// in the AWS Support Center. For example, for the code "low", the API name
	// is "Low", but the name in the Support Center is "General guidance". These
	// are the Support Center code/name mappings:
	//
	//    * low: General guidance
	//
	//    * normal: System impaired
	//
	//    * high: Production system impaired
	//
	//    * urgent: Production system down
	//
	//    * critical: Business-critical system down
	//
	// For more information, see Choosing a severity (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity)
	// in the AWS Support User Guide.
	Name *string `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 AWS Support User Guide.

func (SeverityLevel) String 

func (s SeverityLevel) String() string

String returns the string representation

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

func (s TrustedAdvisorCategorySpecificSummary) String() string

String returns the string representation

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

func (s TrustedAdvisorCheckDescription) String() string

String returns the string representation

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

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 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 AWS 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) String 

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 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 AWS 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) String 

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

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

	// The AWS 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) String 

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 is a required field
	ResourcesFlagged *int64 `locationName:"resourcesFlagged" type:"long" required:"true"`

	// The number of AWS 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 AWS 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 AWS 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 AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

func (TrustedAdvisorResourcesSummary) String 

func (s TrustedAdvisorResourcesSummary) String() string

String returns the string representation

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.