Documentation

Overview

    Package appintegrations provides the API client, operations, and parameter types for Amazon AppIntegrations Service.

    The Amazon AppIntegrations APIs are in preview release and are subject to change. 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) in the Amazon Connect Administrator Guide.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2020-07-29"
    View Source
    const ServiceID = "AppIntegrations"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

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

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

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

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

          Types

          type Client

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

            Client provides the API client to make operations call for Amazon AppIntegrations Service.

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

                func (c *Client) CreateEventIntegration(ctx context.Context, params *CreateEventIntegrationInput, optFns ...func(*Options)) (*CreateEventIntegrationOutput, error)

                  The Amazon AppIntegrations APIs are in preview release and are subject to change. 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 will push events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

                  func (*Client) DeleteEventIntegration

                  func (c *Client) DeleteEventIntegration(ctx context.Context, params *DeleteEventIntegrationInput, optFns ...func(*Options)) (*DeleteEventIntegrationOutput, error)

                    The Amazon AppIntegrations APIs are in preview release and are subject to change. Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

                    func (*Client) GetEventIntegration

                    func (c *Client) GetEventIntegration(ctx context.Context, params *GetEventIntegrationInput, optFns ...func(*Options)) (*GetEventIntegrationOutput, error)

                      The Amazon AppIntegrations APIs are in preview release and are subject to change. Return information about the event integration.

                      func (*Client) ListEventIntegrationAssociations

                      func (c *Client) ListEventIntegrationAssociations(ctx context.Context, params *ListEventIntegrationAssociationsInput, optFns ...func(*Options)) (*ListEventIntegrationAssociationsOutput, error)

                        The Amazon AppIntegrations APIs are in preview release and are subject to change. 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)

                          The Amazon AppIntegrations APIs are in preview release and are subject to change. 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)

                            The Amazon AppIntegrations APIs are in preview release and are subject to change. Lists the tags for the specified resource.

                            func (*Client) TagResource

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

                              The Amazon AppIntegrations APIs are in preview release and are subject to change. 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)

                                The Amazon AppIntegrations APIs are in preview release and are subject to change. Removes the specified tags from the specified resource.

                                func (*Client) UpdateEventIntegration

                                func (c *Client) UpdateEventIntegration(ctx context.Context, params *UpdateEventIntegrationInput, optFns ...func(*Options)) (*UpdateEventIntegrationOutput, error)

                                  The Amazon AppIntegrations APIs are in preview release and are subject to change. Updates the description of an event integration.

                                  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
                                  }

                                  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
                                  }

                                  type DeleteEventIntegrationInput

                                  type DeleteEventIntegrationInput struct {
                                  
                                  	// The name of the event integration.
                                  	//
                                  	// This member is required.
                                  	Name *string
                                  }

                                  type DeleteEventIntegrationOutput

                                  type DeleteEventIntegrationOutput struct {
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  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 GetEventIntegrationInput

                                          type GetEventIntegrationInput struct {
                                          
                                          	// The name of the event integration.
                                          	//
                                          	// This member is required.
                                          	Name *string
                                          }

                                          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
                                          }

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

                                            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
                                            }

                                            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
                                            }

                                            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
                                            }

                                            type ListTagsForResourceInput

                                            type ListTagsForResourceInput struct {
                                            
                                            	// The Amazon Resource Name (ARN) of the resource.
                                            	//
                                            	// This member is required.
                                            	ResourceArn *string
                                            }

                                            type ListTagsForResourceOutput

                                            type ListTagsForResourceOutput struct {
                                            
                                            	// Information about the tags.
                                            	Tags map[string]string
                                            
                                            	// Metadata pertaining to the operation's result.
                                            	ResultMetadata middleware.Metadata
                                            }

                                            type Options

                                            type Options struct {
                                            	// Set of options to modify how an operation is invoked. These apply to all
                                            	// operations invoked for this client. Use functional options on operation call to
                                            	// modify this list for per operation behavior.
                                            	APIOptions []func(*middleware.Stack) error
                                            
                                            	// Configures the events that will be sent to the configured logger.
                                            	ClientLogMode aws.ClientLogMode
                                            
                                            	// The credentials object to use when signing requests.
                                            	Credentials aws.CredentialsProvider
                                            
                                            	// The endpoint options to be used when attempting to resolve an endpoint.
                                            	EndpointOptions EndpointResolverOptions
                                            
                                            	// The service endpoint resolver.
                                            	EndpointResolver EndpointResolver
                                            
                                            	// Signature Version 4 (SigV4) Signer
                                            	HTTPSignerV4 HTTPSignerV4
                                            
                                            	// 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
                                            
                                            	// Retryer guides how HTTP requests should be retried in case of recoverable
                                            	// failures. When nil the API client will use a default retryer.
                                            	Retryer aws.Retryer
                                            
                                            	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                            	// implementation if nil.
                                            	HTTPClient HTTPClient
                                            }

                                            func (Options) Copy

                                            func (o Options) Copy() Options

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

                                              type ResolveEndpoint

                                              type ResolveEndpoint struct {
                                              	Resolver EndpointResolver
                                              	Options  EndpointResolverOptions
                                              }

                                              func (*ResolveEndpoint) HandleSerialize

                                              func (*ResolveEndpoint) ID

                                              func (*ResolveEndpoint) ID() string

                                              type TagResourceInput

                                              type TagResourceInput struct {
                                              
                                              	// The Amazon Resource Name (ARN) of the resource.
                                              	//
                                              	// This member is required.
                                              	ResourceArn *string
                                              
                                              	// One or more tags.
                                              	//
                                              	// This member is required.
                                              	Tags map[string]string
                                              }

                                              type TagResourceOutput

                                              type TagResourceOutput struct {
                                              	// Metadata pertaining to the operation's result.
                                              	ResultMetadata middleware.Metadata
                                              }

                                              type UntagResourceInput

                                              type UntagResourceInput struct {
                                              
                                              	// The Amazon Resource Name (ARN) of the resource.
                                              	//
                                              	// This member is required.
                                              	ResourceArn *string
                                              
                                              	// The tag keys.
                                              	//
                                              	// This member is required.
                                              	TagKeys []string
                                              }

                                              type UntagResourceOutput

                                              type UntagResourceOutput struct {
                                              	// Metadata pertaining to the operation's result.
                                              	ResultMetadata middleware.Metadata
                                              }

                                              type UpdateEventIntegrationInput

                                              type UpdateEventIntegrationInput struct {
                                              
                                              	// The name of the event integration.
                                              	//
                                              	// This member is required.
                                              	Name *string
                                              
                                              	// The description of the event inegration.
                                              	Description *string
                                              }

                                              type UpdateEventIntegrationOutput

                                              type UpdateEventIntegrationOutput struct {
                                              	// Metadata pertaining to the operation's result.
                                              	ResultMetadata middleware.Metadata
                                              }

                                              Directories

                                              Path Synopsis
                                              internal