Documentation ¶
Overview ¶
Package appintegrations provides the API client, operations, and parameter types for Amazon AppIntegrations Service.
The Amazon AppIntegrations service enables you to configure and reuse connections to external applications. For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations (https://docs.aws.amazon.com/connect/latest/adminguide/crm.html) and Deliver information to agents using Amazon Connect Wisdom (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-wisdom.html) in the Amazon Connect Administrator Guide.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func (c *Client) CreateDataIntegration(ctx context.Context, params *CreateDataIntegrationInput, ...) (*CreateDataIntegrationOutput, error)
- func (c *Client) CreateEventIntegration(ctx context.Context, params *CreateEventIntegrationInput, ...) (*CreateEventIntegrationOutput, error)
- func (c *Client) DeleteDataIntegration(ctx context.Context, params *DeleteDataIntegrationInput, ...) (*DeleteDataIntegrationOutput, error)
- func (c *Client) DeleteEventIntegration(ctx context.Context, params *DeleteEventIntegrationInput, ...) (*DeleteEventIntegrationOutput, error)
- func (c *Client) GetDataIntegration(ctx context.Context, params *GetDataIntegrationInput, optFns ...func(*Options)) (*GetDataIntegrationOutput, error)
- func (c *Client) GetEventIntegration(ctx context.Context, params *GetEventIntegrationInput, ...) (*GetEventIntegrationOutput, error)
- func (c *Client) ListDataIntegrationAssociations(ctx context.Context, params *ListDataIntegrationAssociationsInput, ...) (*ListDataIntegrationAssociationsOutput, error)
- func (c *Client) ListDataIntegrations(ctx context.Context, params *ListDataIntegrationsInput, ...) (*ListDataIntegrationsOutput, error)
- func (c *Client) ListEventIntegrationAssociations(ctx context.Context, params *ListEventIntegrationAssociationsInput, ...) (*ListEventIntegrationAssociationsOutput, error)
- func (c *Client) ListEventIntegrations(ctx context.Context, params *ListEventIntegrationsInput, ...) (*ListEventIntegrationsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, 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)
- func (c *Client) UpdateDataIntegration(ctx context.Context, params *UpdateDataIntegrationInput, ...) (*UpdateDataIntegrationOutput, error)
- func (c *Client) UpdateEventIntegration(ctx context.Context, params *UpdateEventIntegrationInput, ...) (*UpdateEventIntegrationOutput, error)
- type CreateDataIntegrationInput
- type CreateDataIntegrationOutput
- type CreateEventIntegrationInput
- type CreateEventIntegrationOutput
- type DeleteDataIntegrationInput
- type DeleteDataIntegrationOutput
- type DeleteEventIntegrationInput
- type DeleteEventIntegrationOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetDataIntegrationInput
- type GetDataIntegrationOutput
- type GetEventIntegrationInput
- type GetEventIntegrationOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListDataIntegrationAssociationsInput
- type ListDataIntegrationAssociationsOutput
- type ListDataIntegrationsInput
- type ListDataIntegrationsOutput
- type ListEventIntegrationAssociationsInput
- type ListEventIntegrationAssociationsOutput
- type ListEventIntegrationsInput
- type ListEventIntegrationsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateDataIntegrationInput
- type UpdateDataIntegrationOutput
- type UpdateEventIntegrationInput
- type UpdateEventIntegrationOutput
Constants ¶
const ServiceAPIVersion = "2020-07-29"
const ServiceID = "AppIntegrations"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon AppIntegrations Service.
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) CreateDataIntegration ¶ added in v1.7.0
func (c *Client) CreateDataIntegration(ctx context.Context, params *CreateDataIntegrationInput, optFns ...func(*Options)) (*CreateDataIntegrationOutput, error)
Creates and persists a DataIntegration resource. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
func (*Client) CreateEventIntegration ¶
func (c *Client) CreateEventIntegration(ctx context.Context, params *CreateEventIntegrationInput, optFns ...func(*Options)) (*CreateEventIntegrationOutput, error)
Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.
func (*Client) DeleteDataIntegration ¶ added in v1.7.0
func (c *Client) DeleteDataIntegration(ctx context.Context, params *DeleteDataIntegrationInput, optFns ...func(*Options)) (*DeleteDataIntegrationOutput, error)
Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.
func (*Client) DeleteEventIntegration ¶
func (c *Client) DeleteEventIntegration(ctx context.Context, params *DeleteEventIntegrationInput, optFns ...func(*Options)) (*DeleteEventIntegrationOutput, error)
Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.
func (*Client) GetDataIntegration ¶ added in v1.7.0
func (c *Client) GetDataIntegration(ctx context.Context, params *GetDataIntegrationInput, optFns ...func(*Options)) (*GetDataIntegrationOutput, error)
Returns information about the DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.
func (*Client) GetEventIntegration ¶
func (c *Client) GetEventIntegration(ctx context.Context, params *GetEventIntegrationInput, optFns ...func(*Options)) (*GetEventIntegrationOutput, error)
Returns information about the event integration.
func (*Client) ListDataIntegrationAssociations ¶ added in v1.7.0
func (c *Client) ListDataIntegrationAssociations(ctx context.Context, params *ListDataIntegrationAssociationsInput, optFns ...func(*Options)) (*ListDataIntegrationAssociationsOutput, error)
Returns a paginated list of DataIntegration associations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.
func (*Client) ListDataIntegrations ¶ added in v1.7.0
func (c *Client) ListDataIntegrations(ctx context.Context, params *ListDataIntegrationsInput, optFns ...func(*Options)) (*ListDataIntegrationsOutput, error)
Returns a paginated list of DataIntegrations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.
func (*Client) ListEventIntegrationAssociations ¶
func (c *Client) ListEventIntegrationAssociations(ctx context.Context, params *ListEventIntegrationAssociationsInput, optFns ...func(*Options)) (*ListEventIntegrationAssociationsOutput, error)
Returns a paginated list of event integration associations in the account.
func (*Client) ListEventIntegrations ¶
func (c *Client) ListEventIntegrations(ctx context.Context, params *ListEventIntegrationsInput, optFns ...func(*Options)) (*ListEventIntegrationsOutput, error)
Returns a paginated list of event integrations in the account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for the specified resource.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds the specified tags to the specified resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes the specified tags from the specified resource.
func (*Client) UpdateDataIntegration ¶ added in v1.7.0
func (c *Client) UpdateDataIntegration(ctx context.Context, params *UpdateDataIntegrationInput, optFns ...func(*Options)) (*UpdateDataIntegrationOutput, error)
Updates the description of a DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.
func (*Client) UpdateEventIntegration ¶
func (c *Client) UpdateEventIntegration(ctx context.Context, params *UpdateEventIntegrationInput, optFns ...func(*Options)) (*UpdateEventIntegrationOutput, error)
Updates the description of an event integration.
type CreateDataIntegrationInput ¶ added in v1.7.0
type CreateDataIntegrationInput struct { // The name of the DataIntegration. // // This member is required. Name *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // A description of the DataIntegration. Description *string // The KMS key for the DataIntegration. KmsKey *string // The name of the data and how often it should be pulled from the source. ScheduleConfig *types.ScheduleConfiguration // The URI of the data source. SourceURI *string // One or more tags. Tags map[string]string // contains filtered or unexported fields }
type CreateDataIntegrationOutput ¶ added in v1.7.0
type CreateDataIntegrationOutput struct { // The Amazon Resource Name (ARN) Arn *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // A description of the DataIntegration. Description *string // A unique identifier. Id *string // The KMS key for the DataIntegration. KmsKey *string // The name of the DataIntegration. Name *string // The name of the data and how often it should be pulled from the source. ScheduleConfiguration *types.ScheduleConfiguration // The URI of the data source. SourceURI *string // One or more tags. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateEventIntegrationInput ¶
type CreateEventIntegrationInput struct { // The EventBridge bus. // // This member is required. EventBridgeBus *string // The event filter. // // This member is required. EventFilter *types.EventFilter // The name of the event integration. // // This member is required. Name *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // The description of the event integration. Description *string // One or more tags. Tags map[string]string // contains filtered or unexported fields }
type CreateEventIntegrationOutput ¶
type CreateEventIntegrationOutput struct { // The Amazon Resource Name (ARN) of the event integration. EventIntegrationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDataIntegrationInput ¶ added in v1.7.0
type DeleteDataIntegrationInput struct { // A unique identifier for the DataIntegration. // // This member is required. DataIntegrationIdentifier *string // contains filtered or unexported fields }
type DeleteDataIntegrationOutput ¶ added in v1.7.0
type DeleteDataIntegrationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteEventIntegrationInput ¶
type DeleteEventIntegrationInput struct { // The name of the event integration. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteEventIntegrationOutput ¶
type DeleteEventIntegrationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetDataIntegrationInput ¶ added in v1.7.0
type GetDataIntegrationInput struct { // A unique identifier. // // This member is required. Identifier *string // contains filtered or unexported fields }
type GetDataIntegrationOutput ¶ added in v1.7.0
type GetDataIntegrationOutput struct { // The Amazon Resource Name (ARN) for the DataIntegration. Arn *string // The KMS key for the DataIntegration. Description *string // A unique identifier. Id *string // The KMS key for the DataIntegration. KmsKey *string // The name of the DataIntegration. Name *string // The name of the data and how often it should be pulled from the source. ScheduleConfiguration *types.ScheduleConfiguration // The URI of the data source. SourceURI *string // One or more tags. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetEventIntegrationInput ¶
type GetEventIntegrationInput struct { // The name of the event integration. // // This member is required. Name *string // contains filtered or unexported fields }
type GetEventIntegrationOutput ¶
type GetEventIntegrationOutput struct { // The description of the event integration. Description *string // The EventBridge bus. EventBridgeBus *string // The event filter. EventFilter *types.EventFilter // The Amazon Resource Name (ARN) for the event integration. EventIntegrationArn *string // The name of the event integration. Name *string // One or more tags. 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 ListDataIntegrationAssociationsInput ¶ added in v1.7.0
type ListDataIntegrationAssociationsInput struct { // A unique identifier for the DataIntegration. // // This member is required. DataIntegrationIdentifier *string // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListDataIntegrationAssociationsOutput ¶ added in v1.7.0
type ListDataIntegrationAssociationsOutput struct { // The Amazon Resource Name (ARN) and unique ID of the DataIntegration association. DataIntegrationAssociations []types.DataIntegrationAssociationSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDataIntegrationsInput ¶ added in v1.7.0
type ListDataIntegrationsInput struct { // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListDataIntegrationsOutput ¶ added in v1.7.0
type ListDataIntegrationsOutput struct { // The DataIntegrations associated with this account. DataIntegrations []types.DataIntegrationSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListEventIntegrationAssociationsInput ¶
type ListEventIntegrationAssociationsInput struct { // The name of the event integration. // // This member is required. EventIntegrationName *string // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListEventIntegrationAssociationsOutput ¶
type ListEventIntegrationAssociationsOutput struct { // The event integration associations. EventIntegrationAssociations []types.EventIntegrationAssociation // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListEventIntegrationsInput ¶
type ListEventIntegrationsInput struct { // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListEventIntegrationsOutput ¶
type ListEventIntegrationsOutput struct { // The event integrations. EventIntegrations []types.EventIntegration // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Information about the tags. 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 // 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. EndpointResolver EndpointResolver // 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. 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. 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 // 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 }
type UpdateDataIntegrationInput ¶ added in v1.7.0
type UpdateDataIntegrationOutput ¶ added in v1.7.0
type UpdateDataIntegrationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateEventIntegrationOutput ¶
type UpdateEventIntegrationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CreateDataIntegration.go
- api_op_CreateEventIntegration.go
- api_op_DeleteDataIntegration.go
- api_op_DeleteEventIntegration.go
- api_op_GetDataIntegration.go
- api_op_GetEventIntegration.go
- api_op_ListDataIntegrationAssociations.go
- api_op_ListDataIntegrations.go
- api_op_ListEventIntegrationAssociations.go
- api_op_ListEventIntegrations.go
- api_op_ListTagsForResource.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateDataIntegration.go
- api_op_UpdateEventIntegration.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go