@aws-sdk/client-chatbot 3.696.0 → 3.700.0

package/dist-types/models/models_0.d.ts

@@ -18,6 +18,74 @@ export interface AccountPreferences {
      */
     TrainingDataCollectionEnabled?: boolean | undefined;
 }
+/**
+ * @public
+ */
+export interface AssociateToConfigurationRequest {
+    /**
+     * <p>The resource Amazon Resource Name (ARN) to link.</p>
+     * @public
+     */
+    Resource: string | undefined;
+    /**
+     * <p>The channel configuration to associate with the resource.</p>
+     * @public
+     */
+    ChatConfiguration: string | undefined;
+}
+/**
+ * @public
+ */
+export interface AssociateToConfigurationResult {
+}
+/**
+ * <p>Unexpected error during processing of request.</p>
+ * @public
+ */
+export declare class InternalServiceError extends __BaseException {
+    readonly name: "InternalServiceError";
+    readonly $fault: "server";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
+}
+/**
+ * <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
+ * @public
+ */
+export declare class InvalidRequestException extends __BaseException {
+    readonly name: "InvalidRequestException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
+}
+/**
+ * <p>The request was rejected because it doesn't have valid credentials for the target resource.</p>
+ * @public
+ */
+export declare class UnauthorizedException extends __BaseException {
+    readonly name: "UnauthorizedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
+}
+/**
+ * <p>A listing of an association with a channel configuration.</p>
+ * @public
+ */
+export interface AssociationListing {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the resource (for example, a custom action).</p>
+     * @public
+     */
+    Resource: string | undefined;
+}
 /**
  * <p>A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.</p>
  *          <important>
@@ -51,7 +119,7 @@ export interface ChimeWebhookConfiguration {
      */
     WebhookDescription: string | undefined;
     /**
-     * <p>The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.</p>
+     * <p>The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.</p>
      * @public
      */
     ChatConfigurationArn: string | undefined;
@@ -220,28 +288,132 @@ export declare class InvalidParameterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 /**
- * <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
+ * <p>You have exceeded a service limit for AWS Chatbot.</p>
  * @public
  */
-export declare class InvalidRequestException extends __BaseException {
-    readonly name: "InvalidRequestException";
+export declare class LimitExceededException extends __BaseException {
+    readonly name: "LimitExceededException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
- * <p>You have exceeded a service limit for AWS Chatbot.</p>
  * @public
+ * @enum
  */
-export declare class LimitExceededException extends __BaseException {
-    readonly name: "LimitExceededException";
-    readonly $fault: "client";
+export declare const CustomActionAttachmentCriteriaOperator: {
+    readonly EQUALS: "EQUALS";
+    readonly HAS_VALUE: "HAS_VALUE";
+};
+/**
+ * @public
+ */
+export type CustomActionAttachmentCriteriaOperator = (typeof CustomActionAttachmentCriteriaOperator)[keyof typeof CustomActionAttachmentCriteriaOperator];
+/**
+ * <p>A criteria for when a button should be shown based on values in the notification</p>
+ * @public
+ */
+export interface CustomActionAttachmentCriteria {
     /**
-     * @internal
+     * <p>The operation to perform on the named variable.</p>
+     * @public
      */
-    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
+    Operator: CustomActionAttachmentCriteriaOperator | undefined;
+    /**
+     * <p>The name of the variable to operate on.</p>
+     * @public
+     */
+    VariableName: string | undefined;
+    /**
+     * <p>A value that is compared with the actual value of the variable based on the behavior of the operator.</p>
+     * @public
+     */
+    Value?: string | undefined;
+}
+/**
+ * <p>Defines when a custom action button should be attached to a notification.</p>
+ * @public
+ */
+export interface CustomActionAttachment {
+    /**
+     * <p>The type of notification that the custom action should be attached to.</p>
+     * @public
+     */
+    NotificationType?: string | undefined;
+    /**
+     * <p>The text of the button that appears on the notification.</p>
+     * @public
+     */
+    ButtonText?: string | undefined;
+    /**
+     * <p>The criteria for when a button should be shown based on values in the notification.</p>
+     * @public
+     */
+    Criteria?: CustomActionAttachmentCriteria[] | undefined;
+    /**
+     * <p>The variables to extract from the notification.</p>
+     * @public
+     */
+    Variables?: Record<string, string> | undefined;
+}
+/**
+ * <p>The definition of the command to run when invoked as an alias or as an action button.</p>
+ * @public
+ */
+export interface CustomActionDefinition {
+    /**
+     * <p>The command string to run which may include variables by prefixing with a dollar sign ($).</p>
+     * @public
+     */
+    CommandText: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateCustomActionRequest {
+    /**
+     * <p>The definition of the command to run when invoked as an alias or as an action button.</p>
+     * @public
+     */
+    Definition: CustomActionDefinition | undefined;
+    /**
+     * <p>The name used to invoke this action in a chat channel. For example, <code>@aws run my-alias</code>.</p>
+     * @public
+     */
+    AliasName?: string | undefined;
+    /**
+     * <p>Defines when this custom action button should be attached to a notification.</p>
+     * @public
+     */
+    Attachments?: CustomActionAttachment[] | undefined;
+    /**
+     * <p>A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.</p>
+     * @public
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.</p>
+     *          <p>If you do not specify a client token, one is automatically generated by the SDK.</p>
+     * @public
+     */
+    ClientToken?: string | undefined;
+    /**
+     * <p>The name of the custom action. This name is included in the Amazon Resource Name (ARN).</p>
+     * @public
+     */
+    ActionName: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateCustomActionResult {
+    /**
+     * <p>The fully defined ARN of the custom action.</p>
+     * @public
+     */
+    CustomActionArn: string | undefined;
 }
 /**
  * <p>We can’t process your request right now because of a server issue. Try again later.</p>
@@ -524,7 +696,7 @@ export interface SlackChannelConfiguration {
      */
     SlackChannelName: string | undefined;
     /**
-     * <p>The Amazon Resource Number (ARN) of the SlackChannelConfiguration.</p>
+     * <p>The Amazon Resource Name (ARN) of the SlackChannelConfiguration.</p>
      * @public
      */
     ChatConfigurationArn: string | undefined;
@@ -589,32 +761,50 @@ export interface CreateSlackChannelConfigurationResult {
     ChannelConfiguration?: SlackChannelConfiguration | undefined;
 }
 /**
- * <p>We can’t process your request right now because of a server issue. Try again later.</p>
+ * <p>Represents a parameterized command that can be invoked as an alias or as a notification button in the chat client.</p>
  * @public
  */
-export declare class DeleteChimeWebhookConfigurationException extends __BaseException {
-    readonly name: "DeleteChimeWebhookConfigurationException";
-    readonly $fault: "server";
-    Message?: string | undefined;
+export interface CustomAction {
     /**
-     * @internal
+     * <p>The fully defined Amazon Resource Name (ARN) of the custom action.</p>
+     * @public
      */
-    constructor(opts: __ExceptionOptionType<DeleteChimeWebhookConfigurationException, __BaseException>);
+    CustomActionArn: string | undefined;
+    /**
+     * <p>The definition of the command to run when invoked an alias or as an action button.</p>
+     * @public
+     */
+    Definition: CustomActionDefinition | undefined;
+    /**
+     * <p>The name used to invoke this action in the chat channel. For example, <code>@aws run my-alias</code>.</p>
+     * @public
+     */
+    AliasName?: string | undefined;
+    /**
+     * <p>Defines when this custom action button should be attached to a notification.</p>
+     * @public
+     */
+    Attachments?: CustomActionAttachment[] | undefined;
+    /**
+     * <p>The name of the custom action that is included in the ARN.</p>
+     * @public
+     */
+    ActionName?: string | undefined;
 }
 /**
  * @public
  */
-export interface DeleteChimeWebhookConfigurationRequest {
+export interface DeleteCustomActionRequest {
     /**
-     * <p>The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete.</p>
+     * <p>The fully defined ARN of the custom action.</p>
      * @public
      */
-    ChatConfigurationArn: string | undefined;
+    CustomActionArn: string | undefined;
 }
 /**
  * @public
  */
-export interface DeleteChimeWebhookConfigurationResult {
+export interface DeleteCustomActionResult {
 }
 /**
  * <p>We were unable to find the resource for your request</p>
@@ -629,6 +819,119 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface GetCustomActionRequest {
+    /**
+     * <p>Returns the fully defined Amazon Resource Name (ARN) of the custom action.</p>
+     * @public
+     */
+    CustomActionArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetCustomActionResult {
+    /**
+     * <p>Returns the custom action.</p>
+     * @public
+     */
+    CustomAction?: CustomAction | undefined;
+}
+/**
+ * @public
+ */
+export interface ListCustomActionsRequest {
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListCustomActionsResult {
+    /**
+     * <p>A list of custom actions.</p>
+     * @public
+     */
+    CustomActions: string[] | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateCustomActionRequest {
+    /**
+     * <p>The fully defined Amazon Resource Name (ARN) of the custom action.</p>
+     * @public
+     */
+    CustomActionArn: string | undefined;
+    /**
+     * <p>The definition of the command to run when invoked as an alias or as an action button.</p>
+     * @public
+     */
+    Definition: CustomActionDefinition | undefined;
+    /**
+     * <p>The name used to invoke this action in the chat channel. For example, <code>@aws run my-alias</code>.</p>
+     * @public
+     */
+    AliasName?: string | undefined;
+    /**
+     * <p>Defines when this custom action button should be attached to a notification.</p>
+     * @public
+     */
+    Attachments?: CustomActionAttachment[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateCustomActionResult {
+    /**
+     * <p>The fully defined ARN of the custom action.</p>
+     * @public
+     */
+    CustomActionArn: string | undefined;
+}
+/**
+ * <p>We can’t process your request right now because of a server issue. Try again later.</p>
+ * @public
+ */
+export declare class DeleteChimeWebhookConfigurationException extends __BaseException {
+    readonly name: "DeleteChimeWebhookConfigurationException";
+    readonly $fault: "server";
+    Message?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DeleteChimeWebhookConfigurationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface DeleteChimeWebhookConfigurationRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete.</p>
+     * @public
+     */
+    ChatConfigurationArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteChimeWebhookConfigurationResult {
+}
 /**
  * <p>We can’t process your request right now because of a server issue. Try again later.</p>
  * @public
@@ -844,7 +1147,7 @@ export interface DescribeChimeWebhookConfigurationsRequest {
      */
     NextToken?: string | undefined;
     /**
-     * <p>An optional Amazon Resource Number (ARN) of a ChimeWebhookConfiguration to describe.</p>
+     * <p>An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe.</p>
      * @public
      */
     ChatConfigurationArn?: string | undefined;
@@ -895,7 +1198,7 @@ export interface DescribeSlackChannelConfigurationsRequest {
      */
     NextToken?: string | undefined;
     /**
-     * <p>An optional Amazon Resource Number (ARN) of a SlackChannelConfiguration to describe.</p>
+     * <p>An optional Amazon Resource Name (ARN) of a SlackChannelConfiguration to describe.</p>
      * @public
      */
     ChatConfigurationArn?: string | undefined;
@@ -934,7 +1237,7 @@ export declare class DescribeSlackUserIdentitiesException extends __BaseExceptio
  */
 export interface DescribeSlackUserIdentitiesRequest {
     /**
-     * <p>The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities to describe.</p>
+     * <p>The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identities to describe.</p>
      * @public
      */
     ChatConfigurationArn?: string | undefined;
@@ -964,7 +1267,7 @@ export interface SlackUserIdentity {
      */
     IamRoleArn: string | undefined;
     /**
-     * <p>The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.</p>
+     * <p>The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identity to delete.</p>
      * @public
      */
     ChatConfigurationArn: string | undefined;
@@ -1073,6 +1376,26 @@ export interface DescribeSlackWorkspacesResult {
      */
     NextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DisassociateFromConfigurationRequest {
+    /**
+     * <p>The resource (for example, a custom action) Amazon Resource Name (ARN) to unlink.</p>
+     * @public
+     */
+    Resource: string | undefined;
+    /**
+     * <p>The channel configuration the resource is being disassociated from.</p>
+     * @public
+     */
+    ChatConfiguration: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DisassociateFromConfigurationResult {
+}
 /**
  * <p>We can’t process your request right now because of a server issue. Try again later.</p>
  * @public
@@ -1119,7 +1442,7 @@ export declare class GetTeamsChannelConfigurationException extends __BaseExcepti
  */
 export interface GetTeamsChannelConfigurationRequest {
     /**
-     * <p>The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.</p>
+     * <p>The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.</p>
      * @public
      */
     ChatConfigurationArn: string | undefined;
@@ -1135,17 +1458,39 @@ export interface GetTeamsChannelConfigurationResult {
     ChannelConfiguration?: TeamsChannelConfiguration | undefined;
 }
 /**
- * <p>Unexpected error during processing of request.</p>
  * @public
  */
-export declare class InternalServiceError extends __BaseException {
-    readonly name: "InternalServiceError";
-    readonly $fault: "server";
-    Message?: string | undefined;
+export interface ListAssociationsRequest {
     /**
-     * @internal
+     * <p>The channel configuration to list associations for.</p>
+     * @public
      */
-    constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
+    ChatConfiguration: string | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListAssociationsResult {
+    /**
+     * <p>The resources associated with this channel configuration.</p>
+     * @public
+     */
+    Associations: AssociationListing[] | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
 }
 /**
  * <p>We can’t process your request right now because of a server issue. Try again later.</p>
@@ -1258,7 +1603,7 @@ export declare class ListMicrosoftTeamsUserIdentitiesException extends __BaseExc
  */
 export interface ListMicrosoftTeamsUserIdentitiesRequest {
     /**
-     * <p>The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.</p>
+     * <p>The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.</p>
      * @public
      */
     ChatConfigurationArn?: string | undefined;
@@ -1341,7 +1686,7 @@ export interface ListMicrosoftTeamsUserIdentitiesResult {
  */
 export interface ListTagsForResourceRequest {
     /**
-     * <p>The ARN you specified to list the tags of.</p>
+     * <p>The ARN of the resource to list tags for.</p>
      * @public
      */
     ResourceARN: string | undefined;
@@ -1478,7 +1823,7 @@ export declare class UpdateChimeWebhookConfigurationException extends __BaseExce
  */
 export interface UpdateChimeWebhookConfigurationRequest {
     /**
-     * <p>The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update.</p>
+     * <p>The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to update.</p>
      * @public
      */
     ChatConfigurationArn: string | undefined;
@@ -1540,7 +1885,7 @@ export declare class UpdateTeamsChannelConfigurationException extends __BaseExce
  */
 export interface UpdateTeamsChannelConfigurationRequest {
     /**
-     * <p>The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update.</p>
+     * <p>The Amazon Resource Name (ARN) of the TeamsChannelConfiguration to update.</p>
      * @public
      */
     ChatConfigurationArn: string | undefined;
@@ -1611,7 +1956,7 @@ export declare class UpdateSlackChannelConfigurationException extends __BaseExce
  */
 export interface UpdateSlackChannelConfigurationRequest {
     /**
-     * <p>The Amazon Resource Number (ARN) of the SlackChannelConfiguration to update.</p>
+     * <p>The Amazon Resource Name (ARN) of the SlackChannelConfiguration to update.</p>
      * @public
      */
     ChatConfigurationArn: string | undefined;

package/dist-types/pagination/ListAssociationsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListAssociationsCommandInput, ListAssociationsCommandOutput } from "../commands/ListAssociationsCommand";
+import { ChatbotPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListAssociations: (config: ChatbotPaginationConfiguration, input: ListAssociationsCommandInput, ...rest: any[]) => Paginator<ListAssociationsCommandOutput>;

package/dist-types/pagination/ListCustomActionsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListCustomActionsCommandInput, ListCustomActionsCommandOutput } from "../commands/ListCustomActionsCommand";
+import { ChatbotPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListCustomActions: (config: ChatbotPaginationConfiguration, input: ListCustomActionsCommandInput, ...rest: any[]) => Paginator<ListCustomActionsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -3,6 +3,8 @@ export * from "./DescribeSlackChannelConfigurationsPaginator";
 export * from "./DescribeSlackUserIdentitiesPaginator";
 export * from "./DescribeSlackWorkspacesPaginator";
 export * from "./Interfaces";
+export * from "./ListAssociationsPaginator";
+export * from "./ListCustomActionsPaginator";
 export * from "./ListMicrosoftTeamsChannelConfigurationsPaginator";
 export * from "./ListMicrosoftTeamsConfiguredTeamsPaginator";
 export * from "./ListMicrosoftTeamsUserIdentitiesPaginator";