Documentation
¶
Overview ¶
Package supportauthz provides the API client, operations, and parameter types for SupportAuthZ.
AWS Support Authorization ¶
AWS SupportAuthZ enables you to control and authorize the actions that AWS support operators can perform on your resources. You create cryptographically signed support permits specifying which actions operators can perform, on which resources, and under what time-window conditions. Permits are signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.
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 AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) CreateSupportPermit(ctx context.Context, params *CreateSupportPermitInput, ...) (*CreateSupportPermitOutput, error)
- func (c *Client) DeleteSupportPermit(ctx context.Context, params *DeleteSupportPermitInput, ...) (*DeleteSupportPermitOutput, error)
- func (c *Client) GetAction(ctx context.Context, params *GetActionInput, optFns ...func(*Options)) (*GetActionOutput, error)
- func (c *Client) GetSupportPermit(ctx context.Context, params *GetSupportPermitInput, optFns ...func(*Options)) (*GetSupportPermitOutput, error)
- func (c *Client) ListActions(ctx context.Context, params *ListActionsInput, optFns ...func(*Options)) (*ListActionsOutput, error)
- func (c *Client) ListSupportPermitRequests(ctx context.Context, params *ListSupportPermitRequestsInput, ...) (*ListSupportPermitRequestsOutput, error)
- func (c *Client) ListSupportPermits(ctx context.Context, params *ListSupportPermitsInput, optFns ...func(*Options)) (*ListSupportPermitsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) RejectSupportPermitRequest(ctx context.Context, params *RejectSupportPermitRequestInput, ...) (*RejectSupportPermitRequestOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- type CreateSupportPermitInput
- type CreateSupportPermitOutput
- type DeleteSupportPermitInput
- type DeleteSupportPermitOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetActionInput
- type GetActionOutput
- type GetSupportPermitInput
- type GetSupportPermitOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListActionsAPIClient
- type ListActionsInput
- type ListActionsOutput
- type ListActionsPaginator
- type ListActionsPaginatorOptions
- type ListSupportPermitRequestsAPIClient
- type ListSupportPermitRequestsInput
- type ListSupportPermitRequestsOutput
- type ListSupportPermitRequestsPaginator
- type ListSupportPermitRequestsPaginatorOptions
- type ListSupportPermitsAPIClient
- type ListSupportPermitsInput
- type ListSupportPermitsOutput
- type ListSupportPermitsPaginator
- type ListSupportPermitsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type RejectSupportPermitRequestInput
- type RejectSupportPermitRequestOutput
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
Constants ¶
const ServiceAPIVersion = "2026-06-30"
const ServiceID = "SupportAuthZ"
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
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 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
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 ¶
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 AuthResolverParameters ¶
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 ¶
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 SupportAuthZ.
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) CreateSupportPermit ¶
func (c *Client) CreateSupportPermit(ctx context.Context, params *CreateSupportPermitInput, optFns ...func(*Options)) (*CreateSupportPermitOutput, error)
Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.
func (*Client) DeleteSupportPermit ¶
func (c *Client) DeleteSupportPermit(ctx context.Context, params *DeleteSupportPermitInput, optFns ...func(*Options)) (*DeleteSupportPermitOutput, error)
Deletes a support permit, revoking the authorization previously granted to the AWS support operator.
func (*Client) GetAction ¶
func (c *Client) GetAction(ctx context.Context, params *GetActionInput, optFns ...func(*Options)) (*GetActionOutput, error)
Retrieves the description of a specific support action.
func (*Client) GetSupportPermit ¶
func (c *Client) GetSupportPermit(ctx context.Context, params *GetSupportPermitInput, optFns ...func(*Options)) (*GetSupportPermitOutput, error)
Retrieves the details of a support permit by its ARN or name.
func (*Client) ListActions ¶
func (c *Client) ListActions(ctx context.Context, params *ListActionsInput, optFns ...func(*Options)) (*ListActionsOutput, error)
Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.
func (*Client) ListSupportPermitRequests ¶
func (c *Client) ListSupportPermitRequests(ctx context.Context, params *ListSupportPermitRequestsInput, optFns ...func(*Options)) (*ListSupportPermitRequestsOutput, error)
Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.
func (*Client) ListSupportPermits ¶
func (c *Client) ListSupportPermits(ctx context.Context, params *ListSupportPermitsInput, optFns ...func(*Options)) (*ListSupportPermitsOutput, error)
Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags associated with a support permit resource.
func (*Client) Options ¶
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) RejectSupportPermitRequest ¶
func (c *Client) RejectSupportPermitRequest(ctx context.Context, params *RejectSupportPermitRequestInput, optFns ...func(*Options)) (*RejectSupportPermitRequestOutput, error)
Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds or overwrites one or more tags for a support permit resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from a support permit resource.
type CreateSupportPermitInput ¶
type CreateSupportPermitInput struct {
// A customer-chosen name for the support permit. Must be between 1 and 256
// alphanumeric characters.
//
// This member is required.
Name *string
// The permit definition specifying the actions, resources, and time-window
// conditions that the support operator is authorized to use.
//
// This member is required.
Permit *types.Permit
// The signing key information used to sign the permit. Must reference an AWS KMS
// key with key usage SIGN_VERIFY and key spec ECC_NIST_P384.
//
// This member is required.
SigningKeyInfo types.SigningKeyInfo
// A unique, case-sensitive identifier to ensure that the operation completes no
// more than one time. If this token matches a previous request, the service
// returns the existing permit without creating a duplicate.
ClientToken *string
// A human-readable description of why this permit is being created. Maximum
// length of 1024 characters.
Description *string
// The display identifier of the AWS Support case associated with this permit.
SupportCaseDisplayId *string
// The tags to associate with the support permit on creation.
Tags map[string]string
// contains filtered or unexported fields
}
type CreateSupportPermitOutput ¶
type CreateSupportPermitOutput struct {
// The Amazon Resource Name (ARN) of the support permit.
//
// This member is required.
Arn *string
// The timestamp when the permit was created.
//
// This member is required.
CreatedAt *time.Time
// The name of the support permit.
//
// This member is required.
Name *string
// The permit definition.
//
// This member is required.
Permit *types.Permit
// The signing key information for the permit.
//
// This member is required.
SigningKeyInfo types.SigningKeyInfo
// The current status of the support permit.
//
// This member is required.
Status types.SupportPermitStatus
// The description of the support permit.
Description *string
// The display identifier of the support case associated with the permit.
SupportCaseDisplayId *string
// The tags associated with the support permit.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type DeleteSupportPermitInput ¶
type DeleteSupportPermitInput struct {
// The Amazon Resource Name (ARN) or name of the support permit to delete.
//
// This member is required.
SupportPermitIdentifier *string
// contains filtered or unexported fields
}
type DeleteSupportPermitOutput ¶
type DeleteSupportPermitOutput struct {
// The ARN of the deleted support permit.
//
// This member is required.
Arn *string
// The timestamp when the permit was originally created.
//
// This member is required.
CreatedAt *time.Time
// The name of the deleted support permit.
//
// This member is required.
Name *string
// The permit definition of the deleted permit.
//
// This member is required.
Permit *types.Permit
// The signing key information for the deleted permit.
//
// This member is required.
SigningKeyInfo types.SigningKeyInfo
// The status of the support permit. Returns DELETING.
//
// This member is required.
Status types.SupportPermitStatus
// The description of the deleted support permit.
Description *string
// The display identifier of the support case associated with the deleted permit.
SupportCaseDisplayId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type EndpointParameters ¶
type EndpointParameters struct {
// 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
// The AWS region used to dispatch the request.
//
// Parameter is
// required.
//
// AWS::Region
Region *string
}
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
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 ¶
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 EndpointResolverV2 ¶
type EndpointResolverV2 interface {
ResolveEndpoint(ctx context.Context, params EndpointParameters) (
smithyendpoints.Endpoint, error,
)
}
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetActionInput ¶
type GetActionInput struct {
// The name of the support action to retrieve.
//
// This member is required.
Action *string
// contains filtered or unexported fields
}
type GetActionOutput ¶
type GetActionOutput struct {
// The name of the support action.
//
// This member is required.
Action *string
// A description of what the support action does.
//
// This member is required.
Description *string
// The AWS service associated with the support action.
//
// This member is required.
Service *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type GetSupportPermitInput ¶
type GetSupportPermitInput struct {
// The ARN or name of the support permit to retrieve.
//
// This member is required.
SupportPermitIdentifier *string
// contains filtered or unexported fields
}
type GetSupportPermitOutput ¶
type GetSupportPermitOutput struct {
// The ARN of the support permit.
//
// This member is required.
Arn *string
// The timestamp when the permit was created.
//
// This member is required.
CreatedAt *time.Time
// The name of the support permit.
//
// This member is required.
Name *string
// The permit definition.
//
// This member is required.
Permit *types.Permit
// The signing key information for the permit.
//
// This member is required.
SigningKeyInfo types.SigningKeyInfo
// The current status of the support permit.
//
// This member is required.
Status types.SupportPermitStatus
// The description of the support permit.
Description *string
// The display identifier of the support case associated with the permit.
SupportCaseDisplayId *string
// The tags associated with the support permit.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListActionsAPIClient ¶
type ListActionsAPIClient interface {
ListActions(context.Context, *ListActionsInput, ...func(*Options)) (*ListActionsOutput, error)
}
ListActionsAPIClient is a client that implements the ListActions operation.
type ListActionsInput ¶
type ListActionsInput struct {
// The name of the AWS service for which to list available support actions.
//
// This member is required.
Service *string
// The maximum number of results to return in a single call. Valid range is 1 to
// 100.
MaxResults *int32
// The token for the next page of results.
NextToken *string
// contains filtered or unexported fields
}
type ListActionsOutput ¶
type ListActionsOutput struct {
// The list of support actions.
//
// This member is required.
ActionSummaries []types.ActionSummary
// The token for the next page of results, or null if there are no more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListActionsPaginator ¶
type ListActionsPaginator struct {
// contains filtered or unexported fields
}
ListActionsPaginator is a paginator for ListActions
func NewListActionsPaginator ¶
func NewListActionsPaginator(client ListActionsAPIClient, params *ListActionsInput, optFns ...func(*ListActionsPaginatorOptions)) *ListActionsPaginator
NewListActionsPaginator returns a new ListActionsPaginator
func (*ListActionsPaginator) HasMorePages ¶
func (p *ListActionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListActionsPaginator) NextPage ¶
func (p *ListActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListActionsOutput, error)
NextPage retrieves the next ListActions page.
type ListActionsPaginatorOptions ¶
type ListActionsPaginatorOptions struct {
// The maximum number of results to return in a single call. Valid range is 1 to
// 100.
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
}
ListActionsPaginatorOptions is the paginator options for ListActions
type ListSupportPermitRequestsAPIClient ¶
type ListSupportPermitRequestsAPIClient interface {
ListSupportPermitRequests(context.Context, *ListSupportPermitRequestsInput, ...func(*Options)) (*ListSupportPermitRequestsOutput, error)
}
ListSupportPermitRequestsAPIClient is a client that implements the ListSupportPermitRequests operation.
type ListSupportPermitRequestsInput ¶
type ListSupportPermitRequestsInput struct {
// The maximum number of results to return in a single call. Valid range is 1 to
// 100.
MaxResults *int32
// The token for the next page of results.
NextToken *string
// Filters the results by support case display identifier.
SupportCaseDisplayId *string
// contains filtered or unexported fields
}
type ListSupportPermitRequestsOutput ¶
type ListSupportPermitRequestsOutput struct {
// The list of permit requests.
//
// This member is required.
SupportPermitRequests []types.SupportPermitRequest
// The token for the next page of results, or null if there are no more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListSupportPermitRequestsPaginator ¶
type ListSupportPermitRequestsPaginator struct {
// contains filtered or unexported fields
}
ListSupportPermitRequestsPaginator is a paginator for ListSupportPermitRequests
func NewListSupportPermitRequestsPaginator ¶
func NewListSupportPermitRequestsPaginator(client ListSupportPermitRequestsAPIClient, params *ListSupportPermitRequestsInput, optFns ...func(*ListSupportPermitRequestsPaginatorOptions)) *ListSupportPermitRequestsPaginator
NewListSupportPermitRequestsPaginator returns a new ListSupportPermitRequestsPaginator
func (*ListSupportPermitRequestsPaginator) HasMorePages ¶
func (p *ListSupportPermitRequestsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSupportPermitRequestsPaginator) NextPage ¶
func (p *ListSupportPermitRequestsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSupportPermitRequestsOutput, error)
NextPage retrieves the next ListSupportPermitRequests page.
type ListSupportPermitRequestsPaginatorOptions ¶
type ListSupportPermitRequestsPaginatorOptions struct {
// The maximum number of results to return in a single call. Valid range is 1 to
// 100.
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
}
ListSupportPermitRequestsPaginatorOptions is the paginator options for ListSupportPermitRequests
type ListSupportPermitsAPIClient ¶
type ListSupportPermitsAPIClient interface {
ListSupportPermits(context.Context, *ListSupportPermitsInput, ...func(*Options)) (*ListSupportPermitsOutput, error)
}
ListSupportPermitsAPIClient is a client that implements the ListSupportPermits operation.
type ListSupportPermitsInput ¶
type ListSupportPermitsInput struct {
// The maximum number of results to return in a single call. Valid range is 1 to
// 100.
MaxResults *int32
// The token for the next page of results.
NextToken *string
// Filters the results by support permit status. Valid values: ACTIVE, INACTIVE,
// DELETING.
SupportPermitStatuses []types.SupportPermitStatus
// contains filtered or unexported fields
}
type ListSupportPermitsOutput ¶
type ListSupportPermitsOutput struct {
// The list of support permits.
//
// This member is required.
SupportPermits []types.SupportPermitSummary
// The token for the next page of results, or null if there are no more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListSupportPermitsPaginator ¶
type ListSupportPermitsPaginator struct {
// contains filtered or unexported fields
}
ListSupportPermitsPaginator is a paginator for ListSupportPermits
func NewListSupportPermitsPaginator ¶
func NewListSupportPermitsPaginator(client ListSupportPermitsAPIClient, params *ListSupportPermitsInput, optFns ...func(*ListSupportPermitsPaginatorOptions)) *ListSupportPermitsPaginator
NewListSupportPermitsPaginator returns a new ListSupportPermitsPaginator
func (*ListSupportPermitsPaginator) HasMorePages ¶
func (p *ListSupportPermitsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSupportPermitsPaginator) NextPage ¶
func (p *ListSupportPermitsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSupportPermitsOutput, error)
NextPage retrieves the next ListSupportPermits page.
type ListSupportPermitsPaginatorOptions ¶
type ListSupportPermitsPaginatorOptions struct {
// The maximum number of results to return in a single call. Valid range is 1 to
// 100.
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
}
ListSupportPermitsPaginatorOptions is the paginator options for ListSupportPermits
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct {
// The ARN of the resource to list tags for.
//
// This member is required.
ResourceArn *string
// contains filtered or unexported fields
}
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct {
// The tags associated with the resource.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
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
// Disables SDK clock skew correction. When set, the SDK will not adjust request
// signing timestamps to compensate for clock drift between the client and the
// service.
DisableClockSkewCorrection bool
// 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.
EndpointResolverV2 EndpointResolverV2
// Signature Version 4 (SigV4) Signer
HTTPSignerV4 HTTPSignerV4
// Provides idempotency tokens values that will be automatically populated into
// idempotent API operations.
IdempotencyTokenProvider IdempotencyTokenProvider
// 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
// Client registry of operation interceptors.
Interceptors smithyhttp.InterceptorRegistry
// 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
// Priority list of preferred auth scheme names (e.g. sigv4a).
AuthSchemePreference []string
// contains filtered or unexported fields
}
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type RejectSupportPermitRequestInput ¶
type RejectSupportPermitRequestInput struct {
// The ARN of the permit request to reject.
//
// This member is required.
RequestArn *string
// contains filtered or unexported fields
}
type RejectSupportPermitRequestOutput ¶
type RejectSupportPermitRequestOutput struct {
// The ARN of the rejected permit request.
//
// This member is required.
RequestArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
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
type TagResourceInput ¶
type TagResourceOutput ¶
type TagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Source Files
¶
- api_client.go
- api_op_CreateSupportPermit.go
- api_op_DeleteSupportPermit.go
- api_op_GetAction.go
- api_op_GetSupportPermit.go
- api_op_ListActions.go
- api_op_ListSupportPermitRequests.go
- api_op_ListSupportPermits.go
- api_op_ListTagsForResource.go
- api_op_RejectSupportPermitRequest.go
- api_op_TagResource.go
- api_op_UntagResource.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go