route53profiles

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Apr 22, 2024 License: Apache-2.0 Imports: 40 Imported by: 3

Documentation

Overview

Package route53profiles provides the API client, operations, and parameter types for Route 53 Profiles.

With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-10"
View Source 
const ServiceID = "Route53Profiles"

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 

func WithSigV4SigningName(name string) func(*Options)

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 

func WithSigV4SigningRegion(region string) func(*Options)

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 AssociateProfileInput 

type AssociateProfileInput struct {

	// A name for the association.
	//
	// This member is required.
	Name *string

	// ID of the Profile.
	//
	// This member is required.
	ProfileId *string

	// The ID of the VPC.
	//
	// This member is required.
	ResourceId *string

	// A list of the tag keys and values that you want to identify the Profile
	// association.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type AssociateProfileOutput 

type AssociateProfileOutput struct {

	// The association that you just created. The association has an ID that you can
	// use to identify it in other requests, like update and delete.
	ProfileAssociation *types.ProfileAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateResourceToProfileInput 

type AssociateResourceToProfileInput struct {

	// Name for the resource association.
	//
	// This member is required.
	Name *string

	// ID of the Profile.
	//
	// This member is required.
	ProfileId *string

	// Amazon resource number, ARN, of the DNS resource.
	//
	// This member is required.
	ResourceArn *string

	// If you are adding a DNS Firewall rule group, include also a priority in this
	// format: Key=FirewallRuleGroupPriority,Value=100
	ResourceProperties *string
	// contains filtered or unexported fields
}

type AssociateResourceToProfileOutput 

type AssociateResourceToProfileOutput struct {

	// Infromation about the AssociateResourceToProfile , including a status message.
	ProfileResourceAssociation *types.ProfileResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 Route 53 Profiles.

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

func (c *Client) AssociateProfile(ctx context.Context, params *AssociateProfileInput, optFns ...func(*Options)) (*AssociateProfileOutput, error)

Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with up to 5000 VPCs.

func (*Client) AssociateResourceToProfile 

func (c *Client) AssociateResourceToProfile(ctx context.Context, params *AssociateResourceToProfileInput, optFns ...func(*Options)) (*AssociateResourceToProfileOutput, error)

Associates a DNS reource configuration to a Route 53 Profile.

func (*Client) CreateProfile 

func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, optFns ...func(*Options)) (*CreateProfileOutput, error)

Creates an empty Route 53 Profile.

func (*Client) DeleteProfile 

func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, optFns ...func(*Options)) (*DeleteProfileOutput, error)

Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.

func (*Client) DisassociateProfile 

func (c *Client) DisassociateProfile(ctx context.Context, params *DisassociateProfileInput, optFns ...func(*Options)) (*DisassociateProfileOutput, error)

Dissociates a specified Route 53 Profile from the specified VPC.

func (*Client) DisassociateResourceFromProfile 

func (c *Client) DisassociateResourceFromProfile(ctx context.Context, params *DisassociateResourceFromProfileInput, optFns ...func(*Options)) (*DisassociateResourceFromProfileOutput, error)

Dissoaciated a specified resource, from the Route 53 Profile.

func (*Client) GetProfile 

func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error)

Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.

func (*Client) GetProfileAssociation 

func (c *Client) GetProfileAssociation(ctx context.Context, params *GetProfileAssociationInput, optFns ...func(*Options)) (*GetProfileAssociationOutput, error)

Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.

func (*Client) GetProfileResourceAssociation 

func (c *Client) GetProfileResourceAssociation(ctx context.Context, params *GetProfileResourceAssociationInput, optFns ...func(*Options)) (*GetProfileResourceAssociationOutput, error)

Returns information about a specified Route 53 Profile resource association.

func (*Client) ListProfileAssociations 

func (c *Client) ListProfileAssociations(ctx context.Context, params *ListProfileAssociationsInput, optFns ...func(*Options)) (*ListProfileAssociationsOutput, error)

Lists all the VPCs that the specified Route 53 Profile is associated with.

func (*Client) ListProfileResourceAssociations 

func (c *Client) ListProfileResourceAssociations(ctx context.Context, params *ListProfileResourceAssociationsInput, optFns ...func(*Options)) (*ListProfileResourceAssociationsOutput, error)

Lists all the resource associations for the specified Route 53 Profile.

func (*Client) ListProfiles 

func (c *Client) ListProfiles(ctx context.Context, params *ListProfilesInput, optFns ...func(*Options)) (*ListProfilesOutput, error)

Lists all the Route 53 Profiles associated with your Amazon Web Services account.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags that you associated with the specified resource.

func (*Client) Options 

func (c *Client) Options() 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) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds one or more tags to a specified 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 specified resource.

func (*Client) UpdateProfileResourceAssociation 

func (c *Client) UpdateProfileResourceAssociation(ctx context.Context, params *UpdateProfileResourceAssociationInput, optFns ...func(*Options)) (*UpdateProfileResourceAssociationOutput, error)

Updates the specified Route 53 Profile resourse association.

type CreateProfileInput 

type CreateProfileInput struct {

	// ClientToken is an idempotency token that ensures a call to CreateProfile
	// completes only once. You choose the value to pass. For example, an issue might
	// prevent you from getting a response from CreateProfile . In this case, safely
	// retry your call to CreateProfile by using the same CreateProfile parameter
	// value.
	//
	// This member is required.
	ClientToken *string

	// A name for the Profile.
	//
	// This member is required.
	Name *string

	// A list of the tag keys and values that you want to associate with the Route 53
	// Profile.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateProfileOutput 

type CreateProfileOutput struct {

	// The Profile that you just created.
	Profile *types.Profile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProfileInput 

type DeleteProfileInput struct {

	// The ID of the Profile that you want to delete.
	//
	// This member is required.
	ProfileId *string
	// contains filtered or unexported fields
}

type DeleteProfileOutput 

type DeleteProfileOutput struct {

	// Information about the DeleteProfile request, including the status of the
	// request.
	Profile *types.Profile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateProfileInput 

type DisassociateProfileInput struct {

	// ID of the Profile.
	//
	// This member is required.
	ProfileId *string

	// The ID of the VPC.
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type DisassociateProfileOutput 

type DisassociateProfileOutput struct {

	// Information about the DisassociateProfile request.
	ProfileAssociation *types.ProfileAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateResourceFromProfileInput 

type DisassociateResourceFromProfileInput struct {

	// The ID of the Profile.
	//
	// This member is required.
	ProfileId *string

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DisassociateResourceFromProfileOutput 

type DisassociateResourceFromProfileOutput struct {

	// Information about the DisassociateResourceFromProfile request, including the
	// status of the request.
	ProfileResourceAssociation *types.ProfileResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

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 attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetProfileAssociationInput 

type GetProfileAssociationInput struct {

	// The identifier of the association you want to get information about.
	//
	// This member is required.
	ProfileAssociationId *string
	// contains filtered or unexported fields
}

type GetProfileAssociationOutput 

type GetProfileAssociationOutput struct {

	// Information about the Profile association that you specified in a
	// GetProfileAssociation request.
	ProfileAssociation *types.ProfileAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetProfileInput 

type GetProfileInput struct {

	// ID of the Profile.
	//
	// This member is required.
	ProfileId *string
	// contains filtered or unexported fields
}

type GetProfileOutput 

type GetProfileOutput struct {

	// Information about the Profile, including the status of the Profile.
	Profile *types.Profile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetProfileResourceAssociationInput 

type GetProfileResourceAssociationInput struct {

	// The ID of the profile resource association that you want to get information
	// about.
	//
	// This member is required.
	ProfileResourceAssociationId *string
	// contains filtered or unexported fields
}

type GetProfileResourceAssociationOutput 

type GetProfileResourceAssociationOutput struct {

	// Information about the Profile resource association that you specified in a
	// GetProfileResourceAssociation request.
	ProfileResourceAssociation *types.ProfileResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListProfileAssociationsAPIClient 

type ListProfileAssociationsAPIClient interface {
	ListProfileAssociations(context.Context, *ListProfileAssociationsInput, ...func(*Options)) (*ListProfileAssociationsOutput, error)
}

ListProfileAssociationsAPIClient is a client that implements the ListProfileAssociations operation.

type ListProfileAssociationsInput 

type ListProfileAssociationsInput struct {

	// The maximum number of objects that you want to return for this request. If more
	// objects are available, in the response, a NextToken value, which you can use in
	// a subsequent call to get the next batch of objects, is provided. If you don't
	// specify a value for MaxResults , up to 100 objects are returned.
	MaxResults *int32

	// For the first call to this list request, omit this value. When you request a
	// list of objects, at most the number of objects specified by MaxResults is
	// returned. If more objects are available for retrieval, a NextToken value is
	// returned in the response. To retrieve the next batch of objects, use the token
	// that was returned for the prior request in your next request.
	NextToken *string

	// ID of the Profile.
	ProfileId *string

	// ID of the VPC.
	ResourceId *string
	// contains filtered or unexported fields
}

type ListProfileAssociationsOutput 

type ListProfileAssociationsOutput struct {

	// If more than MaxResults profile associations match the specified criteria, you
	// can submit another ListProfileAssociations request to get the next group of
	// results. In the next request, specify the value of NextToken from the previous
	// response.
	NextToken *string

	// A complex type that containts settings information about the profile's VPC
	// associations.
	ProfileAssociations []types.ProfileAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProfileAssociationsPaginator 

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

ListProfileAssociationsPaginator is a paginator for ListProfileAssociations

func NewListProfileAssociationsPaginator 

func NewListProfileAssociationsPaginator(client ListProfileAssociationsAPIClient, params *ListProfileAssociationsInput, optFns ...func(*ListProfileAssociationsPaginatorOptions)) *ListProfileAssociationsPaginator

NewListProfileAssociationsPaginator returns a new ListProfileAssociationsPaginator

func (*ListProfileAssociationsPaginator) HasMorePages 

func (p *ListProfileAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProfileAssociationsPaginator) NextPage 

func (p *ListProfileAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProfileAssociationsOutput, error)

NextPage retrieves the next ListProfileAssociations page.

type ListProfileAssociationsPaginatorOptions 

type ListProfileAssociationsPaginatorOptions struct {
	// The maximum number of objects that you want to return for this request. If more
	// objects are available, in the response, a NextToken value, which you can use in
	// a subsequent call to get the next batch of objects, is provided. If you don't
	// specify a value for MaxResults , up to 100 objects are returned.
	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
}

ListProfileAssociationsPaginatorOptions is the paginator options for ListProfileAssociations

type ListProfileResourceAssociationsAPIClient 

type ListProfileResourceAssociationsAPIClient interface {
	ListProfileResourceAssociations(context.Context, *ListProfileResourceAssociationsInput, ...func(*Options)) (*ListProfileResourceAssociationsOutput, error)
}

ListProfileResourceAssociationsAPIClient is a client that implements the ListProfileResourceAssociations operation.

type ListProfileResourceAssociationsInput 

type ListProfileResourceAssociationsInput struct {

	// The ID of the Profile.
	//
	// This member is required.
	ProfileId *string

	// The maximum number of objects that you want to return for this request. If more
	// objects are available, in the response, a NextToken value, which you can use in
	// a subsequent call to get the next batch of objects, is provided. If you don't
	// specify a value for MaxResults , up to 100 objects are returned.
	MaxResults *int32

	// For the first call to this list request, omit this value. When you request a
	// list of objects, at most the number of objects specified by MaxResults is
	// returned. If more objects are available for retrieval, a NextToken value is
	// returned in the response. To retrieve the next batch of objects, use the token
	// that was returned for the prior request in your next request.
	NextToken *string

	// ID of a resource if you want information on only one type.
	ResourceType *string
	// contains filtered or unexported fields
}

type ListProfileResourceAssociationsOutput 

type ListProfileResourceAssociationsOutput struct {

	// If more than MaxResults resource associations match the specified criteria, you
	// can submit another ListProfileResourceAssociations request to get the next
	// group of results. In the next request, specify the value of NextToken from the
	// previous response.
	NextToken *string

	// Information about the profile resource association that you specified in a
	// GetProfileResourceAssociation request.
	ProfileResourceAssociations []types.ProfileResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProfileResourceAssociationsPaginator 

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

ListProfileResourceAssociationsPaginator is a paginator for ListProfileResourceAssociations

func NewListProfileResourceAssociationsPaginator 

func NewListProfileResourceAssociationsPaginator(client ListProfileResourceAssociationsAPIClient, params *ListProfileResourceAssociationsInput, optFns ...func(*ListProfileResourceAssociationsPaginatorOptions)) *ListProfileResourceAssociationsPaginator

NewListProfileResourceAssociationsPaginator returns a new ListProfileResourceAssociationsPaginator

func (*ListProfileResourceAssociationsPaginator) HasMorePages 

func (p *ListProfileResourceAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProfileResourceAssociationsPaginator) NextPage 

func (p *ListProfileResourceAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProfileResourceAssociationsOutput, error)

NextPage retrieves the next ListProfileResourceAssociations page.

type ListProfileResourceAssociationsPaginatorOptions 

type ListProfileResourceAssociationsPaginatorOptions struct {
	// The maximum number of objects that you want to return for this request. If more
	// objects are available, in the response, a NextToken value, which you can use in
	// a subsequent call to get the next batch of objects, is provided. If you don't
	// specify a value for MaxResults , up to 100 objects are returned.
	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
}

ListProfileResourceAssociationsPaginatorOptions is the paginator options for ListProfileResourceAssociations

type ListProfilesAPIClient 

type ListProfilesAPIClient interface {
	ListProfiles(context.Context, *ListProfilesInput, ...func(*Options)) (*ListProfilesOutput, error)
}

ListProfilesAPIClient is a client that implements the ListProfiles operation.

type ListProfilesInput 

type ListProfilesInput struct {

	// The maximum number of objects that you want to return for this request. If more
	// objects are available, in the response, a NextToken value, which you can use in
	// a subsequent call to get the next batch of objects, is provided. If you don't
	// specify a value for MaxResults , up to 100 objects are returned.
	MaxResults *int32

	// For the first call to this list request, omit this value. When you request a
	// list of objects, at most the number of objects specified by MaxResults is
	// returned. If more objects are available for retrieval, a NextToken value is
	// returned in the response. To retrieve the next batch of objects, use the token
	// that was returned for the prior request in your next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProfilesOutput 

type ListProfilesOutput struct {

	// If more than MaxResults resource associations match the specified criteria, you
	// can submit another ListProfiles request to get the next group of results. In
	// the next request, specify the value of NextToken from the previous response.
	NextToken *string

	// Summary information about the Profiles.
	ProfileSummaries []types.ProfileSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProfilesPaginator 

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

ListProfilesPaginator is a paginator for ListProfiles

func NewListProfilesPaginator 

func NewListProfilesPaginator(client ListProfilesAPIClient, params *ListProfilesInput, optFns ...func(*ListProfilesPaginatorOptions)) *ListProfilesPaginator

NewListProfilesPaginator returns a new ListProfilesPaginator

func (*ListProfilesPaginator) HasMorePages 

func (p *ListProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProfilesPaginator) NextPage 

func (p *ListProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProfilesOutput, error)

NextPage retrieves the next ListProfiles page.

type ListProfilesPaginatorOptions 

type ListProfilesPaginatorOptions struct {
	// The maximum number of objects that you want to return for this request. If more
	// objects are available, in the response, a NextToken value, which you can use in
	// a subsequent call to get the next batch of objects, is provided. If you don't
	// specify a value for MaxResults , up to 100 objects are returned.
	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
}

ListProfilesPaginatorOptions is the paginator options for ListProfiles

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) for the resource that you want to list the tags
	// for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags that are associated with the resource that you specified in the
	// ListTagsForResource request.
	//
	// This member is required.
	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

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// 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 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 HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

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 TagResourceInput struct {

	// The Amazon Resource Name (ARN) for the resource that you want to add tags to.
	//
	// This member is required.
	ResourceArn *string

	// The tags that you want to add to the specified resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) for the resource that you want to remove tags
	// from.
	//
	// This member is required.
	ResourceArn *string

	// The tags that you want to remove to the specified resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateProfileResourceAssociationInput 

type UpdateProfileResourceAssociationInput struct {

	// ID of the resource association.
	//
	// This member is required.
	ProfileResourceAssociationId *string

	// Name of the resource association.
	Name *string

	// If you are adding a DNS Firewall rule group, include also a priority in this
	// format: Key=FirewallRuleGroupPriority,Value=100 .
	ResourceProperties *string
	// contains filtered or unexported fields
}

type UpdateProfileResourceAssociationOutput 

type UpdateProfileResourceAssociationOutput struct {

	// Information about the UpdateProfileResourceAssociation request, including a
	// status message.
	ProfileResourceAssociation *types.ProfileResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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