Documentation

Overview

    Package support provides the API client, operations, and parameter types for AWS Support.

    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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2013-04-15"
    View Source
    const ServiceID = "Support"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          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
          }

          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
          }

            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 AWS Support case ID requested or returned in the call. The case ID is an
            	// alphanumeric string formatted as shown in this example:
            	// case-12345678910-2013-c4c1d2bf33c5cf47
            	CaseId *string
            
            	// The email addresses in the CC line of an email to be added to the support case.
            	CcEmailAddresses []string
            }

            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
            }

              The result of the AddCommunicationToCase 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

                func New(options Options, optFns ...func(*Options)) *Client

                  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

                  func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

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

                      func (*Client) AddCommunicationToCase

                      func (c *Client) AddCommunicationToCase(ctx context.Context, params *AddCommunicationToCaseInput, optFns ...func(*Options)) (*AddCommunicationToCaseOutput, error)

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

                        func (*Client) CreateCase

                        func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error)

                          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:

                          * Submit a request from the AWS Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) page.

                          * Use the Service Quotas RequestServiceQuotaIncrease (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html) operation.

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

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

                            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 CaseDetails (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) data 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 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/).

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

                                func (*Client) DescribeServices

                                func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesInput, optFns ...func(*Options)) (*DescribeServicesOutput, error)

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

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

                                    func (*Client) DescribeTrustedAdvisorCheckRefreshStatuses

                                    func (c *Client) DescribeTrustedAdvisorCheckRefreshStatuses(ctx context.Context, params *DescribeTrustedAdvisorCheckRefreshStatusesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckRefreshStatusesOutput, error)

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

                                      func (*Client) DescribeTrustedAdvisorCheckResult

                                      func (c *Client) DescribeTrustedAdvisorCheckResult(ctx context.Context, params *DescribeTrustedAdvisorCheckResultInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckResultOutput, error)

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

                                        func (*Client) DescribeTrustedAdvisorCheckSummaries

                                        func (c *Client) DescribeTrustedAdvisorCheckSummaries(ctx context.Context, params *DescribeTrustedAdvisorCheckSummariesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckSummariesOutput, error)

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

                                          func (*Client) DescribeTrustedAdvisorChecks

                                          func (c *Client) DescribeTrustedAdvisorChecks(ctx context.Context, params *DescribeTrustedAdvisorChecksInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorChecksOutput, error)

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

                                            func (*Client) RefreshTrustedAdvisorCheck

                                            func (c *Client) RefreshTrustedAdvisorCheck(ctx context.Context, params *RefreshTrustedAdvisorCheckInput, optFns ...func(*Options)) (*RefreshTrustedAdvisorCheckOutput, error)

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

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

                                                type CreateCaseInput

                                                type CreateCaseInput struct {
                                                
                                                	// 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.
                                                	//
                                                	// This member is required.
                                                	CommunicationBody *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.
                                                	//
                                                	// 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 AddAttachmentsToSet operation.
                                                	AttachmentSetId *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
                                                
                                                	// 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
                                                
                                                	// 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 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
                                                
                                                	// The code for the AWS 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 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
                                                }

                                                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
                                                
                                                	// Metadata pertaining to the operation's result.
                                                	ResultMetadata middleware.Metadata
                                                }

                                                  The AWS 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
                                                  }

                                                  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
                                                  }

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

                                                    type DescribeCasesAPIClient

                                                    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 AWS Support Center user interface.
                                                      	DisplayId *string
                                                      
                                                      	// Specifies whether to include communications in the DescribeCases response. By
                                                      	// default, communications are incuded.
                                                      	IncludeCommunications *bool
                                                      
                                                      	// Specifies whether to include resolved support cases in the DescribeCases
                                                      	// response. By default, resolved cases aren't included.
                                                      	IncludeResolvedCases bool
                                                      
                                                      	// The ISO 639-1 code for the language in which AWS provides support. AWS Support
                                                      	// currently supports English ("en") and Japanese ("ja"). Language parameters must
                                                      	// be passed explicitly for operations that take them.
                                                      	Language *string
                                                      
                                                      	// The maximum number of results to return before paginating.
                                                      	MaxResults *int32
                                                      
                                                      	// A resumption point for pagination.
                                                      	NextToken *string
                                                      }

                                                      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
                                                      }

                                                        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.

                                                        type DescribeCasesPaginator

                                                        type DescribeCasesPaginator struct {
                                                        	// contains filtered or unexported fields
                                                        }

                                                          DescribeCasesPaginator is a paginator for DescribeCases

                                                          func NewDescribeCasesPaginator

                                                          func NewDescribeCasesPaginator(client DescribeCasesAPIClient, params *DescribeCasesInput, optFns ...func(*DescribeCasesPaginatorOptions)) *DescribeCasesPaginator

                                                            NewDescribeCasesPaginator returns a new DescribeCasesPaginator

                                                            func (*DescribeCasesPaginator) HasMorePages

                                                            func (p *DescribeCasesPaginator) HasMorePages() bool

                                                              HasMorePages returns a boolean indicating whether more pages are available

                                                              func (*DescribeCasesPaginator) NextPage

                                                              func (p *DescribeCasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeCasesOutput, error)

                                                                NextPage retrieves the next DescribeCases page.

                                                                type DescribeCasesPaginatorOptions

                                                                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

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

                                                                    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
                                                                    }

                                                                      The communications returned by the DescribeCommunications operation.

                                                                      type DescribeCommunicationsPaginator

                                                                      type DescribeCommunicationsPaginator struct {
                                                                      	// contains filtered or unexported fields
                                                                      }

                                                                        DescribeCommunicationsPaginator is a paginator for DescribeCommunications

                                                                        func NewDescribeCommunicationsPaginator

                                                                          NewDescribeCommunicationsPaginator returns a new DescribeCommunicationsPaginator

                                                                          func (*DescribeCommunicationsPaginator) HasMorePages

                                                                          func (p *DescribeCommunicationsPaginator) HasMorePages() bool

                                                                            HasMorePages returns a boolean indicating whether more pages are available

                                                                            func (*DescribeCommunicationsPaginator) NextPage

                                                                              NextPage retrieves the next DescribeCommunications page.

                                                                              type DescribeCommunicationsPaginatorOptions

                                                                              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 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
                                                                                
                                                                                	// A JSON-formatted list of service codes available for AWS services.
                                                                                	ServiceCodeList []string
                                                                                }

                                                                                type DescribeServicesOutput

                                                                                type DescribeServicesOutput struct {
                                                                                
                                                                                	// A JSON-formatted list of AWS services.
                                                                                	Services []types.Service
                                                                                
                                                                                	// Metadata pertaining to the operation's result.
                                                                                	ResultMetadata middleware.Metadata
                                                                                }

                                                                                  The list of AWS services returned by the DescribeServices operation.

                                                                                  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
                                                                                  }

                                                                                  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 []types.SeverityLevel
                                                                                  
                                                                                  	// Metadata pertaining to the operation's result.
                                                                                  	ResultMetadata middleware.Metadata
                                                                                  }

                                                                                    The list of severity levels returned by the DescribeSeverityLevels operation.

                                                                                    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.
                                                                                    	//
                                                                                    	// This member is required.
                                                                                    	CheckIds []string
                                                                                    }

                                                                                    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
                                                                                    }

                                                                                      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 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
                                                                                      }

                                                                                      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
                                                                                      }

                                                                                        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
                                                                                        }

                                                                                        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
                                                                                        }

                                                                                          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 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.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	Language *string
                                                                                          }

                                                                                          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
                                                                                          }

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

                                                                                            type EndpointResolver

                                                                                            type EndpointResolver interface {
                                                                                            	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                                                                            }

                                                                                              EndpointResolver interface for resolving service endpoints.

                                                                                              func EndpointResolverFromURL

                                                                                              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

                                                                                                  type EndpointResolverOptions = internalendpoints.Options

                                                                                                    EndpointResolverOptions is the service endpoint resolver options

                                                                                                    type HTTPClient

                                                                                                    type HTTPClient interface {
                                                                                                    	Do(*http.Request) (*http.Response, error)
                                                                                                    }

                                                                                                    type HTTPSignerV4

                                                                                                    type HTTPSignerV4 interface {
                                                                                                    	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                                                                    }

                                                                                                    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
                                                                                                    
                                                                                                    	// 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 endpoint options to be used when attempting to resolve an endpoint.
                                                                                                    	EndpointOptions EndpointResolverOptions
                                                                                                    
                                                                                                    	// The service endpoint resolver.
                                                                                                    	EndpointResolver EndpointResolver
                                                                                                    
                                                                                                    	// Signature Version 4 (SigV4) Signer
                                                                                                    	HTTPSignerV4 HTTPSignerV4
                                                                                                    
                                                                                                    	// The logger writer interface to write logging messages to.
                                                                                                    	Logger logging.Logger
                                                                                                    
                                                                                                    	// The region to send requests to. (Required)
                                                                                                    	Region string
                                                                                                    
                                                                                                    	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                                    	// failures. When nil the API client will use a default retryer.
                                                                                                    	Retryer aws.Retryer
                                                                                                    
                                                                                                    	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                                    	// implementation if nil.
                                                                                                    	HTTPClient HTTPClient
                                                                                                    }

                                                                                                    func (Options) Copy

                                                                                                    func (o Options) Copy() Options

                                                                                                      Copy creates a clone where the APIOptions list is deep copied.

                                                                                                      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.
                                                                                                      	//
                                                                                                      	// This member is required.
                                                                                                      	CheckId *string
                                                                                                      }

                                                                                                      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
                                                                                                      }

                                                                                                        The current refresh status of a Trusted Advisor check.

                                                                                                        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
                                                                                                        }

                                                                                                        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
                                                                                                        }

                                                                                                          The status of the case returned by the ResolveCase operation.

                                                                                                          type ResolveEndpoint

                                                                                                          type ResolveEndpoint struct {
                                                                                                          	Resolver EndpointResolver
                                                                                                          	Options  EndpointResolverOptions
                                                                                                          }

                                                                                                          func (*ResolveEndpoint) HandleSerialize

                                                                                                          func (*ResolveEndpoint) ID

                                                                                                          func (*ResolveEndpoint) ID() string

                                                                                                          Directories

                                                                                                          Path Synopsis
                                                                                                          internal