kafkaconnect

package module
v1.17.3 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 38 Imported by: 4

Documentation

Overview

Package kafkaconnect provides the API client, operations, and parameter types for Managed Streaming for Kafka Connect.

Index

Constants

View Source 
const ServiceAPIVersion = "2021-09-14"
View Source 
const ServiceID = "KafkaConnect"

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 added in v1.10.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.13.2 

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 added in v1.13.2 

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 AuthResolverParameters added in v1.13.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.13.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for Managed Streaming for Kafka Connect.

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

func (c *Client) CreateConnector(ctx context.Context, params *CreateConnectorInput, optFns ...func(*Options)) (*CreateConnectorOutput, error)

Creates a connector using the specified properties.

func (*Client) CreateCustomPlugin 

func (c *Client) CreateCustomPlugin(ctx context.Context, params *CreateCustomPluginInput, optFns ...func(*Options)) (*CreateCustomPluginOutput, error)

Creates a custom plugin using the specified properties.

func (*Client) CreateWorkerConfiguration 

func (c *Client) CreateWorkerConfiguration(ctx context.Context, params *CreateWorkerConfigurationInput, optFns ...func(*Options)) (*CreateWorkerConfigurationOutput, error)

Creates a worker configuration using the specified properties.

func (*Client) DeleteConnector 

func (c *Client) DeleteConnector(ctx context.Context, params *DeleteConnectorInput, optFns ...func(*Options)) (*DeleteConnectorOutput, error)

Deletes the specified connector.

func (*Client) DeleteCustomPlugin added in v1.8.0 

func (c *Client) DeleteCustomPlugin(ctx context.Context, params *DeleteCustomPluginInput, optFns ...func(*Options)) (*DeleteCustomPluginOutput, error)

Deletes a custom plugin.

func (*Client) DeleteWorkerConfiguration added in v1.17.0 

func (c *Client) DeleteWorkerConfiguration(ctx context.Context, params *DeleteWorkerConfigurationInput, optFns ...func(*Options)) (*DeleteWorkerConfigurationOutput, error)

Deletes the specified worker configuration.

func (*Client) DescribeConnector 

func (c *Client) DescribeConnector(ctx context.Context, params *DescribeConnectorInput, optFns ...func(*Options)) (*DescribeConnectorOutput, error)

Returns summary information about the connector.

func (*Client) DescribeCustomPlugin 

func (c *Client) DescribeCustomPlugin(ctx context.Context, params *DescribeCustomPluginInput, optFns ...func(*Options)) (*DescribeCustomPluginOutput, error)

A summary description of the custom plugin.

func (*Client) DescribeWorkerConfiguration 

func (c *Client) DescribeWorkerConfiguration(ctx context.Context, params *DescribeWorkerConfigurationInput, optFns ...func(*Options)) (*DescribeWorkerConfigurationOutput, error)

Returns information about a worker configuration.

func (*Client) ListConnectors 

func (c *Client) ListConnectors(ctx context.Context, params *ListConnectorsInput, optFns ...func(*Options)) (*ListConnectorsOutput, error)

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

func (*Client) ListCustomPlugins 

func (c *Client) ListCustomPlugins(ctx context.Context, params *ListCustomPluginsInput, optFns ...func(*Options)) (*ListCustomPluginsOutput, error)

Returns a list of all of the custom plugins in this account and Region.

func (*Client) ListTagsForResource added in v1.17.0 

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

Lists all the tags attached to the specified resource.

func (*Client) ListWorkerConfigurations 

func (c *Client) ListWorkerConfigurations(ctx context.Context, params *ListWorkerConfigurationsInput, optFns ...func(*Options)) (*ListWorkerConfigurationsOutput, error)

Returns a list of all of the worker configurations in this account and Region.

func (*Client) Options added in v1.14.0 

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 added in v1.17.0 

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

Attaches tags to the specified resource.

func (*Client) UntagResource added in v1.17.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from the specified resource.

func (*Client) UpdateConnector 

func (c *Client) UpdateConnector(ctx context.Context, params *UpdateConnectorInput, optFns ...func(*Options)) (*UpdateConnectorOutput, error)

Updates the specified connector.

type CreateConnectorInput 

type CreateConnectorInput struct {

	// Information about the capacity allocated to the connector. Exactly one of the
	// two properties must be specified.
	//
	// This member is required.
	Capacity *types.Capacity

	// A map of keys to values that represent the configuration for the connector.
	//
	// This member is required.
	ConnectorConfiguration map[string]string

	// The name of the connector.
	//
	// This member is required.
	ConnectorName *string

	// Specifies which Apache Kafka cluster to connect to.
	//
	// This member is required.
	KafkaCluster *types.KafkaCluster

	// Details of the client authentication used by the Apache Kafka cluster.
	//
	// This member is required.
	KafkaClusterClientAuthentication *types.KafkaClusterClientAuthentication

	// Details of encryption in transit to the Apache Kafka cluster.
	//
	// This member is required.
	KafkaClusterEncryptionInTransit *types.KafkaClusterEncryptionInTransit

	// The version of Kafka Connect. It has to be compatible with both the Apache
	// Kafka cluster's version and the plugins.
	//
	// This member is required.
	KafkaConnectVersion *string

	// Amazon MSK Connect does not currently support specifying multiple plugins as a
	// list. To use more than one plugin for your connector, you can create a single
	// custom plugin using a ZIP file that bundles multiple plugins together. Specifies
	// which plugin to use for the connector. You must specify a single-element list
	// containing one customPlugin object.
	//
	// This member is required.
	Plugins []types.Plugin

	// The Amazon Resource Name (ARN) of the IAM role used by the connector to access
	// the Amazon Web Services resources that it needs. The types of resources depends
	// on the logic of the connector. For example, a connector that has Amazon S3 as a
	// destination must have permissions that allow it to write to the S3 destination
	// bucket.
	//
	// This member is required.
	ServiceExecutionRoleArn *string

	// A summary description of the connector.
	ConnectorDescription *string

	// Details about log delivery.
	LogDelivery *types.LogDelivery

	// The tags you want to attach to the connector.
	Tags map[string]string

	// Specifies which worker configuration to use with the connector.
	WorkerConfiguration *types.WorkerConfiguration
	// contains filtered or unexported fields
}

type CreateConnectorOutput 

type CreateConnectorOutput struct {

	// The Amazon Resource Name (ARN) that Amazon assigned to the connector.
	ConnectorArn *string

	// The name of the connector.
	ConnectorName *string

	// The state of the connector.
	ConnectorState types.ConnectorState

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

type CreateCustomPluginInput 

type CreateCustomPluginInput struct {

	// The type of the plugin file.
	//
	// This member is required.
	ContentType types.CustomPluginContentType

	// Information about the location of a custom plugin.
	//
	// This member is required.
	Location *types.CustomPluginLocation

	// The name of the custom plugin.
	//
	// This member is required.
	Name *string

	// A summary description of the custom plugin.
	Description *string

	// The tags you want to attach to the custom plugin.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateCustomPluginOutput 

type CreateCustomPluginOutput struct {

	// The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.
	CustomPluginArn *string

	// The state of the custom plugin.
	CustomPluginState types.CustomPluginState

	// The name of the custom plugin.
	Name *string

	// The revision of the custom plugin.
	Revision int64

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

type CreateWorkerConfigurationInput 

type CreateWorkerConfigurationInput struct {

	// The name of the worker configuration.
	//
	// This member is required.
	Name *string

	// Base64 encoded contents of connect-distributed.properties file.
	//
	// This member is required.
	PropertiesFileContent *string

	// A summary description of the worker configuration.
	Description *string

	// The tags you want to attach to the worker configuration.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateWorkerConfigurationOutput 

type CreateWorkerConfigurationOutput struct {

	// The time that the worker configuration was created.
	CreationTime *time.Time

	// The latest revision of the worker configuration.
	LatestRevision *types.WorkerConfigurationRevisionSummary

	// The name of the worker configuration.
	Name *string

	// The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration.
	WorkerConfigurationArn *string

	// The state of the worker configuration.
	WorkerConfigurationState types.WorkerConfigurationState

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

type DeleteConnectorInput 

type DeleteConnectorInput struct {

	// The Amazon Resource Name (ARN) of the connector that you want to delete.
	//
	// This member is required.
	ConnectorArn *string

	// The current version of the connector that you want to delete.
	CurrentVersion *string
	// contains filtered or unexported fields
}

type DeleteConnectorOutput 

type DeleteConnectorOutput struct {

	// The Amazon Resource Name (ARN) of the connector that you requested to delete.
	ConnectorArn *string

	// The state of the connector that you requested to delete.
	ConnectorState types.ConnectorState

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

type DeleteCustomPluginInput added in v1.8.0 

type DeleteCustomPluginInput struct {

	// The Amazon Resource Name (ARN) of the custom plugin that you want to delete.
	//
	// This member is required.
	CustomPluginArn *string
	// contains filtered or unexported fields
}

type DeleteCustomPluginOutput added in v1.8.0 

type DeleteCustomPluginOutput struct {

	// The Amazon Resource Name (ARN) of the custom plugin that you requested to
	// delete.
	CustomPluginArn *string

	// The state of the custom plugin.
	CustomPluginState types.CustomPluginState

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

type DeleteWorkerConfigurationInput added in v1.17.0 

type DeleteWorkerConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the worker configuration that you want to
	// delete.
	//
	// This member is required.
	WorkerConfigurationArn *string
	// contains filtered or unexported fields
}

type DeleteWorkerConfigurationOutput added in v1.17.0 

type DeleteWorkerConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the worker configuration that you requested
	// to delete.
	WorkerConfigurationArn *string

	// The state of the worker configuration.
	WorkerConfigurationState types.WorkerConfigurationState

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

type DescribeConnectorInput 

type DescribeConnectorInput struct {

	// The Amazon Resource Name (ARN) of the connector that you want to describe.
	//
	// This member is required.
	ConnectorArn *string
	// contains filtered or unexported fields
}

type DescribeConnectorOutput 

type DescribeConnectorOutput struct {

	// Information about the capacity of the connector, whether it is auto scaled or
	// provisioned.
	Capacity *types.CapacityDescription

	// The Amazon Resource Name (ARN) of the connector.
	ConnectorArn *string

	// A map of keys to values that represent the configuration for the connector.
	ConnectorConfiguration map[string]string

	// A summary description of the connector.
	ConnectorDescription *string

	// The name of the connector.
	ConnectorName *string

	// The state of the connector.
	ConnectorState types.ConnectorState

	// The time the connector was created.
	CreationTime *time.Time

	// The current version of the connector.
	CurrentVersion *string

	// The Apache Kafka cluster that the connector is connected to.
	KafkaCluster *types.KafkaClusterDescription

	// The type of client authentication used to connect to the Apache Kafka cluster.
	// The value is NONE when no client authentication is used.
	KafkaClusterClientAuthentication *types.KafkaClusterClientAuthenticationDescription

	// Details of encryption in transit to the Apache Kafka cluster.
	KafkaClusterEncryptionInTransit *types.KafkaClusterEncryptionInTransitDescription

	// The version of Kafka Connect. It has to be compatible with both the Apache
	// Kafka cluster's version and the plugins.
	KafkaConnectVersion *string

	// Details about delivering logs to Amazon CloudWatch Logs.
	LogDelivery *types.LogDeliveryDescription

	// Specifies which plugins were used for this connector.
	Plugins []types.PluginDescription

	// The Amazon Resource Name (ARN) of the IAM role used by the connector to access
	// Amazon Web Services resources.
	ServiceExecutionRoleArn *string

	// Details about the state of a connector.
	StateDescription *types.StateDescription

	// Specifies which worker configuration was used for the connector.
	WorkerConfiguration *types.WorkerConfigurationDescription

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

type DescribeCustomPluginInput 

type DescribeCustomPluginInput struct {

	// Returns information about a custom plugin.
	//
	// This member is required.
	CustomPluginArn *string
	// contains filtered or unexported fields
}

type DescribeCustomPluginOutput 

type DescribeCustomPluginOutput struct {

	// The time that the custom plugin was created.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the custom plugin.
	CustomPluginArn *string

	// The state of the custom plugin.
	CustomPluginState types.CustomPluginState

	// The description of the custom plugin.
	Description *string

	// The latest successfully created revision of the custom plugin. If there are no
	// successfully created revisions, this field will be absent.
	LatestRevision *types.CustomPluginRevisionSummary

	// The name of the custom plugin.
	Name *string

	// Details about the state of a custom plugin.
	StateDescription *types.StateDescription

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

type DescribeWorkerConfigurationInput 

type DescribeWorkerConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the worker configuration that you want to get
	// information about.
	//
	// This member is required.
	WorkerConfigurationArn *string
	// contains filtered or unexported fields
}

type DescribeWorkerConfigurationOutput 

type DescribeWorkerConfigurationOutput struct {

	// The time that the worker configuration was created.
	CreationTime *time.Time

	// The description of the worker configuration.
	Description *string

	// The latest revision of the custom configuration.
	LatestRevision *types.WorkerConfigurationRevisionDescription

	// The name of the worker configuration.
	Name *string

	// The Amazon Resource Name (ARN) of the custom configuration.
	WorkerConfigurationArn *string

	// The state of the worker configuration.
	WorkerConfigurationState types.WorkerConfigurationState

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

type EndpointParameters added in v1.10.0 

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.10.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.10.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

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 added in v1.10.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.10.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

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 ListConnectorsAPIClient 

type ListConnectorsAPIClient interface {
	ListConnectors(context.Context, *ListConnectorsInput, ...func(*Options)) (*ListConnectorsOutput, error)
}

ListConnectorsAPIClient is a client that implements the ListConnectors operation.

type ListConnectorsInput 

type ListConnectorsInput struct {

	// The name prefix that you want to use to search for and list connectors.
	ConnectorNamePrefix *string

	// The maximum number of connectors to list in one response.
	MaxResults int32

	// If the response of a ListConnectors operation is truncated, it will include a
	// NextToken. Send this NextToken in a subsequent request to continue listing from
	// where the previous operation left off.
	NextToken *string
	// contains filtered or unexported fields
}

type ListConnectorsOutput 

type ListConnectorsOutput struct {

	// An array of connector descriptions.
	Connectors []types.ConnectorSummary

	// If the response of a ListConnectors operation is truncated, it will include a
	// NextToken. Send this NextToken in a subsequent request to continue listing from
	// where it left off.
	NextToken *string

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

type ListConnectorsPaginator 

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

ListConnectorsPaginator is a paginator for ListConnectors

func NewListConnectorsPaginator 

func NewListConnectorsPaginator(client ListConnectorsAPIClient, params *ListConnectorsInput, optFns ...func(*ListConnectorsPaginatorOptions)) *ListConnectorsPaginator

NewListConnectorsPaginator returns a new ListConnectorsPaginator

func (*ListConnectorsPaginator) HasMorePages 

func (p *ListConnectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConnectorsPaginator) NextPage 

func (p *ListConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConnectorsOutput, error)

NextPage retrieves the next ListConnectors page.

type ListConnectorsPaginatorOptions 

type ListConnectorsPaginatorOptions struct {
	// The maximum number of connectors to list in one response.
	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
}

ListConnectorsPaginatorOptions is the paginator options for ListConnectors

type ListCustomPluginsAPIClient 

type ListCustomPluginsAPIClient interface {
	ListCustomPlugins(context.Context, *ListCustomPluginsInput, ...func(*Options)) (*ListCustomPluginsOutput, error)
}

ListCustomPluginsAPIClient is a client that implements the ListCustomPlugins operation.

type ListCustomPluginsInput 

type ListCustomPluginsInput struct {

	// The maximum number of custom plugins to list in one response.
	MaxResults int32

	// Lists custom plugin names that start with the specified text string.
	NamePrefix *string

	// If the response of a ListCustomPlugins operation is truncated, it will include
	// a NextToken. Send this NextToken in a subsequent request to continue listing
	// from where the previous operation left off.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomPluginsOutput 

type ListCustomPluginsOutput struct {

	// An array of custom plugin descriptions.
	CustomPlugins []types.CustomPluginSummary

	// If the response of a ListCustomPlugins operation is truncated, it will include
	// a NextToken. Send this NextToken in a subsequent request to continue listing
	// from where the previous operation left off.
	NextToken *string

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

type ListCustomPluginsPaginator 

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

ListCustomPluginsPaginator is a paginator for ListCustomPlugins

func NewListCustomPluginsPaginator 

func NewListCustomPluginsPaginator(client ListCustomPluginsAPIClient, params *ListCustomPluginsInput, optFns ...func(*ListCustomPluginsPaginatorOptions)) *ListCustomPluginsPaginator

NewListCustomPluginsPaginator returns a new ListCustomPluginsPaginator

func (*ListCustomPluginsPaginator) HasMorePages 

func (p *ListCustomPluginsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomPluginsPaginator) NextPage 

func (p *ListCustomPluginsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomPluginsOutput, error)

NextPage retrieves the next ListCustomPlugins page.

type ListCustomPluginsPaginatorOptions 

type ListCustomPluginsPaginatorOptions struct {
	// The maximum number of custom plugins to list in one response.
	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
}

ListCustomPluginsPaginatorOptions is the paginator options for ListCustomPlugins

type ListTagsForResourceInput added in v1.17.0 

type ListTagsForResourceInput struct {

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

type ListTagsForResourceOutput added in v1.17.0 

type ListTagsForResourceOutput struct {

	// Lists the tags attached to the specified resource in the corresponding request.
	Tags map[string]string

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

type ListWorkerConfigurationsAPIClient 

type ListWorkerConfigurationsAPIClient interface {
	ListWorkerConfigurations(context.Context, *ListWorkerConfigurationsInput, ...func(*Options)) (*ListWorkerConfigurationsOutput, error)
}

ListWorkerConfigurationsAPIClient is a client that implements the ListWorkerConfigurations operation.

type ListWorkerConfigurationsInput 

type ListWorkerConfigurationsInput struct {

	// The maximum number of worker configurations to list in one response.
	MaxResults int32

	// Lists worker configuration names that start with the specified text string.
	NamePrefix *string

	// If the response of a ListWorkerConfigurations operation is truncated, it will
	// include a NextToken. Send this NextToken in a subsequent request to continue
	// listing from where the previous operation left off.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWorkerConfigurationsOutput 

type ListWorkerConfigurationsOutput struct {

	// If the response of a ListWorkerConfigurations operation is truncated, it will
	// include a NextToken. Send this NextToken in a subsequent request to continue
	// listing from where the previous operation left off.
	NextToken *string

	// An array of worker configuration descriptions.
	WorkerConfigurations []types.WorkerConfigurationSummary

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

type ListWorkerConfigurationsPaginator 

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

ListWorkerConfigurationsPaginator is a paginator for ListWorkerConfigurations

func NewListWorkerConfigurationsPaginator 

func NewListWorkerConfigurationsPaginator(client ListWorkerConfigurationsAPIClient, params *ListWorkerConfigurationsInput, optFns ...func(*ListWorkerConfigurationsPaginatorOptions)) *ListWorkerConfigurationsPaginator

NewListWorkerConfigurationsPaginator returns a new ListWorkerConfigurationsPaginator

func (*ListWorkerConfigurationsPaginator) HasMorePages 

func (p *ListWorkerConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkerConfigurationsPaginator) NextPage 

func (p *ListWorkerConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkerConfigurationsOutput, error)

NextPage retrieves the next ListWorkerConfigurations page.

type ListWorkerConfigurationsPaginatorOptions 

type ListWorkerConfigurationsPaginatorOptions struct {
	// The maximum number of worker configurations to list in one response.
	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
}

ListWorkerConfigurationsPaginatorOptions is the paginator options for ListWorkerConfigurations

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The 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 added in v1.13.2 

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 added in v1.17.0 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to which you want to attach tags.
	//
	// This member is required.
	ResourceArn *string

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

type TagResourceOutput added in v1.17.0 

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

type UntagResourceInput added in v1.17.0 

type UntagResourceInput struct {

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

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

type UntagResourceOutput added in v1.17.0 

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

type UpdateConnectorInput 

type UpdateConnectorInput struct {

	// The target capacity.
	//
	// This member is required.
	Capacity *types.CapacityUpdate

	// The Amazon Resource Name (ARN) of the connector that you want to update.
	//
	// This member is required.
	ConnectorArn *string

	// The current version of the connector that you want to update.
	//
	// This member is required.
	CurrentVersion *string
	// contains filtered or unexported fields
}

type UpdateConnectorOutput 

type UpdateConnectorOutput struct {

	// The Amazon Resource Name (ARN) of the connector.
	ConnectorArn *string

	// The state of the connector.
	ConnectorState types.ConnectorState

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