Documentation ¶
Overview ¶
Package support provides the API client, operations, and parameter types for AWS Support.
Amazon Web Services Support ¶
The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
You can manage your support cases with the following Amazon Web Services Support API operations:
The CreateCase, DescribeCases, DescribeAttachment, and ResolveCaseoperations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSetoperations retrieve and add communications and attachments to Amazon Web Services Support cases.
The DescribeServicesand DescribeSeverityLevelsoperations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisorin the Amazon Web Services Support User Guide.
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.
For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AddAttachmentsToSetInput
- type AddAttachmentsToSetOutput
- type AddCommunicationToCaseInput
- type AddCommunicationToCaseOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AddAttachmentsToSet(ctx context.Context, params *AddAttachmentsToSetInput, ...) (*AddAttachmentsToSetOutput, error)
- func (c *Client) AddCommunicationToCase(ctx context.Context, params *AddCommunicationToCaseInput, ...) (*AddCommunicationToCaseOutput, error)
- func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error)
- func (c *Client) DescribeAttachment(ctx context.Context, params *DescribeAttachmentInput, optFns ...func(*Options)) (*DescribeAttachmentOutput, error)
- func (c *Client) DescribeCases(ctx context.Context, params *DescribeCasesInput, optFns ...func(*Options)) (*DescribeCasesOutput, error)
- func (c *Client) DescribeCommunications(ctx context.Context, params *DescribeCommunicationsInput, ...) (*DescribeCommunicationsOutput, error)
- func (c *Client) DescribeCreateCaseOptions(ctx context.Context, params *DescribeCreateCaseOptionsInput, ...) (*DescribeCreateCaseOptionsOutput, error)
- func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesInput, optFns ...func(*Options)) (*DescribeServicesOutput, error)
- func (c *Client) DescribeSeverityLevels(ctx context.Context, params *DescribeSeverityLevelsInput, ...) (*DescribeSeverityLevelsOutput, error)
- func (c *Client) DescribeSupportedLanguages(ctx context.Context, params *DescribeSupportedLanguagesInput, ...) (*DescribeSupportedLanguagesOutput, error)
- func (c *Client) DescribeTrustedAdvisorCheckRefreshStatuses(ctx context.Context, params *DescribeTrustedAdvisorCheckRefreshStatusesInput, ...) (*DescribeTrustedAdvisorCheckRefreshStatusesOutput, error)
- func (c *Client) DescribeTrustedAdvisorCheckResult(ctx context.Context, params *DescribeTrustedAdvisorCheckResultInput, ...) (*DescribeTrustedAdvisorCheckResultOutput, error)
- func (c *Client) DescribeTrustedAdvisorCheckSummaries(ctx context.Context, params *DescribeTrustedAdvisorCheckSummariesInput, ...) (*DescribeTrustedAdvisorCheckSummariesOutput, error)
- func (c *Client) DescribeTrustedAdvisorChecks(ctx context.Context, params *DescribeTrustedAdvisorChecksInput, ...) (*DescribeTrustedAdvisorChecksOutput, error)
- func (c *Client) Options() Options
- func (c *Client) RefreshTrustedAdvisorCheck(ctx context.Context, params *RefreshTrustedAdvisorCheckInput, ...) (*RefreshTrustedAdvisorCheckOutput, error)
- func (c *Client) ResolveCase(ctx context.Context, params *ResolveCaseInput, optFns ...func(*Options)) (*ResolveCaseOutput, error)
- type CreateCaseInput
- type CreateCaseOutput
- type DescribeAttachmentInput
- type DescribeAttachmentOutput
- type DescribeCasesAPIClient
- type DescribeCasesInput
- type DescribeCasesOutput
- type DescribeCasesPaginator
- type DescribeCasesPaginatorOptions
- type DescribeCommunicationsAPIClient
- type DescribeCommunicationsInput
- type DescribeCommunicationsOutput
- type DescribeCommunicationsPaginator
- type DescribeCommunicationsPaginatorOptions
- type DescribeCreateCaseOptionsInput
- type DescribeCreateCaseOptionsOutput
- type DescribeServicesInput
- type DescribeServicesOutput
- type DescribeSeverityLevelsInput
- type DescribeSeverityLevelsOutput
- type DescribeSupportedLanguagesInput
- type DescribeSupportedLanguagesOutput
- type DescribeTrustedAdvisorCheckRefreshStatusesInput
- type DescribeTrustedAdvisorCheckRefreshStatusesOutput
- type DescribeTrustedAdvisorCheckResultInput
- type DescribeTrustedAdvisorCheckResultOutput
- type DescribeTrustedAdvisorCheckSummariesInput
- type DescribeTrustedAdvisorCheckSummariesOutput
- type DescribeTrustedAdvisorChecksInput
- type DescribeTrustedAdvisorChecksOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type HTTPClient
- type HTTPSignerV4
- type Options
- type RefreshTrustedAdvisorCheckInput
- type RefreshTrustedAdvisorCheckOutput
- type ResolveCaseInput
- type ResolveCaseOutput
- type ResolveEndpoint
Constants ¶
const ServiceAPIVersion = "2013-04-15"
const ServiceID = "Support"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.16.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.18.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.18.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AddAttachmentsToSetInput ¶
type AddAttachmentsToSetInput struct { // 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 . // // This member is required. Attachments []types.Attachment // 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 // contains filtered or unexported fields }
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 // The time and date when the attachment set expires. ExpiryTime *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
type AddCommunicationToCaseInput ¶
type AddCommunicationToCaseInput struct { // The body of an email communication to add to the support case. // // This member is required. CommunicationBody *string // 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 // The support case ID requested or returned in the call. The case ID is an // alphanumeric string formatted as shown in this example: // case-12345678910-2013-c4c1d2bf33c5cf47 CaseId *string // The email addresses in the CC line of an email to be added to the support case. CcEmailAddresses []string // contains filtered or unexported fields }
type AddCommunicationToCaseOutput ¶
type AddCommunicationToCaseOutput struct { // True if AddCommunicationToCase succeeds. Otherwise, returns an error. Result bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The result of the AddCommunicationToCase operation.
type AuthResolverParameters ¶ added in v1.18.2
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.18.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Support.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AddAttachmentsToSet ¶
func (c *Client) AddAttachmentsToSet(ctx context.Context, params *AddAttachmentsToSetInput, optFns ...func(*Options)) (*AddAttachmentsToSetOutput, error)
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) AddCommunicationToCase ¶
func (c *Client) AddCommunicationToCase(ctx context.Context, params *AddCommunicationToCaseInput, optFns ...func(*Options)) (*AddCommunicationToCaseOutput, error)
Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) CreateCase ¶
func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error)
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Casepage.
The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
Submit a request from the Amazon Web Services Support Center Create Casepage.
Use the Service Quotas RequestServiceQuotaIncreaseoperation.
A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCasesoperation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCaseoperation to add additional communication or attachments to an existing case.
The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId .
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeAttachment ¶
func (c *Client) DescribeAttachment(ctx context.Context, params *DescribeAttachmentInput, optFns ...func(*Options)) (*DescribeAttachmentOutput, error)
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 AttachmentDetailsobjects that are returned by the DescribeCommunicationsoperation.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeCases ¶
func (c *Client) DescribeCases(ctx context.Context, params *DescribeCasesInput, optFns ...func(*Options)) (*DescribeCasesOutput, error)
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:
One or more CaseDetailsdata types.
One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeCommunications ¶
func (c *Client) DescribeCommunications(ctx context.Context, params *DescribeCommunicationsInput, optFns ...func(*Options)) (*DescribeCommunicationsOutput, error)
Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeCreateCaseOptions ¶ added in v1.15.0
func (c *Client) DescribeCreateCaseOptions(ctx context.Context, params *DescribeCreateCaseOptionsInput, optFns ...func(*Options)) (*DescribeCreateCaseOptionsOutput, error)
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode , issueType and serviceCode used to retrieve the CreateCaseOptions.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeServices ¶
func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesInput, optFns ...func(*Options)) (*DescribeServicesOutput, error)
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Casepage. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeSeverityLevels ¶
func (c *Client) DescribeSeverityLevels(ctx context.Context, params *DescribeSeverityLevelsInput, optFns ...func(*Options)) (*DescribeSeverityLevelsOutput, error)
Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetailsdata type that you include for a CreateCaserequest.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeSupportedLanguages ¶ added in v1.15.0
func (c *Client) DescribeSupportedLanguages(ctx context.Context, params *DescribeSupportedLanguagesInput, optFns ...func(*Options)) (*DescribeSupportedLanguagesOutput, error)
Returns a list of supported languages for a specified categoryCode , issueType and serviceCode . The returned supported languages will include a ISO 639-1 code for the language , and the language display name.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
func (*Client) DescribeTrustedAdvisorCheckRefreshStatuses ¶
func (c *Client) DescribeTrustedAdvisorCheckRefreshStatuses(ctx context.Context, params *DescribeTrustedAdvisorCheckRefreshStatusesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckRefreshStatusesOutput, error)
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support APIin the Amazon Web Services Support User Guide.
func (*Client) DescribeTrustedAdvisorCheckResult ¶
func (c *Client) DescribeTrustedAdvisorCheckResult(ctx context.Context, params *DescribeTrustedAdvisorCheckResultInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckResultOutput, error)
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
TrustedAdvisorCategorySpecificSummary ¶
TrustedAdvisorResourceDetail ¶
TrustedAdvisorResourcesSummary ¶
In addition, the response contains these fields:
status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available .
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support APIin the Amazon Web Services Support User Guide.
func (*Client) DescribeTrustedAdvisorCheckSummaries ¶
func (c *Client) DescribeTrustedAdvisorCheckSummaries(ctx context.Context, params *DescribeTrustedAdvisorCheckSummariesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckSummariesOutput, error)
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation.
The response contains an array of TrustedAdvisorCheckSummary objects.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support APIin the Amazon Web Services Support User Guide.
func (*Client) DescribeTrustedAdvisorChecks ¶
func (c *Client) DescribeTrustedAdvisorChecks(ctx context.Context, params *DescribeTrustedAdvisorChecksInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorChecksOutput, error)
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.
The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support APIin the Amazon Web Services Support User Guide.
func (*Client) Options ¶ added in v1.19.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) RefreshTrustedAdvisorCheck ¶
func (c *Client) RefreshTrustedAdvisorCheck(ctx context.Context, params *RefreshTrustedAdvisorCheckInput, optFns ...func(*Options)) (*RefreshTrustedAdvisorCheckOutput, error)
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation.
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support APIin the Amazon Web Services Support User Guide.
func (*Client) ResolveCase ¶
func (c *Client) ResolveCase(ctx context.Context, params *ResolveCaseInput, optFns ...func(*Options)) (*ResolveCaseOutput, error)
Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.
type CreateCaseInput ¶
type CreateCaseInput struct { // The communication body text that describes the issue. This text appears in the // Description field on the Amazon Web Services Support Center [Create Case]page. // // [Create Case]: https://console.aws.amazon.com/support/home#/case/create // // This member is required. CommunicationBody *string // The title of the support case. The title appears in the Subject field on the // Amazon Web Services Support Center [Create Case]page. // // [Create Case]: https://console.aws.amazon.com/support/home#/case/create // // This member is required. Subject *string // The ID of a set of one or more attachments for the case. Create the set by // using the AddAttachmentsToSetoperation. AttachmentSetId *string // The category of problem for the support case. You also use the DescribeServices operation to // get the category code for a service. Each Amazon Web Services service defines // its own set of category codes. CategoryCode *string // A list of email addresses that Amazon Web Services Support copies on case // correspondence. Amazon Web Services Support identifies the account that creates // the case when you specify your Amazon Web Services credentials in an HTTP POST // method or use the [Amazon Web Services SDKs]. // // [Amazon Web Services SDKs]: http://aws.amazon.com/tools/ CcEmailAddresses []string // 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 // The language in which Amazon Web Services Support handles the case. Amazon Web // Services Support currently supports Chinese (“zh”), English ("en"), Japanese // ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language // parameter if you want support in that language. Language *string // The code for the Amazon Web Services service. You can use the DescribeServices operation to get // the possible serviceCode values. ServiceCode *string // A value that indicates the urgency of the case. This value determines the // response time according to your service level agreement with Amazon Web Services // Support. You can use the DescribeSeverityLevelsoperation to get the possible values for severityCode . // // For more information, see SeverityLevel and [Choosing a Severity] in the Amazon Web Services Support User Guide. // // The availability of severity levels depends on the support plan for the Amazon // Web Services account. // // [Choosing a Severity]: https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity SeverityCode *string // contains filtered or unexported fields }
type CreateCaseOutput ¶
type CreateCaseOutput struct { // The support case ID requested or returned in the call. The case ID is an // alphanumeric string in the following format: // case-12345678910-2013-c4c1d2bf33c5cf47 CaseId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The support case ID returned by a successful completion of the CreateCase operation.
type DescribeAttachmentInput ¶
type DescribeAttachmentInput struct { // The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications // operation. // // This member is required. AttachmentId *string // contains filtered or unexported fields }
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 *types.Attachment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The content and file name of the attachment returned by the DescribeAttachment operation.
type DescribeCasesAPIClient ¶ added in v0.30.0
type DescribeCasesAPIClient interface {
DescribeCases(context.Context, *DescribeCasesInput, ...func(*Options)) (*DescribeCasesOutput, error)
}
DescribeCasesAPIClient is a client that implements the DescribeCases operation.
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 // The end date for a filtered date search on support case communications. Case // communications are available for 12 months after creation. BeforeTime *string // A list of ID numbers of the support cases you want returned. The maximum number // of cases is 100. CaseIdList []string // The ID displayed for a case in the Amazon Web Services Support Center user // interface. DisplayId *string // Specifies whether to include communications in the DescribeCases response. By // default, communications are included. IncludeCommunications *bool // Specifies whether to include resolved support cases in the DescribeCases // response. By default, resolved cases aren't included. IncludeResolvedCases bool // The language in which Amazon Web Services Support handles the case. Amazon Web // Services Support currently supports Chinese (“zh”), English ("en"), Japanese // ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language // parameter if you want support in that language. Language *string // The maximum number of results to return before paginating. MaxResults *int32 // A resumption point for pagination. NextToken *string // contains filtered or unexported fields }
type DescribeCasesOutput ¶
type DescribeCasesOutput struct { // The details for the cases that match the request. Cases []types.CaseDetails // A resumption point for pagination. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.
type DescribeCasesPaginator ¶ added in v0.30.0
type DescribeCasesPaginator struct {
// contains filtered or unexported fields
}
DescribeCasesPaginator is a paginator for DescribeCases
func NewDescribeCasesPaginator ¶ added in v0.30.0
func NewDescribeCasesPaginator(client DescribeCasesAPIClient, params *DescribeCasesInput, optFns ...func(*DescribeCasesPaginatorOptions)) *DescribeCasesPaginator
NewDescribeCasesPaginator returns a new DescribeCasesPaginator
func (*DescribeCasesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeCasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeCasesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeCasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeCasesOutput, error)
NextPage retrieves the next DescribeCases page.
type DescribeCasesPaginatorOptions ¶ added in v0.30.0
type DescribeCasesPaginatorOptions struct { // The maximum number of results to return before paginating. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeCasesPaginatorOptions is the paginator options for DescribeCases
type DescribeCommunicationsAPIClient ¶ added in v0.30.0
type DescribeCommunicationsAPIClient interface {
DescribeCommunications(context.Context, *DescribeCommunicationsInput, ...func(*Options)) (*DescribeCommunicationsOutput, error)
}
DescribeCommunicationsAPIClient is a client that implements the DescribeCommunications operation.
type DescribeCommunicationsInput ¶
type DescribeCommunicationsInput struct { // The support case ID requested or returned in the call. The case ID is an // alphanumeric string formatted as shown in this example: // case-12345678910-2013-c4c1d2bf33c5cf47 // // This member is required. CaseId *string // The start date for a filtered date search on support case communications. Case // communications are available for 12 months after creation. AfterTime *string // The end date for a filtered date search on support case communications. Case // communications are available for 12 months after creation. BeforeTime *string // The maximum number of results to return before paginating. MaxResults *int32 // A resumption point for pagination. NextToken *string // contains filtered or unexported fields }
type DescribeCommunicationsOutput ¶
type DescribeCommunicationsOutput struct { // The communications for the case. Communications []types.Communication // A resumption point for pagination. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The communications returned by the DescribeCommunications operation.
type DescribeCommunicationsPaginator ¶ added in v0.30.0
type DescribeCommunicationsPaginator struct {
// contains filtered or unexported fields
}
DescribeCommunicationsPaginator is a paginator for DescribeCommunications
func NewDescribeCommunicationsPaginator ¶ added in v0.30.0
func NewDescribeCommunicationsPaginator(client DescribeCommunicationsAPIClient, params *DescribeCommunicationsInput, optFns ...func(*DescribeCommunicationsPaginatorOptions)) *DescribeCommunicationsPaginator
NewDescribeCommunicationsPaginator returns a new DescribeCommunicationsPaginator
func (*DescribeCommunicationsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeCommunicationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeCommunicationsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeCommunicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeCommunicationsOutput, error)
NextPage retrieves the next DescribeCommunications page.
type DescribeCommunicationsPaginatorOptions ¶ added in v0.30.0
type DescribeCommunicationsPaginatorOptions struct { // The maximum number of results to return before paginating. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeCommunicationsPaginatorOptions is the paginator options for DescribeCommunications
type DescribeCreateCaseOptionsInput ¶ added in v1.15.0
type DescribeCreateCaseOptionsInput struct { // The category of problem for the support case. You also use the DescribeServices operation to // get the category code for a service. Each Amazon Web Services service defines // its own set of category codes. // // This member is required. CategoryCode *string // 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 . // // This member is required. IssueType *string // The language in which Amazon Web Services Support handles the case. Amazon Web // Services Support currently supports Chinese (“zh”), English ("en"), Japanese // ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language // parameter if you want support in that language. // // This member is required. Language *string // The code for the Amazon Web Services service. You can use the DescribeServices operation to get // the possible serviceCode values. // // This member is required. ServiceCode *string // contains filtered or unexported fields }
type DescribeCreateCaseOptionsOutput ¶ added in v1.15.0
type DescribeCreateCaseOptionsOutput struct { // A JSON-formatted array that contains the available communication type options, // along with the available support timeframes for the given inputs. CommunicationTypes []types.CommunicationTypeOptions // Language availability can be any of the following: // // - available // // - best_effort // // - unavailable LanguageAvailability *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeServicesInput ¶
type DescribeServicesInput struct { // The language in which Amazon Web Services Support handles the case. Amazon Web // Services Support currently supports Chinese (“zh”), English ("en"), Japanese // ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language // parameter if you want support in that language. Language *string // A JSON-formatted list of service codes available for Amazon Web Services // services. ServiceCodeList []string // contains filtered or unexported fields }
type DescribeServicesOutput ¶
type DescribeServicesOutput struct { // A JSON-formatted list of Amazon Web Services services. Services []types.Service // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The list of Amazon Web Services services returned by the DescribeServices operation.
type DescribeSeverityLevelsInput ¶
type DescribeSeverityLevelsInput struct { // The language in which Amazon Web Services Support handles the case. Amazon Web // Services Support currently supports Chinese (“zh”), English ("en"), Japanese // ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language // parameter if you want support in that language. Language *string // contains filtered or unexported fields }
type DescribeSeverityLevelsOutput ¶
type DescribeSeverityLevelsOutput struct { // The available severity levels for the support case. Available severity levels // are defined by your service level agreement with Amazon Web Services. SeverityLevels []types.SeverityLevel // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The list of severity levels returned by the DescribeSeverityLevels operation.
type DescribeSupportedLanguagesInput ¶ added in v1.15.0
type DescribeSupportedLanguagesInput struct { // The category of problem for the support case. You also use the DescribeServices operation to // get the category code for a service. Each Amazon Web Services service defines // its own set of category codes. // // This member is required. CategoryCode *string // The type of issue for the case. You can specify customer-service or technical . // // This member is required. IssueType *string // The code for the Amazon Web Services service. You can use the DescribeServices operation to get // the possible serviceCode values. // // This member is required. ServiceCode *string // contains filtered or unexported fields }
type DescribeSupportedLanguagesOutput ¶ added in v1.15.0
type DescribeSupportedLanguagesOutput struct { // A JSON-formatted array that contains the available ISO 639-1 language codes. SupportedLanguages []types.SupportedLanguage // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeTrustedAdvisorCheckRefreshStatusesInput ¶
type DescribeTrustedAdvisorCheckRefreshStatusesInput struct { // The IDs of the Trusted Advisor checks to get the status. // // If you specify the check ID of a check that is automatically refreshed, you // might see an InvalidParameterValue error. // // This member is required. CheckIds []*string // contains filtered or unexported fields }
type DescribeTrustedAdvisorCheckRefreshStatusesOutput ¶
type DescribeTrustedAdvisorCheckRefreshStatusesOutput struct { // The refresh status of the specified Trusted Advisor checks. // // This member is required. Statuses []types.TrustedAdvisorCheckRefreshStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
type DescribeTrustedAdvisorCheckResultInput ¶
type DescribeTrustedAdvisorCheckResultInput struct { // The unique identifier for the Trusted Advisor check. // // This member is required. CheckId *string // The ISO 639-1 code for the language that you want your check results to appear // in. // // The Amazon Web Services Support API currently supports the following languages // for Trusted Advisor: // // - Chinese, Simplified - zh // // - Chinese, Traditional - zh_TW // // - English - en // // - French - fr // // - German - de // // - Indonesian - id // // - Italian - it // // - Japanese - ja // // - Korean - ko // // - Portuguese, Brazilian - pt_BR // // - Spanish - es Language *string // contains filtered or unexported fields }
type DescribeTrustedAdvisorCheckResultOutput ¶
type DescribeTrustedAdvisorCheckResultOutput struct { // The detailed results of the Trusted Advisor check. Result *types.TrustedAdvisorCheckResult // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
type DescribeTrustedAdvisorCheckSummariesInput ¶
type DescribeTrustedAdvisorCheckSummariesInput struct { // The IDs of the Trusted Advisor checks. // // This member is required. CheckIds []*string // contains filtered or unexported fields }
type DescribeTrustedAdvisorCheckSummariesOutput ¶
type DescribeTrustedAdvisorCheckSummariesOutput struct { // The summary information for the requested Trusted Advisor checks. // // This member is required. Summaries []types.TrustedAdvisorCheckSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
type DescribeTrustedAdvisorChecksInput ¶
type DescribeTrustedAdvisorChecksInput struct { // The ISO 639-1 code for the language that you want your checks to appear in. // // The Amazon Web Services Support API currently supports the following languages // for Trusted Advisor: // // - Chinese, Simplified - zh // // - Chinese, Traditional - zh_TW // // - English - en // // - French - fr // // - German - de // // - Indonesian - id // // - Italian - it // // - Japanese - ja // // - Korean - ko // // - Portuguese, Brazilian - pt_BR // // - Spanish - es // // This member is required. Language *string // contains filtered or unexported fields }
type DescribeTrustedAdvisorChecksOutput ¶
type DescribeTrustedAdvisorChecksOutput struct { // Information about all available Trusted Advisor checks. // // This member is required. Checks []types.TrustedAdvisorCheckDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
type EndpointParameters ¶ added in v1.16.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.16.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.16.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.16.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.16.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type HTTPSignerV4 ¶
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The client tracer provider. TracerProvider tracing.TracerProvider // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) GetIdentityResolver ¶ added in v1.18.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type RefreshTrustedAdvisorCheckInput ¶
type RefreshTrustedAdvisorCheckInput struct { // The unique identifier for the Trusted Advisor check to refresh. // // Specifying the check ID of a check that is automatically refreshed causes an // InvalidParameterValue error. // // This member is required. CheckId *string // contains filtered or unexported fields }
type RefreshTrustedAdvisorCheckOutput ¶
type RefreshTrustedAdvisorCheckOutput struct { // The current refresh status for a check, including the amount of time until the // check is eligible for refresh. // // This member is required. Status *types.TrustedAdvisorCheckRefreshStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The current refresh status of a Trusted Advisor check.
type ResolveCaseInput ¶
type ResolveCaseInput struct { // The support case ID requested or returned in the call. The case ID is an // alphanumeric string formatted as shown in this example: // case-12345678910-2013-c4c1d2bf33c5cf47 CaseId *string // contains filtered or unexported fields }
type ResolveCaseOutput ¶
type ResolveCaseOutput struct { // The status of the case after the ResolveCase request was processed. FinalCaseStatus *string // The status of the case when the ResolveCase request was sent. InitialCaseStatus *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The status of the case returned by the ResolveCase operation.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
Source Files ¶
- api_client.go
- api_op_AddAttachmentsToSet.go
- api_op_AddCommunicationToCase.go
- api_op_CreateCase.go
- api_op_DescribeAttachment.go
- api_op_DescribeCases.go
- api_op_DescribeCommunications.go
- api_op_DescribeCreateCaseOptions.go
- api_op_DescribeServices.go
- api_op_DescribeSeverityLevels.go
- api_op_DescribeSupportedLanguages.go
- api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go
- api_op_DescribeTrustedAdvisorCheckResult.go
- api_op_DescribeTrustedAdvisorCheckSummaries.go
- api_op_DescribeTrustedAdvisorChecks.go
- api_op_RefreshTrustedAdvisorCheck.go
- api_op_ResolveCase.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go