chatbot

package module
v1.1.5 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: 37 Imported by: 0

Documentation

Overview

Package chatbot provides the API client, operations, and parameter types for AWS Chatbot.

AWS Chatbot API

Index

Constants

View Source
const ServiceAPIVersion = "2017-10-11"
View Source
const ServiceID = "chatbot"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

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

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

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

func WithEndpointResolverV2

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters

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

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

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

type AuthSchemeResolver

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

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

type Client

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

Client provides the API client to make operations call for AWS Chatbot.

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

func (c *Client) CreateChimeWebhookConfiguration(ctx context.Context, params *CreateChimeWebhookConfigurationInput, optFns ...func(*Options)) (*CreateChimeWebhookConfigurationOutput, error)

Creates Chime Webhook Configuration

func (*Client) CreateMicrosoftTeamsChannelConfiguration

func (c *Client) CreateMicrosoftTeamsChannelConfiguration(ctx context.Context, params *CreateMicrosoftTeamsChannelConfigurationInput, optFns ...func(*Options)) (*CreateMicrosoftTeamsChannelConfigurationOutput, error)

Creates MS Teams Channel Configuration

func (*Client) CreateSlackChannelConfiguration

func (c *Client) CreateSlackChannelConfiguration(ctx context.Context, params *CreateSlackChannelConfigurationInput, optFns ...func(*Options)) (*CreateSlackChannelConfigurationOutput, error)

Creates Slack Channel Configuration

func (*Client) DeleteChimeWebhookConfiguration

func (c *Client) DeleteChimeWebhookConfiguration(ctx context.Context, params *DeleteChimeWebhookConfigurationInput, optFns ...func(*Options)) (*DeleteChimeWebhookConfigurationOutput, error)

Deletes a Chime Webhook Configuration

func (*Client) DeleteMicrosoftTeamsChannelConfiguration

func (c *Client) DeleteMicrosoftTeamsChannelConfiguration(ctx context.Context, params *DeleteMicrosoftTeamsChannelConfigurationInput, optFns ...func(*Options)) (*DeleteMicrosoftTeamsChannelConfigurationOutput, error)

Deletes MS Teams Channel Configuration

func (*Client) DeleteMicrosoftTeamsConfiguredTeam

func (c *Client) DeleteMicrosoftTeamsConfiguredTeam(ctx context.Context, params *DeleteMicrosoftTeamsConfiguredTeamInput, optFns ...func(*Options)) (*DeleteMicrosoftTeamsConfiguredTeamOutput, error)

Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.

func (*Client) DeleteMicrosoftTeamsUserIdentity

func (c *Client) DeleteMicrosoftTeamsUserIdentity(ctx context.Context, params *DeleteMicrosoftTeamsUserIdentityInput, optFns ...func(*Options)) (*DeleteMicrosoftTeamsUserIdentityOutput, error)

Deletes a Teams user identity

func (*Client) DeleteSlackChannelConfiguration

func (c *Client) DeleteSlackChannelConfiguration(ctx context.Context, params *DeleteSlackChannelConfigurationInput, optFns ...func(*Options)) (*DeleteSlackChannelConfigurationOutput, error)

Deletes Slack Channel Configuration

func (*Client) DeleteSlackUserIdentity

func (c *Client) DeleteSlackUserIdentity(ctx context.Context, params *DeleteSlackUserIdentityInput, optFns ...func(*Options)) (*DeleteSlackUserIdentityOutput, error)

Deletes a Slack user identity

func (*Client) DeleteSlackWorkspaceAuthorization

func (c *Client) DeleteSlackWorkspaceAuthorization(ctx context.Context, params *DeleteSlackWorkspaceAuthorizationInput, optFns ...func(*Options)) (*DeleteSlackWorkspaceAuthorizationOutput, error)

Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.

func (*Client) DescribeChimeWebhookConfigurations

func (c *Client) DescribeChimeWebhookConfigurations(ctx context.Context, params *DescribeChimeWebhookConfigurationsInput, optFns ...func(*Options)) (*DescribeChimeWebhookConfigurationsOutput, error)

Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn

func (*Client) DescribeSlackChannelConfigurations

func (c *Client) DescribeSlackChannelConfigurations(ctx context.Context, params *DescribeSlackChannelConfigurationsInput, optFns ...func(*Options)) (*DescribeSlackChannelConfigurationsOutput, error)

Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn

func (*Client) DescribeSlackUserIdentities

func (c *Client) DescribeSlackUserIdentities(ctx context.Context, params *DescribeSlackUserIdentitiesInput, optFns ...func(*Options)) (*DescribeSlackUserIdentitiesOutput, error)

Lists all Slack user identities with a mapped role.

func (*Client) DescribeSlackWorkspaces

func (c *Client) DescribeSlackWorkspaces(ctx context.Context, params *DescribeSlackWorkspacesInput, optFns ...func(*Options)) (*DescribeSlackWorkspacesOutput, error)

Lists all authorized Slack Workspaces for AWS Account

func (*Client) GetAccountPreferences

func (c *Client) GetAccountPreferences(ctx context.Context, params *GetAccountPreferencesInput, optFns ...func(*Options)) (*GetAccountPreferencesOutput, error)

Get Chatbot account level preferences

func (*Client) GetMicrosoftTeamsChannelConfiguration

func (c *Client) GetMicrosoftTeamsChannelConfiguration(ctx context.Context, params *GetMicrosoftTeamsChannelConfigurationInput, optFns ...func(*Options)) (*GetMicrosoftTeamsChannelConfigurationOutput, error)

Get a single MS Teams Channel Configurations

func (*Client) ListMicrosoftTeamsChannelConfigurations

func (c *Client) ListMicrosoftTeamsChannelConfigurations(ctx context.Context, params *ListMicrosoftTeamsChannelConfigurationsInput, optFns ...func(*Options)) (*ListMicrosoftTeamsChannelConfigurationsOutput, error)

Lists MS Teams Channel Configurations optionally filtered by TeamId

func (*Client) ListMicrosoftTeamsConfiguredTeams

func (c *Client) ListMicrosoftTeamsConfiguredTeams(ctx context.Context, params *ListMicrosoftTeamsConfiguredTeamsInput, optFns ...func(*Options)) (*ListMicrosoftTeamsConfiguredTeamsOutput, error)

Lists all authorized MS teams for AWS Account

func (*Client) ListMicrosoftTeamsUserIdentities

func (c *Client) ListMicrosoftTeamsUserIdentities(ctx context.Context, params *ListMicrosoftTeamsUserIdentitiesInput, optFns ...func(*Options)) (*ListMicrosoftTeamsUserIdentitiesOutput, error)

Lists all Microsoft Teams user identities with a mapped role.

func (*Client) Options

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) UpdateAccountPreferences

func (c *Client) UpdateAccountPreferences(ctx context.Context, params *UpdateAccountPreferencesInput, optFns ...func(*Options)) (*UpdateAccountPreferencesOutput, error)

Update Chatbot account level preferences

func (*Client) UpdateChimeWebhookConfiguration

func (c *Client) UpdateChimeWebhookConfiguration(ctx context.Context, params *UpdateChimeWebhookConfigurationInput, optFns ...func(*Options)) (*UpdateChimeWebhookConfigurationOutput, error)

Updates a Chime Webhook Configuration

func (*Client) UpdateMicrosoftTeamsChannelConfiguration

func (c *Client) UpdateMicrosoftTeamsChannelConfiguration(ctx context.Context, params *UpdateMicrosoftTeamsChannelConfigurationInput, optFns ...func(*Options)) (*UpdateMicrosoftTeamsChannelConfigurationOutput, error)

Updates MS Teams Channel Configuration

func (*Client) UpdateSlackChannelConfiguration

func (c *Client) UpdateSlackChannelConfiguration(ctx context.Context, params *UpdateSlackChannelConfigurationInput, optFns ...func(*Options)) (*UpdateSlackChannelConfigurationOutput, error)

Updates Slack Channel Configuration

type CreateChimeWebhookConfigurationInput

type CreateChimeWebhookConfigurationInput struct {

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

	// This is a user-defined role that AWS Chatbot will assume. This is not the
	// service-linked role. For more information, see IAM Policies for AWS Chatbot.
	//
	// This member is required.
	IamRoleArn *string

	// The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
	//
	// This member is required.
	SnsTopicArns []string

	// Description of the webhook. Recommend using the convention RoomName/WebhookName
	// . See Chime setup tutorial for more details:
	// https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
	//
	// This member is required.
	WebhookDescription *string

	// URL for the Chime webhook.
	//
	// This member is required.
	WebhookUrl *string

	// Logging levels include ERROR, INFO, or NONE.
	LoggingLevel *string
	// contains filtered or unexported fields
}

type CreateChimeWebhookConfigurationOutput

type CreateChimeWebhookConfigurationOutput struct {

	// Chime webhook configuration.
	WebhookConfiguration *types.ChimeWebhookConfiguration

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

type CreateMicrosoftTeamsChannelConfigurationInput

type CreateMicrosoftTeamsChannelConfigurationInput struct {

	// The ID of the Microsoft Teams channel.
	//
	// This member is required.
	ChannelId *string

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

	// The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a
	// user-defined role that AWS Chatbot will assume. This is not the service-linked
	// role. For more information, see IAM Policies for AWS Chatbot.
	//
	// This member is required.
	IamRoleArn *string

	// The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID,
	// you must perform the initial authorization flow with Microsoft Teams in the AWS
	// Chatbot console. Then you can copy and paste the team ID from the console. For
	// more details, see steps 1-4 in Get started with Microsoft Teams in the AWS
	// Chatbot Administrator Guide.
	//
	// This member is required.
	TeamId *string

	// The ID of the Microsoft Teams tenant.
	//
	// This member is required.
	TenantId *string

	// The name of the Microsoft Teams channel.
	ChannelName *string

	// The list of IAM policy ARNs that are applied as channel guardrails. The AWS
	// managed 'AdministratorAccess' policy is applied by default if this is not set.
	GuardrailPolicyArns []string

	// Logging levels include ERROR, INFO, or NONE.
	LoggingLevel *string

	// The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
	SnsTopicArns []string

	// The name of the Microsoft Teams Team.
	TeamName *string

	// Enables use of a user role requirement in your chat configuration.
	UserAuthorizationRequired *bool
	// contains filtered or unexported fields
}

type CreateMicrosoftTeamsChannelConfigurationOutput

type CreateMicrosoftTeamsChannelConfigurationOutput struct {

	// The configuration for a Microsoft Teams channel configured with AWS Chatbot.
	ChannelConfiguration *types.TeamsChannelConfiguration

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

type CreateSlackChannelConfigurationInput

type CreateSlackChannelConfigurationInput struct {

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

	// The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a
	// user-defined role that AWS Chatbot will assume. This is not the service-linked
	// role. For more information, see IAM Policies for AWS Chatbot.
	//
	// This member is required.
	IamRoleArn *string

	// The ID of the Slack channel. To get the ID, open Slack, right click on the
	// channel name in the left pane, then choose Copy Link. The channel ID is the
	// 9-character string at the end of the URL. For example, ABCBBLZZZ.
	//
	// This member is required.
	SlackChannelId *string

	// The ID of the Slack workspace authorized with AWS Chatbot.
	//
	// This member is required.
	SlackTeamId *string

	// The list of IAM policy ARNs that are applied as channel guardrails. The AWS
	// managed 'AdministratorAccess' policy is applied by default if this is not set.
	GuardrailPolicyArns []string

	// Logging levels include ERROR, INFO, or NONE.
	LoggingLevel *string

	// The name of the Slack Channel.
	SlackChannelName *string

	// The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
	SnsTopicArns []string

	// Enables use of a user role requirement in your chat configuration.
	UserAuthorizationRequired *bool
	// contains filtered or unexported fields
}

type CreateSlackChannelConfigurationOutput

type CreateSlackChannelConfigurationOutput struct {

	// The configuration for a Slack channel configured with AWS Chatbot.
	ChannelConfiguration *types.SlackChannelConfiguration

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

type DeleteChimeWebhookConfigurationInput

type DeleteChimeWebhookConfigurationInput struct {

	// The ARN of the ChimeWebhookConfiguration to delete.
	//
	// This member is required.
	ChatConfigurationArn *string
	// contains filtered or unexported fields
}

type DeleteChimeWebhookConfigurationOutput

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

type DeleteMicrosoftTeamsChannelConfigurationInput

type DeleteMicrosoftTeamsChannelConfigurationInput struct {

	// The ARN of the MicrosoftTeamsChannelConfiguration to delete.
	//
	// This member is required.
	ChatConfigurationArn *string
	// contains filtered or unexported fields
}

type DeleteMicrosoftTeamsChannelConfigurationOutput

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

type DeleteMicrosoftTeamsConfiguredTeamInput

type DeleteMicrosoftTeamsConfiguredTeamInput struct {

	// The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID,
	// you must perform the initial authorization flow with Microsoft Teams in the AWS
	// Chatbot console. Then you can copy and paste the team ID from the console. For
	// more details, see steps 1-4 in Get started with Microsoft Teams in the AWS
	// Chatbot Administrator Guide.
	//
	// This member is required.
	TeamId *string
	// contains filtered or unexported fields
}

type DeleteMicrosoftTeamsConfiguredTeamOutput

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

type DeleteMicrosoftTeamsUserIdentityInput

type DeleteMicrosoftTeamsUserIdentityInput struct {

	// The ARN of the MicrosoftTeamsChannelConfiguration associated with the user
	// identity to delete.
	//
	// This member is required.
	ChatConfigurationArn *string

	// Id from Microsoft Teams for user.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DeleteMicrosoftTeamsUserIdentityOutput

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

type DeleteSlackChannelConfigurationInput

type DeleteSlackChannelConfigurationInput struct {

	// The ARN of the SlackChannelConfiguration to delete.
	//
	// This member is required.
	ChatConfigurationArn *string
	// contains filtered or unexported fields
}

type DeleteSlackChannelConfigurationOutput

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

type DeleteSlackUserIdentityInput

type DeleteSlackUserIdentityInput struct {

	// The ARN of the SlackChannelConfiguration associated with the user identity to
	// delete.
	//
	// This member is required.
	ChatConfigurationArn *string

	// The ID of the Slack workspace authorized with AWS Chatbot.
	//
	// This member is required.
	SlackTeamId *string

	// The ID of the user in Slack.
	//
	// This member is required.
	SlackUserId *string
	// contains filtered or unexported fields
}

type DeleteSlackUserIdentityOutput

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

type DeleteSlackWorkspaceAuthorizationInput

type DeleteSlackWorkspaceAuthorizationInput struct {

	// The ID of the Slack workspace authorized with AWS Chatbot.
	//
	// This member is required.
	SlackTeamId *string
	// contains filtered or unexported fields
}

type DeleteSlackWorkspaceAuthorizationOutput

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

type DescribeChimeWebhookConfigurationsAPIClient

type DescribeChimeWebhookConfigurationsAPIClient interface {
	DescribeChimeWebhookConfigurations(context.Context, *DescribeChimeWebhookConfigurationsInput, ...func(*Options)) (*DescribeChimeWebhookConfigurationsOutput, error)
}

DescribeChimeWebhookConfigurationsAPIClient is a client that implements the DescribeChimeWebhookConfigurations operation.

type DescribeChimeWebhookConfigurationsInput

type DescribeChimeWebhookConfigurationsInput struct {

	// An optional ARN of a ChimeWebhookConfiguration to describe.
	ChatConfigurationArn *string

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeChimeWebhookConfigurationsOutput

type DescribeChimeWebhookConfigurationsOutput struct {

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// A list of Chime webhooks associated with the account.
	WebhookConfigurations []types.ChimeWebhookConfiguration

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

type DescribeChimeWebhookConfigurationsPaginator

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

DescribeChimeWebhookConfigurationsPaginator is a paginator for DescribeChimeWebhookConfigurations

func NewDescribeChimeWebhookConfigurationsPaginator

NewDescribeChimeWebhookConfigurationsPaginator returns a new DescribeChimeWebhookConfigurationsPaginator

func (*DescribeChimeWebhookConfigurationsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeChimeWebhookConfigurationsPaginator) NextPage

NextPage retrieves the next DescribeChimeWebhookConfigurations page.

type DescribeChimeWebhookConfigurationsPaginatorOptions

type DescribeChimeWebhookConfigurationsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	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
}

DescribeChimeWebhookConfigurationsPaginatorOptions is the paginator options for DescribeChimeWebhookConfigurations

type DescribeSlackChannelConfigurationsAPIClient

type DescribeSlackChannelConfigurationsAPIClient interface {
	DescribeSlackChannelConfigurations(context.Context, *DescribeSlackChannelConfigurationsInput, ...func(*Options)) (*DescribeSlackChannelConfigurationsOutput, error)
}

DescribeSlackChannelConfigurationsAPIClient is a client that implements the DescribeSlackChannelConfigurations operation.

type DescribeSlackChannelConfigurationsInput

type DescribeSlackChannelConfigurationsInput struct {

	// An optional ARN of a SlackChannelConfiguration to describe.
	ChatConfigurationArn *string

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeSlackChannelConfigurationsOutput

type DescribeSlackChannelConfigurationsOutput struct {

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// A list of Slack channel configurations.
	SlackChannelConfigurations []types.SlackChannelConfiguration

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

type DescribeSlackChannelConfigurationsPaginator

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

DescribeSlackChannelConfigurationsPaginator is a paginator for DescribeSlackChannelConfigurations

func NewDescribeSlackChannelConfigurationsPaginator

NewDescribeSlackChannelConfigurationsPaginator returns a new DescribeSlackChannelConfigurationsPaginator

func (*DescribeSlackChannelConfigurationsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSlackChannelConfigurationsPaginator) NextPage

NextPage retrieves the next DescribeSlackChannelConfigurations page.

type DescribeSlackChannelConfigurationsPaginatorOptions

type DescribeSlackChannelConfigurationsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	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
}

DescribeSlackChannelConfigurationsPaginatorOptions is the paginator options for DescribeSlackChannelConfigurations

type DescribeSlackUserIdentitiesAPIClient

type DescribeSlackUserIdentitiesAPIClient interface {
	DescribeSlackUserIdentities(context.Context, *DescribeSlackUserIdentitiesInput, ...func(*Options)) (*DescribeSlackUserIdentitiesOutput, error)
}

DescribeSlackUserIdentitiesAPIClient is a client that implements the DescribeSlackUserIdentities operation.

type DescribeSlackUserIdentitiesInput

type DescribeSlackUserIdentitiesInput struct {

	// The ARN of the SlackChannelConfiguration associated with the user identities to
	// describe.
	ChatConfigurationArn *string

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeSlackUserIdentitiesOutput

type DescribeSlackUserIdentitiesOutput struct {

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// A list of Slack User Identities.
	SlackUserIdentities []types.SlackUserIdentity

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

type DescribeSlackUserIdentitiesPaginator

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

DescribeSlackUserIdentitiesPaginator is a paginator for DescribeSlackUserIdentities

func NewDescribeSlackUserIdentitiesPaginator

NewDescribeSlackUserIdentitiesPaginator returns a new DescribeSlackUserIdentitiesPaginator

func (*DescribeSlackUserIdentitiesPaginator) HasMorePages

func (p *DescribeSlackUserIdentitiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSlackUserIdentitiesPaginator) NextPage

NextPage retrieves the next DescribeSlackUserIdentities page.

type DescribeSlackUserIdentitiesPaginatorOptions

type DescribeSlackUserIdentitiesPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	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
}

DescribeSlackUserIdentitiesPaginatorOptions is the paginator options for DescribeSlackUserIdentities

type DescribeSlackWorkspacesAPIClient

type DescribeSlackWorkspacesAPIClient interface {
	DescribeSlackWorkspaces(context.Context, *DescribeSlackWorkspacesInput, ...func(*Options)) (*DescribeSlackWorkspacesOutput, error)
}

DescribeSlackWorkspacesAPIClient is a client that implements the DescribeSlackWorkspaces operation.

type DescribeSlackWorkspacesInput

type DescribeSlackWorkspacesInput struct {

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeSlackWorkspacesOutput

type DescribeSlackWorkspacesOutput struct {

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// A list of Slack Workspaces registered with AWS Chatbot.
	SlackWorkspaces []types.SlackWorkspace

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

type DescribeSlackWorkspacesPaginator

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

DescribeSlackWorkspacesPaginator is a paginator for DescribeSlackWorkspaces

func NewDescribeSlackWorkspacesPaginator

NewDescribeSlackWorkspacesPaginator returns a new DescribeSlackWorkspacesPaginator

func (*DescribeSlackWorkspacesPaginator) HasMorePages

func (p *DescribeSlackWorkspacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSlackWorkspacesPaginator) NextPage

NextPage retrieves the next DescribeSlackWorkspaces page.

type DescribeSlackWorkspacesPaginatorOptions

type DescribeSlackWorkspacesPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	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
}

DescribeSlackWorkspacesPaginatorOptions is the paginator options for DescribeSlackWorkspaces

type EndpointParameters

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccountPreferencesInput

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

type GetAccountPreferencesOutput

type GetAccountPreferencesOutput struct {

	// Preferences which apply for AWS Chatbot usage in the calling AWS account.
	AccountPreferences *types.AccountPreferences

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

type GetMicrosoftTeamsChannelConfigurationInput

type GetMicrosoftTeamsChannelConfigurationInput struct {

	// The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
	//
	// This member is required.
	ChatConfigurationArn *string
	// contains filtered or unexported fields
}

type GetMicrosoftTeamsChannelConfigurationOutput

type GetMicrosoftTeamsChannelConfigurationOutput struct {

	// The configuration for a Microsoft Teams channel configured with AWS Chatbot.
	ChannelConfiguration *types.TeamsChannelConfiguration

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

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListMicrosoftTeamsChannelConfigurationsAPIClient

type ListMicrosoftTeamsChannelConfigurationsAPIClient interface {
	ListMicrosoftTeamsChannelConfigurations(context.Context, *ListMicrosoftTeamsChannelConfigurationsInput, ...func(*Options)) (*ListMicrosoftTeamsChannelConfigurationsOutput, error)
}

ListMicrosoftTeamsChannelConfigurationsAPIClient is a client that implements the ListMicrosoftTeamsChannelConfigurations operation.

type ListMicrosoftTeamsChannelConfigurationsInput

type ListMicrosoftTeamsChannelConfigurationsInput struct {

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID,
	// you must perform the initial authorization flow with Microsoft Teams in the AWS
	// Chatbot console. Then you can copy and paste the team ID from the console. For
	// more details, see steps 1-4 in Get started with Microsoft Teams in the AWS
	// Chatbot Administrator Guide.
	TeamId *string
	// contains filtered or unexported fields
}

type ListMicrosoftTeamsChannelConfigurationsOutput

type ListMicrosoftTeamsChannelConfigurationsOutput struct {

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// A list of AWS Chatbot channel configurations for Microsoft Teams.
	TeamChannelConfigurations []types.TeamsChannelConfiguration

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

type ListMicrosoftTeamsChannelConfigurationsPaginator

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

ListMicrosoftTeamsChannelConfigurationsPaginator is a paginator for ListMicrosoftTeamsChannelConfigurations

func NewListMicrosoftTeamsChannelConfigurationsPaginator

NewListMicrosoftTeamsChannelConfigurationsPaginator returns a new ListMicrosoftTeamsChannelConfigurationsPaginator

func (*ListMicrosoftTeamsChannelConfigurationsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMicrosoftTeamsChannelConfigurationsPaginator) NextPage

NextPage retrieves the next ListMicrosoftTeamsChannelConfigurations page.

type ListMicrosoftTeamsChannelConfigurationsPaginatorOptions

type ListMicrosoftTeamsChannelConfigurationsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	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
}

ListMicrosoftTeamsChannelConfigurationsPaginatorOptions is the paginator options for ListMicrosoftTeamsChannelConfigurations

type ListMicrosoftTeamsConfiguredTeamsAPIClient

type ListMicrosoftTeamsConfiguredTeamsAPIClient interface {
	ListMicrosoftTeamsConfiguredTeams(context.Context, *ListMicrosoftTeamsConfiguredTeamsInput, ...func(*Options)) (*ListMicrosoftTeamsConfiguredTeamsOutput, error)
}

ListMicrosoftTeamsConfiguredTeamsAPIClient is a client that implements the ListMicrosoftTeamsConfiguredTeams operation.

type ListMicrosoftTeamsConfiguredTeamsInput

type ListMicrosoftTeamsConfiguredTeamsInput struct {

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMicrosoftTeamsConfiguredTeamsOutput

type ListMicrosoftTeamsConfiguredTeamsOutput struct {

	// A list of teams in Microsoft Teams that have been configured with AWS Chatbot.
	ConfiguredTeams []types.ConfiguredTeam

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

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

type ListMicrosoftTeamsConfiguredTeamsPaginator

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

ListMicrosoftTeamsConfiguredTeamsPaginator is a paginator for ListMicrosoftTeamsConfiguredTeams

func NewListMicrosoftTeamsConfiguredTeamsPaginator

NewListMicrosoftTeamsConfiguredTeamsPaginator returns a new ListMicrosoftTeamsConfiguredTeamsPaginator

func (*ListMicrosoftTeamsConfiguredTeamsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMicrosoftTeamsConfiguredTeamsPaginator) NextPage

NextPage retrieves the next ListMicrosoftTeamsConfiguredTeams page.

type ListMicrosoftTeamsConfiguredTeamsPaginatorOptions

type ListMicrosoftTeamsConfiguredTeamsPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	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
}

ListMicrosoftTeamsConfiguredTeamsPaginatorOptions is the paginator options for ListMicrosoftTeamsConfiguredTeams

type ListMicrosoftTeamsUserIdentitiesAPIClient

type ListMicrosoftTeamsUserIdentitiesAPIClient interface {
	ListMicrosoftTeamsUserIdentities(context.Context, *ListMicrosoftTeamsUserIdentitiesInput, ...func(*Options)) (*ListMicrosoftTeamsUserIdentitiesOutput, error)
}

ListMicrosoftTeamsUserIdentitiesAPIClient is a client that implements the ListMicrosoftTeamsUserIdentities operation.

type ListMicrosoftTeamsUserIdentitiesInput

type ListMicrosoftTeamsUserIdentitiesInput struct {

	// The ARN of the MicrosoftTeamsChannelConfiguration associated with the user
	// identities to list.
	ChatConfigurationArn *string

	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	MaxResults *int32

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMicrosoftTeamsUserIdentitiesOutput

type ListMicrosoftTeamsUserIdentitiesOutput struct {

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string

	// User level permissions associated to a channel configuration.
	TeamsUserIdentities []types.TeamsUserIdentity

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

type ListMicrosoftTeamsUserIdentitiesPaginator

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

ListMicrosoftTeamsUserIdentitiesPaginator is a paginator for ListMicrosoftTeamsUserIdentities

func NewListMicrosoftTeamsUserIdentitiesPaginator

NewListMicrosoftTeamsUserIdentitiesPaginator returns a new ListMicrosoftTeamsUserIdentitiesPaginator

func (*ListMicrosoftTeamsUserIdentitiesPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMicrosoftTeamsUserIdentitiesPaginator) NextPage

NextPage retrieves the next ListMicrosoftTeamsUserIdentities page.

type ListMicrosoftTeamsUserIdentitiesPaginatorOptions

type ListMicrosoftTeamsUserIdentitiesPaginatorOptions struct {
	// The maximum number of results to include in the response. If more results exist
	// than the specified MaxResults value, a token is included in the response so that
	// the remaining results can be retrieved.
	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
}

ListMicrosoftTeamsUserIdentitiesPaginatorOptions is the paginator options for ListMicrosoftTeamsUserIdentities

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

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type UpdateAccountPreferencesInput

type UpdateAccountPreferencesInput struct {

	// Turns on training data collection. This helps improve the AWS Chatbot
	// experience by allowing AWS Chatbot to store and use your customer information,
	// such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot
	// generated responses, and interaction data. This data helps us to continuously
	// improve and develop Artificial Intelligence (AI) technologies. Your data is not
	// shared with any third parties and is protected using sophisticated controls to
	// prevent unauthorized access and misuse. AWS Chatbot does not store or use
	// interactions in chat channels with Amazon Q for training AWS Chatbot’s AI
	// technologies.
	TrainingDataCollectionEnabled *bool

	// Enables use of a user role requirement in your chat configuration.
	UserAuthorizationRequired *bool
	// contains filtered or unexported fields
}

type UpdateAccountPreferencesOutput

type UpdateAccountPreferencesOutput struct {

	// Preferences which apply for AWS Chatbot usage in the calling AWS account.
	AccountPreferences *types.AccountPreferences

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

type UpdateChimeWebhookConfigurationInput

type UpdateChimeWebhookConfigurationInput struct {

	// The ARN of the ChimeWebhookConfiguration to update.
	//
	// This member is required.
	ChatConfigurationArn *string

	// The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a
	// user-defined role that AWS Chatbot will assume. This is not the service-linked
	// role. For more information, see IAM Policies for AWS Chatbot.
	IamRoleArn *string

	// Logging levels include ERROR, INFO, or NONE.
	LoggingLevel *string

	// The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
	SnsTopicArns []string

	// Description of the webhook. Recommend using the convention RoomName/WebhookName
	// . See Chime setup tutorial for more details:
	// https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
	WebhookDescription *string

	// URL for the Chime webhook.
	WebhookUrl *string
	// contains filtered or unexported fields
}

type UpdateChimeWebhookConfigurationOutput

type UpdateChimeWebhookConfigurationOutput struct {

	// Chime webhook configuration.
	WebhookConfiguration *types.ChimeWebhookConfiguration

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

type UpdateMicrosoftTeamsChannelConfigurationInput

type UpdateMicrosoftTeamsChannelConfigurationInput struct {

	// The ID of the Microsoft Teams channel.
	//
	// This member is required.
	ChannelId *string

	// The ARN of the MicrosoftTeamsChannelConfiguration to update.
	//
	// This member is required.
	ChatConfigurationArn *string

	// The name of the Microsoft Teams channel.
	ChannelName *string

	// The list of IAM policy ARNs that are applied as channel guardrails. The AWS
	// managed 'AdministratorAccess' policy is applied by default if this is not set.
	GuardrailPolicyArns []string

	// The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a
	// user-defined role that AWS Chatbot will assume. This is not the service-linked
	// role. For more information, see IAM Policies for AWS Chatbot.
	IamRoleArn *string

	// Logging levels include ERROR, INFO, or NONE.
	LoggingLevel *string

	// The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
	SnsTopicArns []string

	// Enables use of a user role requirement in your chat configuration.
	UserAuthorizationRequired *bool
	// contains filtered or unexported fields
}

type UpdateMicrosoftTeamsChannelConfigurationOutput

type UpdateMicrosoftTeamsChannelConfigurationOutput struct {

	// The configuration for a Microsoft Teams channel configured with AWS Chatbot.
	ChannelConfiguration *types.TeamsChannelConfiguration

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

type UpdateSlackChannelConfigurationInput

type UpdateSlackChannelConfigurationInput struct {

	// The ARN of the SlackChannelConfiguration to update.
	//
	// This member is required.
	ChatConfigurationArn *string

	// The ID of the Slack channel. To get the ID, open Slack, right click on the
	// channel name in the left pane, then choose Copy Link. The channel ID is the
	// 9-character string at the end of the URL. For example, ABCBBLZZZ.
	//
	// This member is required.
	SlackChannelId *string

	// The list of IAM policy ARNs that are applied as channel guardrails. The AWS
	// managed 'AdministratorAccess' policy is applied by default if this is not set.
	GuardrailPolicyArns []string

	// The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a
	// user-defined role that AWS Chatbot will assume. This is not the service-linked
	// role. For more information, see IAM Policies for AWS Chatbot.
	IamRoleArn *string

	// Logging levels include ERROR, INFO, or NONE.
	LoggingLevel *string

	// The name of the Slack Channel.
	SlackChannelName *string

	// The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
	SnsTopicArns []string

	// Enables use of a user role requirement in your chat configuration.
	UserAuthorizationRequired *bool
	// contains filtered or unexported fields
}

type UpdateSlackChannelConfigurationOutput

type UpdateSlackChannelConfigurationOutput struct {

	// The configuration for a Slack channel configured with AWS Chatbot.
	ChannelConfiguration *types.SlackChannelConfiguration

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL