From bfb97abea30f3b582b520798047626e302dd9028 Mon Sep 17 00:00:00 2001
From: awstools Associates a source resource with a migration task. For example, the source resource can
+ * be a source server, an application, or a migration wave. You do not have sufficient access to perform this action. Exception raised to indicate a successfully authorized action when the
+ * Exception raised when an internal, configuration, or dependency error is
+ * encountered. Exception raised when the provided input violates a policy constraint or is entered in
+ * the wrong format or data type. Exception raised when the request references a resource (Application Discovery Service
+ * configuration, update stream, migration task, etc.) that does not exist in Application
+ * Discovery Service (Application Discovery Service) or in Migration Hub's repository. Exception raised when there is an internal, configuration, or dependency error
+ * encountered. The request was denied due to request throttling. Exception raised to indicate a request was not authorized when the Base exception class for all service exceptions from MigrationHub service. Removes the association between a source resource and a migration task. You do not have sufficient access to perform this action. Exception raised to indicate a successfully authorized action when the
+ * Exception raised when an internal, configuration, or dependency error is
+ * encountered. Exception raised when the provided input violates a policy constraint or is entered in
+ * the wrong format or data type. Exception raised when the request references a resource (Application Discovery Service
+ * configuration, update stream, migration task, etc.) that does not exist in Application
+ * Discovery Service (Application Discovery Service) or in Migration Hub's repository. Exception raised when there is an internal, configuration, or dependency error
+ * encountered. The request was denied due to request throttling. Exception raised to indicate a request was not authorized when the Base exception class for all service exceptions from MigrationHub service. This is a paginated API that returns all the migration-task states for the specified
+ * You do not have sufficient access to perform this action. Exception raised when an internal, configuration, or dependency error is
+ * encountered. Exception raised when the provided input violates a policy constraint or is entered in
+ * the wrong format or data type. Exception raised when the request references a resource (Application Discovery Service
+ * configuration, update stream, migration task, etc.) that does not exist in Application
+ * Discovery Service (Application Discovery Service) or in Migration Hub's repository. Exception raised when there is an internal, configuration, or dependency error
+ * encountered. The request was denied due to request throttling. Base exception class for all service exceptions from MigrationHub service. Lists all the source resource that are associated with the specified
+ * You do not have sufficient access to perform this action. Exception raised when an internal, configuration, or dependency error is
+ * encountered. Exception raised when the provided input violates a policy constraint or is entered in
+ * the wrong format or data type. Exception raised when the request references a resource (Application Discovery Service
+ * configuration, update stream, migration task, etc.) that does not exist in Application
+ * Discovery Service (Application Discovery Service) or in Migration Hub's repository. Exception raised when there is an internal, configuration, or dependency error
+ * encountered. The request was denied due to request throttling. Base exception class for all service exceptions from MigrationHub service. Because this is an asynchronous call, it will always return 200, whether an
* association occurs or not. To confirm if an association was found based on the provided
diff --git a/clients/client-migration-hub/src/commands/index.ts b/clients/client-migration-hub/src/commands/index.ts
index c51018ee33c8..8e153459f915 100644
--- a/clients/client-migration-hub/src/commands/index.ts
+++ b/clients/client-migration-hub/src/commands/index.ts
@@ -1,18 +1,22 @@
// smithy-typescript generated code
export * from "./AssociateCreatedArtifactCommand";
export * from "./AssociateDiscoveredResourceCommand";
+export * from "./AssociateSourceResourceCommand";
export * from "./CreateProgressUpdateStreamCommand";
export * from "./DeleteProgressUpdateStreamCommand";
export * from "./DescribeApplicationStateCommand";
export * from "./DescribeMigrationTaskCommand";
export * from "./DisassociateCreatedArtifactCommand";
export * from "./DisassociateDiscoveredResourceCommand";
+export * from "./DisassociateSourceResourceCommand";
export * from "./ImportMigrationTaskCommand";
export * from "./ListApplicationStatesCommand";
export * from "./ListCreatedArtifactsCommand";
export * from "./ListDiscoveredResourcesCommand";
+export * from "./ListMigrationTaskUpdatesCommand";
export * from "./ListMigrationTasksCommand";
export * from "./ListProgressUpdateStreamsCommand";
+export * from "./ListSourceResourcesCommand";
export * from "./NotifyApplicationStateCommand";
export * from "./NotifyMigrationTaskStateCommand";
export * from "./PutResourceAttributesCommand";
diff --git a/clients/client-migration-hub/src/models/models_0.ts b/clients/client-migration-hub/src/models/models_0.ts
index dfc369e82825..a1a896dc66b3 100644
--- a/clients/client-migration-hub/src/models/models_0.ts
+++ b/clients/client-migration-hub/src/models/models_0.ts
@@ -399,6 +399,76 @@ export class PolicyErrorException extends __BaseException {
}
}
+/**
+ * A source resource can be a source server, a migration wave, an application, or any other
+ * resource that you track. This is the name that you want to use to identify the resource. If the resource is an
+ * AWS resource, we recommend that you set this parameter to the ARN of the resource. A description that can be free-form text to record additional detail about the resource
+ * for clarity or later reference. A free-form description of the status of the resource. The name of the progress-update stream, which is used for access control as well as a
+ * namespace for migration-task names that is implicitly linked to your AWS account. The
+ * progress-update stream must uniquely identify the migration tool as it is used for all
+ * updates made by the tool; however, it does not need to be unique for each AWS account
+ * because it is scoped to the AWS account. A unique identifier that references the migration task. Do not include
+ * sensitive data in this field.
+ * The source resource that you want to associate. This is an optional parameter that you can use to test whether the call will succeed.
+ * Set this parameter to Attribute associated with a resource. Note the corresponding format required per type listed below: The name of the progress-update stream, which is used for access control as well as a
+ * namespace for migration-task names that is implicitly linked to your AWS account. The
+ * progress-update stream must uniquely identify the migration tool as it is used for all
+ * updates made by the tool; however, it does not need to be unique for each AWS account
+ * because it is scoped to the AWS account. A unique identifier that references the migration task. Do not include
+ * sensitive data in this field.
+ * The name that was specified for the source resource. This is an optional parameter that you can use to test whether the call will succeed.
+ * Set this parameter to The name of the progress-update stream, which is used for access control as well as a
+ * namespace for migration-task names that is implicitly linked to your AWS account. The
+ * progress-update stream must uniquely identify the migration tool as it is used for all
+ * updates made by the tool; however, it does not need to be unique for each AWS account
+ * because it is scoped to the AWS account. A unique identifier that references the migration task. Do not include
+ * sensitive data in this field.
+ * If The maximum number of results to include in the response. If more results exist than the
+ * value that you specify here for A migration-task progress update. The timestamp for the update. The type of the update. Task object encapsulating task information. If the response includes a The list of migration-task updates. The name of the progress-update stream, which is used for access control as well as a
+ * namespace for migration-task names that is implicitly linked to your AWS account. The
+ * progress-update stream must uniquely identify the migration tool as it is used for all
+ * updates made by the tool; however, it does not need to be unique for each AWS account
+ * because it is scoped to the AWS account. A unique identifier that references the migration task. Do not store
+ * confidential data in this field.
+ * If The maximum number of results to include in the response. If more results exist than the
+ * value that you specify here for If the response includes a The list of source resources. If any "VM" related value is set for a Associates a source resource with a migration task. For example, the source resource can\n be a source server, an application, or a migration wave. The name of the progress-update stream, which is used for access control as well as a\n namespace for migration-task names that is implicitly linked to your AWS account. The\n progress-update stream must uniquely identify the migration tool as it is used for all\n updates made by the tool; however, it does not need to be unique for each AWS account\n because it is scoped to the AWS account. A unique identifier that references the migration task. Do not include\n sensitive data in this field.\n The source resource that you want to associate. This is an optional parameter that you can use to test whether the call will succeed.\n Set this parameter to Removes the association between a source resource and a migration task. The name of the progress-update stream, which is used for access control as well as a\n namespace for migration-task names that is implicitly linked to your AWS account. The\n progress-update stream must uniquely identify the migration tool as it is used for all\n updates made by the tool; however, it does not need to be unique for each AWS account\n because it is scoped to the AWS account. A unique identifier that references the migration task. Do not include\n sensitive data in this field.\n The name that was specified for the source resource. This is an optional parameter that you can use to test whether the call will succeed.\n Set this parameter to This is a paginated API that returns all the migration-task states for the specified\n The name of the progress-update stream, which is used for access control as well as a\n namespace for migration-task names that is implicitly linked to your AWS account. The\n progress-update stream must uniquely identify the migration tool as it is used for all\n updates made by the tool; however, it does not need to be unique for each AWS account\n because it is scoped to the AWS account. A unique identifier that references the migration task. Do not include\n sensitive data in this field.\n If The maximum number of results to include in the response. If more results exist than the\n value that you specify here for If the response includes a The list of migration-task updates. Lists all the source resource that are associated with the specified\n The name of the progress-update stream, which is used for access control as well as a\n namespace for migration-task names that is implicitly linked to your AWS account. The\n progress-update stream must uniquely identify the migration tool as it is used for all\n updates made by the tool; however, it does not need to be unique for each AWS account\n because it is scoped to the AWS account. A unique identifier that references the migration task. Do not store\n confidential data in this field.\n If The maximum number of results to include in the response. If more results exist than the\n value that you specify here for If the response includes a The list of source resources. The timestamp for the update. The type of the update. A migration-task progress update. Provides identifying details of the resource being migrated so that it can be associated\n in the Application Discovery Service repository. This association occurs asynchronously\n after Keep in mind that subsequent calls to PutResourceAttributes will override\n previously stored attributes. For example, if it is first called with a MAC\n address, but later, it is desired to add an IP address, it\n will then be required to call it with both the IP and MAC\n addresses to prevent overriding the MAC address. Note the instructions regarding the special use case of the \n Because this is an asynchronous call, it will always return 200, whether an\n association occurs or not. To confirm if an association was found based on the provided\n details, call Provides identifying details of the resource being migrated so that it can be associated\n in the Application Discovery Service repository. This association occurs asynchronously\n after Keep in mind that subsequent calls to PutResourceAttributes will override\n previously stored attributes. For example, if it is first called with a MAC\n address, but later, it is desired to add an IP address, it\n will then be required to call it with both the IP and MAC\n addresses to prevent overriding the MAC address. Note the instructions regarding the special use case of the \n Because this is an asynchronous call, it will always return 200, whether an\n association occurs or not. To confirm if an association was found based on the provided\n details, call Information about the resource that is being migrated. This data will be used to map the\n task to a resource in the Application Discovery Service repository. Takes the object array of If any \"VM\" related value is set for a If a server you are trying to match has multiple IP or MAC addresses, you\n should provide as many as you know in separate type/value pairs passed to the\n Information about the resource that is being migrated. This data will be used to map the\n task to a resource in the Application Discovery Service repository. Takes the object array of If any \"VM\" related value is set for a If a server you are trying to match has multiple IP or MAC addresses, you\n should provide as many as you know in separate type/value pairs passed to the\n Attribute associated with a resource. Note the corresponding format required per type listed below: \n \n where x is an integer in the range [0,255]\n \n \n where y is a hexadecimal between 0 and FFFF. [0,\n FFFF]\n \n \n Attribute associated with a resource. Note the corresponding format required per type listed below: \n \n where x is an integer in the range [0,255]\n \n \n where y is a hexadecimal between 0 and FFFF. [0,\n FFFF]\n \n \n This is the name that you want to use to identify the resource. If the resource is an\n AWS resource, we recommend that you set this parameter to the ARN of the resource. A description that can be free-form text to record additional detail about the resource\n for clarity or later reference. A free-form description of the status of the resource. A source resource can be a source server, a migration wave, an application, or any other\n resource that you track. A field in a CloudTrail event record on which to filter events to be logged. For
* event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for
* selecting events as filtering is not supported. For CloudTrail management events, supported fields include
- * For CloudTrail data events, supported fields include For CloudTrail network activity events, supported fields include For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is
- *
- *
- *
- *
- * For management events for trails, this is an optional field that can be set to For management and data events for event data stores, you can use it to include or
- * exclude any event source and can use any operator. For network activity events, this is a required field that only uses the
- * The following are valid values for network activity events:
- *
- *
- *
- *
- *
- *
- *
- *
- * For CloudTrail management events, the value
- * must be
- * For CloudTrail data events, the value
- * must be
- * For CloudTrail network activity events, the value
- * must be The following are used only for event data stores:
- * For CloudTrail Insights events, the value
- * must be
- * For Config
- * configuration items, the value must be
- * For Audit Manager evidence, the value must be
- * For events outside of Amazon Web Services, the value must be
- *
- *
- *
- *
- *
- *
- *
- * For a list of available resource types for data events, see Data events in the CloudTrail User Guide. You can have only one
- *
- * For information about filtering data events on the You can't use the
- *
- *
- *
- * For more information, see
+ * AdvancedFieldSelector
+ * in the CloudTrailUser Guide. You cannot apply both event selectors and advanced event selectors to a trail.
- * Supported CloudTrail event record fields for management events
- *
- *
- *
- * The following additional fields are available for event data stores:
- *
- *
- *
- *
- * Supported CloudTrail event record fields for data events
- *
- *
- *
- *
- *
- * The following additional fields are available for event data stores:
- *
- *
- *
- *
- * Supported CloudTrail event record fields for network activity events
- * Network activity events is in preview release for CloudTrail and is subject to change.
- *
- *
- *
- *
- * For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is
- * For information about configurable advanced event selector fields, see
+ * AdvancedEventSelector
+ * in the CloudTrailUser Guide. Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those\n events that are important to you. For more information about configuring advanced event selectors, see\n the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide. You cannot apply both event selectors and advanced event selectors to a trail. \n Supported CloudTrail event record fields for management events\n \n \n \n The following additional fields are available for event data stores: \n \n \n \n \n Supported CloudTrail event record fields for data events\n \n \n \n \n \n The following additional fields are available for event data stores: \n \n \n \n \n Supported CloudTrail event record fields for network activity events\n Network activity events is in preview release for CloudTrail and is subject to change. \n \n \n \n \n For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those\n events that are important to you. For more information about configuring advanced event selectors, see\n the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide. You cannot apply both event selectors and advanced event selectors to a trail. For information about configurable advanced event selector fields, see \n AdvancedEventSelector \n in the CloudTrailUser Guide. A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported. For CloudTrail management events, supported fields include\n For CloudTrail data events, supported fields include For CloudTrail network activity events, supported fields include For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n \n \n \n \n For management events for trails, this is an optional field that can be set to For management and data events for event data stores, you can use it to include or\n exclude any event source and can use any operator. For network activity events, this is a required field that only uses the\n The following are valid values for network activity events: \n \n \n \n \n \n \n \n \n For CloudTrail management events, the value\n must be \n For CloudTrail data events, the value\n must be \n For CloudTrail network activity events, the value\n must be The following are used only for event data stores: \n For CloudTrail Insights events, the value\n must be \n For Config\n configuration items, the value must be \n For Audit Manager evidence, the value must be \n For events outside of Amazon Web Services, the value must be \n \n \n \n \n \n \n \n For a list of available resource types for data events, see Data events in the CloudTrail User Guide. You can have only one \n \n For information about filtering data events on the You can't use the \n \n \n \n A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported. For more information, see \n AdvancedFieldSelector \n in the CloudTrailUser Guide.
+AssociateSourceResource
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/migration-hub/command/AssociateSourceResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/AssociateSourceResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/AssociateSourceResourceCommandOutput/)
+
@@ -271,6 +279,14 @@ DisassociateDiscoveredResource
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/migration-hub/command/DisassociateDiscoveredResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/DisassociateDiscoveredResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/DisassociateDiscoveredResourceCommandOutput/)
+
+DisassociateSourceResource
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/migration-hub/command/DisassociateSourceResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/DisassociateSourceResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/DisassociateSourceResourceCommandOutput/)
+
@@ -311,6 +327,14 @@ ListMigrationTasks
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/migration-hub/command/ListMigrationTasksCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListMigrationTasksCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListMigrationTasksCommandOutput/)
+
+ListMigrationTaskUpdates
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/migration-hub/command/ListMigrationTaskUpdatesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListMigrationTaskUpdatesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListMigrationTaskUpdatesCommandOutput/)
+
@@ -319,6 +343,14 @@ ListProgressUpdateStreams
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/migration-hub/command/ListProgressUpdateStreamsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListProgressUpdateStreamsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListProgressUpdateStreamsCommandOutput/)
+
+ListSourceResources
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/migration-hub/command/ListSourceResourcesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListSourceResourcesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-migration-hub/Interface/ListSourceResourcesCommandOutput/)
+
diff --git a/clients/client-migration-hub/src/MigrationHub.ts b/clients/client-migration-hub/src/MigrationHub.ts
index b4a14038dd11..9d602f4dafd6 100644
--- a/clients/client-migration-hub/src/MigrationHub.ts
+++ b/clients/client-migration-hub/src/MigrationHub.ts
@@ -12,6 +12,11 @@ import {
AssociateDiscoveredResourceCommandInput,
AssociateDiscoveredResourceCommandOutput,
} from "./commands/AssociateDiscoveredResourceCommand";
+import {
+ AssociateSourceResourceCommand,
+ AssociateSourceResourceCommandInput,
+ AssociateSourceResourceCommandOutput,
+} from "./commands/AssociateSourceResourceCommand";
import {
CreateProgressUpdateStreamCommand,
CreateProgressUpdateStreamCommandInput,
@@ -42,6 +47,11 @@ import {
DisassociateDiscoveredResourceCommandInput,
DisassociateDiscoveredResourceCommandOutput,
} from "./commands/DisassociateDiscoveredResourceCommand";
+import {
+ DisassociateSourceResourceCommand,
+ DisassociateSourceResourceCommandInput,
+ DisassociateSourceResourceCommandOutput,
+} from "./commands/DisassociateSourceResourceCommand";
import {
ImportMigrationTaskCommand,
ImportMigrationTaskCommandInput,
@@ -67,11 +77,21 @@ import {
ListMigrationTasksCommandInput,
ListMigrationTasksCommandOutput,
} from "./commands/ListMigrationTasksCommand";
+import {
+ ListMigrationTaskUpdatesCommand,
+ ListMigrationTaskUpdatesCommandInput,
+ ListMigrationTaskUpdatesCommandOutput,
+} from "./commands/ListMigrationTaskUpdatesCommand";
import {
ListProgressUpdateStreamsCommand,
ListProgressUpdateStreamsCommandInput,
ListProgressUpdateStreamsCommandOutput,
} from "./commands/ListProgressUpdateStreamsCommand";
+import {
+ ListSourceResourcesCommand,
+ ListSourceResourcesCommandInput,
+ ListSourceResourcesCommandOutput,
+} from "./commands/ListSourceResourcesCommand";
import {
NotifyApplicationStateCommand,
NotifyApplicationStateCommandInput,
@@ -92,18 +112,22 @@ import { MigrationHubClient, MigrationHubClientConfig } from "./MigrationHubClie
const commands = {
AssociateCreatedArtifactCommand,
AssociateDiscoveredResourceCommand,
+ AssociateSourceResourceCommand,
CreateProgressUpdateStreamCommand,
DeleteProgressUpdateStreamCommand,
DescribeApplicationStateCommand,
DescribeMigrationTaskCommand,
DisassociateCreatedArtifactCommand,
DisassociateDiscoveredResourceCommand,
+ DisassociateSourceResourceCommand,
ImportMigrationTaskCommand,
ListApplicationStatesCommand,
ListCreatedArtifactsCommand,
ListDiscoveredResourcesCommand,
ListMigrationTasksCommand,
+ ListMigrationTaskUpdatesCommand,
ListProgressUpdateStreamsCommand,
+ ListSourceResourcesCommand,
NotifyApplicationStateCommand,
NotifyMigrationTaskStateCommand,
PutResourceAttributesCommand,
@@ -144,6 +168,23 @@ export interface MigrationHub {
cb: (err: any, data?: AssociateDiscoveredResourceCommandOutput) => void
): void;
+ /**
+ * @see {@link AssociateSourceResourceCommand}
+ */
+ associateSourceResource(
+ args: AssociateSourceResourceCommandInput,
+ options?: __HttpHandlerOptions
+ ): Promise
DryRun
flag is set to "true".DryRun
+ * flag is set to "true".DryRun
flag is set to "true".DryRun
+ * flag is set to "true".MigrationTaskName
and ProgressUpdateStream
.MigrationTaskName
and ProgressUpdateStream
.true
to verify that you have the permissions that are
+ * required to make the call, and that you have specified the other parameters in the call
+ * correctly.
*
true
to verify that you have the permissions that are
+ * required to make the call, and that you have specified the other parameters in the call
+ * correctly.NextToken
was returned by a previous call, there are more results
+ * available. The value of NextToken
is a unique pagination token for each page.
+ * To retrieve the next page of results, specify the NextToken
value that the
+ * previous call returned. Keep all other arguments unchanged. Each pagination token expires
+ * after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken
+ * error.MaxResults
, the response will include a token
+ * that you can use to retrieve the next set of results.NextToken
value, that means that there are more
+ * results available. The value of NextToken
is a unique pagination token for
+ * each page. To retrieve the next page of results, call this API again and specify this
+ * NextToken
value in the request. Keep all other arguments unchanged. Each
+ * pagination token expires after 24 hours. Using an expired pagination token will return an
+ * HTTP 400 InvalidToken error.NextToken
was returned by a previous call, there are more results
+ * available. The value of NextToken
is a unique pagination token for each page.
+ * To retrieve the next page of results, specify the NextToken
value that the
+ * previous call returned. Keep all other arguments unchanged. Each pagination token expires
+ * after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken
+ * error.MaxResults
, the response will include a token
+ * that you can use to retrieve the next set of results.NextToken
value, that means that there are more
+ * results available. The value of NextToken
is a unique pagination token for
+ * each page. To retrieve the next page of results, call this API again and specify this
+ * NextToken
value in the request. Keep all other arguments unchanged. Each
+ * pagination token expires after 24 hours. Using an expired pagination token will return an
+ * HTTP 400 InvalidToken error.
*
ResourceAttribute
object,
* it is required that VM_MANAGER_ID
, as a minimum, is always set. If
* VM_MANAGER_ID
is not set, then all "VM" fields will be discarded
diff --git a/clients/client-migration-hub/src/pagination/ListMigrationTaskUpdatesPaginator.ts b/clients/client-migration-hub/src/pagination/ListMigrationTaskUpdatesPaginator.ts
new file mode 100644
index 000000000000..f95e45b99650
--- /dev/null
+++ b/clients/client-migration-hub/src/pagination/ListMigrationTaskUpdatesPaginator.ts
@@ -0,0 +1,24 @@
+// smithy-typescript generated code
+import { createPaginator } from "@smithy/core";
+import { Paginator } from "@smithy/types";
+
+import {
+ ListMigrationTaskUpdatesCommand,
+ ListMigrationTaskUpdatesCommandInput,
+ ListMigrationTaskUpdatesCommandOutput,
+} from "../commands/ListMigrationTaskUpdatesCommand";
+import { MigrationHubClient } from "../MigrationHubClient";
+import { MigrationHubPaginationConfiguration } from "./Interfaces";
+
+/**
+ * @public
+ */
+export const paginateListMigrationTaskUpdates: (
+ config: MigrationHubPaginationConfiguration,
+ input: ListMigrationTaskUpdatesCommandInput,
+ ...rest: any[]
+) => Paginatortrue
to verify that you have the permissions that are\n required to make the call, and that you have specified the other parameters in the call\n correctly.true
to verify that you have the permissions that are\n required to make the call, and that you have specified the other parameters in the call\n correctly.MigrationTaskName
and ProgressUpdateStream
.NextToken
was returned by a previous call, there are more results\n available. The value of NextToken
is a unique pagination token for each page.\n To retrieve the next page of results, specify the NextToken
value that the\n previous call returned. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken\n error.MaxResults
, the response will include a token\n that you can use to retrieve the next set of results.NextToken
value, that means that there are more\n results available. The value of NextToken
is a unique pagination token for\n each page. To retrieve the next page of results, call this API again and specify this\n NextToken
value in the request. Keep all other arguments unchanged. Each\n pagination token expires after 24 hours. Using an expired pagination token will return an\n HTTP 400 InvalidToken error.MigrationTaskName
and ProgressUpdateStream
.NextToken
was returned by a previous call, there are more results\n available. The value of NextToken
is a unique pagination token for each page.\n To retrieve the next page of results, specify the NextToken
value that the\n previous call returned. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken\n error.MaxResults
, the response will include a token\n that you can use to retrieve the next set of results.NextToken
value, that means that there are more\n results available. The value of NextToken
is a unique pagination token for\n each page. To retrieve the next page of results, call this API again and specify this\n NextToken
value in the request. Keep all other arguments unchanged. Each\n pagination token expires after 24 hours. Using an expired pagination token will return an\n HTTP 400 InvalidToken error.PutResourceAttributes
returns.\n
\n ResourceAttributeList
\n parameter when specifying any\n \"VM\" related value.ListDiscoveredResources
.PutResourceAttributes
returns.\n
\n ResourceAttributeList
\n parameter when specifying any\n \"VM\" related value.ListDiscoveredResources
.ResourceAttribute
where the Type
\n field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS |\n MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH\n | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER
where the identifying value can be a\n string up to 256 characters.\n
\n ResourceAttribute
object,\n it is required that VM_MANAGER_ID
, as a minimum, is always set. If\n VM_MANAGER_ID
is not set, then all \"VM\" fields will be discarded\n and \"VM\" fields will not be used for matching the migration task to a server in\n Application Discovery Service repository. See the Example section below for a use case of specifying \"VM\" related\n values.ResourceAttributeList
parameter to maximize the chances of\n matching.ResourceAttribute
where the Type
\n field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS |\n MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH\n | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER
where the identifying value can be a\n string up to 256 characters.\n
\n ResourceAttribute
object,\n it is required that VM_MANAGER_ID
, as a minimum, is always set. If\n VM_MANAGER_ID
is not set, then all \"VM\" fields will be discarded\n and \"VM\" fields will not be used for matching the migration task to a server in\n Application Discovery Service repository. See the Example section below for a use case of specifying \"VM\" related\n values.ResourceAttributeList
parameter to maximize the chances of\n matching.\n
"
+ "smithy.api#documentation": "x.x.x.x
\n y : y : y : y : y : y : y : y
\n ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
\n ^[^<>{}\\\\\\\\/?,=\\\\p{Cntrl}]{1,256}$
\n \n
"
}
},
"com.amazonaws.migrationhub#ResourceAttributeList": {
@@ -2808,6 +3204,58 @@
"smithy.api#error": "server"
}
},
+ "com.amazonaws.migrationhub#SourceResource": {
+ "type": "structure",
+ "members": {
+ "Name": {
+ "target": "com.amazonaws.migrationhub#SourceResourceName",
+ "traits": {
+ "smithy.api#documentation": "x.x.x.x
\n y : y : y : y : y : y : y : y
\n ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
\n ^[^<>{}\\\\\\\\/?,=\\\\p{Cntrl}]{1,256}$
\n eventCategory
(required), eventSource
, and
- * readOnly
. The following additional fields are available for event data
- * stores: eventName
, eventType
,
- * sessionCredentialFromConsole
, and userIdentity.arn
.eventCategory
- * (required), resources.type
(required), eventName
,
- * readOnly
, and resources.ARN
. The following additional fields
- * are available for event data stores: eventSource
, eventType
,
- * sessionCredentialFromConsole
, and userIdentity.arn
.eventCategory
(required), eventSource
(required), eventName
,
- * errorCode
, and vpcEndpointId
.eventCategory
.
- *
+ * readOnly
- * - This is an optional field that is only used for management events and data events. This field can be set to
- * Equals
with a value of true
or false
. If you do
- * not add this field, CloudTrail logs both read
and
- * write
events. A value of true
logs only
- * read
events. A value of false
logs only
- * write
events.eventSource
- * - This field is only used for management events, data events (for event data stores only), and network activity events.NotEquals
- * kms.amazonaws.com
to exclude KMS management events, or NotEquals
- * rdsdata.amazonaws.com
to exclude RDS management events.Equals
operator. Set this field to the event source for which you want to
- * log network activity events. If you want to log network activity events for multiple
- * event sources, you must create a separate field selector for each event
- * source.
- *
- * cloudtrail.amazonaws.com
- * ec2.amazonaws.com
- * kms.amazonaws.com
- * secretsmanager.amazonaws.com
- * eventName
- * - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with
- * eventName
. You can use it to filter in or filter out specific events. You can have
- * multiple values for this field, separated by commas.eventCategory
- * - This field is required and
- * must be set to Equals
.
- *
- *
- * Management
.
- * Data
.
- * NetworkActivity
.
- *
- *
- * Insight
.
- * ConfigurationItem
.
- * Evidence
.
- * ActivityAuditLog
.
- * eventType
- * - This is an optional
- * field available only for event data stores, which is used to filter management and
- * data events on the event type. For information about available event types, see
- * CloudTrail record contents in the CloudTrail user
- * guide.errorCode
- * - This field is only used to filter CloudTrail network activity events
- * and is optional. This is the error code to filter on. Currently, the only valid errorCode
is VpceAccessDenied
.
- * errorCode
can only use the Equals
operator.sessionCredentialFromConsole
- * - This
- * is an optional field available only for event data stores, which is used to filter
- * management and data events based on whether the events originated from an Amazon Web Services Management Console session. sessionCredentialFromConsole
can only use the
- * Equals
and NotEquals
operators.resources.type
- * - This field is
- * required for CloudTrail data events. resources.type
can only
- * use the Equals
operator.resources.type
field per selector. To log events on more than one resource type, add another selector.resources.ARN
- * - The resources.ARN
is an optional field for
- * data events. You can use any
- * operator with resources.ARN
, but if you use Equals
or
- * NotEquals
, the value must exactly match the ARN of a valid resource
- * of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket,
- * use the StartsWith
operator, and include only the bucket ARN as the matching value.resources.ARN
field, see
- * Filtering data
- * events by resources.ARN in the CloudTrail User Guide.resources.ARN
field to filter resource types that do not have ARNs.userIdentity.arn
- * - This is an
- * optional field available only for event data stores, which is used to filter
- * management and data events on the userIdentity ARN. You can use any operator with
- * userIdentity.arn
. For more information on the userIdentity element,
- * see CloudTrail userIdentity element in the CloudTrail User Guide.vpcEndpointId
- * - This field is only used to filter CloudTrail network activity events
- * and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId
.
- *
- * eventCategory
(required)eventSource
- * readOnly
- *
- *
- * eventName
- * eventType
- * sessionCredentialFromConsole
- * userIdentity.arn
- *
- *
- * eventCategory
(required)resources.type
(required)readOnly
- * eventName
- * resources.ARN
- *
- *
- * eventSource
- * eventType
- * sessionCredentialFromConsole
- * userIdentity.arn
- *
- *
- * eventCategory
(required)eventSource
(required)eventName
- * errorCode
- The only valid value for errorCode
is VpceAccessDenied
.vpcEndpointId
- * eventCategory
. \n
\n eventCategory
(required)eventSource
\n readOnly
\n \n
\n eventName
\n eventType
\n sessionCredentialFromConsole
\n userIdentity.arn
\n \n
\n eventCategory
(required)resources.type
(required)readOnly
\n eventName
\n resources.ARN
\n \n
\n eventSource
\n eventType
\n sessionCredentialFromConsole
\n userIdentity.arn
\n \n
\n eventCategory
(required)eventSource
(required)eventName
\n errorCode
- The only valid value for errorCode
is VpceAccessDenied
.vpcEndpointId
\n eventCategory
. eventCategory
(required), eventSource
, and\n readOnly
. The following additional fields are available for event data\n stores: eventName
, eventType
,\n sessionCredentialFromConsole
, and userIdentity.arn
.eventCategory
\n (required), resources.type
(required), eventName
,\n readOnly
, and resources.ARN
. The following additional fields\n are available for event data stores: eventSource
, eventType
,\n sessionCredentialFromConsole
, and userIdentity.arn
.eventCategory
(required), eventSource
(required), eventName
,\n errorCode
, and vpcEndpointId
.eventCategory
. \n
",
+ "smithy.api#documentation": "readOnly
\n - This is an optional field that is only used for management events and data events. This field can be set to\n Equals
with a value of true
or false
. If you do\n not add this field, CloudTrail logs both read
and\n write
events. A value of true
logs only\n read
events. A value of false
logs only\n write
events.eventSource
\n - This field is only used for management events, data events (for event data stores only), and network activity events.NotEquals
\n kms.amazonaws.com
to exclude KMS management events, or NotEquals
\n rdsdata.amazonaws.com
to exclude RDS management events.Equals
operator. Set this field to the event source for which you want to\n log network activity events. If you want to log network activity events for multiple\n event sources, you must create a separate field selector for each event\n source.\n
\n cloudtrail.amazonaws.com
\n ec2.amazonaws.com
\n kms.amazonaws.com
\n secretsmanager.amazonaws.com
\n eventName
\n - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with \n eventName
. You can use it to filter in or filter out specific events. You can have\n multiple values for this field, separated by commas.eventCategory
\n - This field is required and\n must be set to Equals
. \n \n
\n Management
. \n Data
. \n NetworkActivity
. \n \n
\n Insight
. \n ConfigurationItem
.\n Evidence
.\n ActivityAuditLog
.\n eventType
\n - This is an optional\n field available only for event data stores, which is used to filter management and\n data events on the event type. For information about available event types, see\n CloudTrail record contents in the CloudTrail user\n guide.errorCode
\n - This field is only used to filter CloudTrail network activity events\n and is optional. This is the error code to filter on. Currently, the only valid errorCode
is VpceAccessDenied
. \n errorCode
can only use the Equals
operator.sessionCredentialFromConsole
\n - This\n is an optional field available only for event data stores, which is used to filter\n management and data events based on whether the events originated from an Amazon Web Services Management Console session. sessionCredentialFromConsole
can only use the\n Equals
and NotEquals
operators.resources.type
\n - This field is\n required for CloudTrail data events. resources.type
can only\n use the Equals
operator.resources.type
field per selector. To log events on more than one resource type, add another selector.resources.ARN
\n - The resources.ARN
is an optional field for \n data events. You can use any\n operator with resources.ARN
, but if you use Equals
or\n NotEquals
, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, \n use the StartsWith
operator, and include only the bucket ARN as the matching value.resources.ARN
field, see \n Filtering data \n events by resources.ARN in the CloudTrail User Guide.resources.ARN
field to filter resource types that do not have ARNs.userIdentity.arn
\n - This is an\n optional field available only for event data stores, which is used to filter\n management and data events on the userIdentity ARN. You can use any operator with\n userIdentity.arn
. For more information on the userIdentity element,\n see CloudTrail userIdentity element in the CloudTrail User Guide.vpcEndpointId
\n - This field is only used to filter CloudTrail network activity events\n and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId
.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.
diff --git a/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts b/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts index f41a64e93eb2..1c90525a0d12 100644 --- a/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts +++ b/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts @@ -2477,6 +2477,11 @@ export interface CognitoIdentityProvider { * for Ruby V3 * * + *To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services * SDKs.
diff --git a/clients/client-cognito-identity-provider/src/CognitoIdentityProviderClient.ts b/clients/client-cognito-identity-provider/src/CognitoIdentityProviderClient.ts index f36925f0313e..81f8cded0865 100644 --- a/clients/client-cognito-identity-provider/src/CognitoIdentityProviderClient.ts +++ b/clients/client-cognito-identity-provider/src/CognitoIdentityProviderClient.ts @@ -866,6 +866,11 @@ export interface CognitoIdentityProviderClientResolvedConfig extends CognitoIden * for Ruby V3 * * + *To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services * SDKs.
diff --git a/clients/client-cognito-identity-provider/src/commands/AddCustomAttributesCommand.ts b/clients/client-cognito-identity-provider/src/commands/AddCustomAttributesCommand.ts index 0577edd774ca..3de2ab2d5e30 100644 --- a/clients/client-cognito-identity-provider/src/commands/AddCustomAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AddCustomAttributesCommand.ts @@ -32,7 +32,12 @@ export interface AddCustomAttributesCommandInput extends AddCustomAttributesRequ export interface AddCustomAttributesCommandOutput extends AddCustomAttributesResponse, __MetadataBearer {} /** - *Adds additional user attributes to the user pool schema.
+ *Adds additional user attributes to the user pool schema. Custom attributes can be
+ * mutable or immutable and have a custom:
or dev:
prefix. For
+ * more information, see Custom attributes.
You can also create custom attributes in the Schema parameter of CreateUserPool
and
+ * UpdateUserPool
. You can't delete custom attributes after you
+ * create them.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminConfirmSignUpCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminConfirmSignUpCommand.ts index 3c9aaa8027f7..5c50b90d0916 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminConfirmSignUpCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminConfirmSignUpCommand.ts @@ -36,8 +36,7 @@ export interface AdminConfirmSignUpCommandInput extends AdminConfirmSignUpReques export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpResponse, __MetadataBearer {} /** - *
This IAM-authenticated API operation confirms user sign-up as an administrator. - * Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation. + *
Confirms user sign-up as an administrator. Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation. * No confirmation code is required.
*This request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can * configure your user pool to not send confirmation codes to new users and instead confirm @@ -62,6 +61,9 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo * * *
To configure your user pool to require administrative confirmation of users, set
+ * AllowAdminCreateUserOnly
to true
in a
+ * CreateUserPool
or UpdateUserPool
request.
Deletes the user attributes in a user pool as an administrator. Works on any - * user.
+ *Deletes attribute values from a user. This operation doesn't affect tokens for + * existing user sessions. The next ID token that the user receives will no longer have + * this attribute.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminDeleteUserCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminDeleteUserCommand.ts index 0153827092ff..148b76d33f85 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminDeleteUserCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminDeleteUserCommand.ts @@ -32,7 +32,7 @@ export interface AdminDeleteUserCommandInput extends AdminDeleteUserRequest {} export interface AdminDeleteUserCommandOutput extends __MetadataBearer {} /** - *
Deletes a user as an administrator. Works on any user.
+ *Deletes a user profile in your user pool.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminDisableUserCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminDisableUserCommand.ts index 4eee52f181cb..8e01ca14ef7d 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminDisableUserCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminDisableUserCommand.ts @@ -36,9 +36,9 @@ export interface AdminDisableUserCommandInput extends AdminDisableUserRequest {} export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse, __MetadataBearer {} /** - *
Deactivates a user and revokes all access tokens for the user. A deactivated user
- * can't sign in, but still appears in the responses to GetUser
and
- * ListUsers
API requests.
Deactivates a user profile and revokes all access tokens for the user. A deactivated
+ * user can't sign in, but still appears in the responses to ListUsers
+ * API requests.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminEnableUserCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminEnableUserCommand.ts index 762bd756c40e..ff306d1c7db8 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminEnableUserCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminEnableUserCommand.ts @@ -36,7 +36,8 @@ export interface AdminEnableUserCommandInput extends AdminEnableUserRequest {} export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, __MetadataBearer {} /** - *
Enables the specified user as an administrator. Works on any user.
+ *Activate sign-in for a user profile that previously had sign-in access + * disabled.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminForgetDeviceCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminForgetDeviceCommand.ts index ce10e9e8ee9a..4ff770d63d22 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminForgetDeviceCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminForgetDeviceCommand.ts @@ -32,7 +32,9 @@ export interface AdminForgetDeviceCommandInput extends AdminForgetDeviceRequest export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {} /** - *
Forgets the device, as an administrator.
+ *Forgets, or deletes, a remembered device from a user's profile. After you forget + * the device, the user can no longer complete device authentication with that device and + * when applicable, must submit MFA codes again. For more information, see Working with devices.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminGetDeviceCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminGetDeviceCommand.ts index 30bb01093e61..29a5eee1d454 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminGetDeviceCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminGetDeviceCommand.ts @@ -37,7 +37,8 @@ export interface AdminGetDeviceCommandInput extends AdminGetDeviceRequest {} export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __MetadataBearer {} /** - *
Gets the device, as an administrator.
+ *Given the device key, returns details for a user' device. For more information, + * see Working with devices.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminGetUserCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminGetUserCommand.ts index dfa3206c8c6b..e92a2de3f42b 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminGetUserCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminGetUserCommand.ts @@ -37,9 +37,9 @@ export interface AdminGetUserCommandInput extends AdminGetUserRequest {} export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __MetadataBearer {} /** - *
Gets the specified user by user name in a user pool as an administrator. Works on any - * user. This operation contributes to your monthly active user (MAU) count for the purpose - * of billing.
+ *Given the username, returns details about a user profile in a user pool. This
+ * operation contributes to your monthly active user (MAU) count for the purpose of
+ * billing. You can specify alias attributes in the Username
parameter.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminInitiateAuthCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminInitiateAuthCommand.ts index 31691d63725e..f020436e93ab 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminInitiateAuthCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminInitiateAuthCommand.ts @@ -37,7 +37,11 @@ export interface AdminInitiateAuthCommandInput extends AdminInitiateAuthRequest export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthResponse, __MetadataBearer {} /** - *
Initiates the authentication flow, as an administrator.
+ *Starts sign-in for applications with a server-side component, for example a + * traditional web application. This operation specifies the authentication flow that + * you'd like to begin. The authentication flow that you specify must be supported in + * your app client configuration. For more information about authentication flows, see + * Authentication flows.
*This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers * require you to register an origination phone number before you can send SMS messages diff --git a/clients/client-cognito-identity-provider/src/commands/AdminListDevicesCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminListDevicesCommand.ts index fc5a23111b62..987588e36ea3 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminListDevicesCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminListDevicesCommand.ts @@ -37,7 +37,10 @@ export interface AdminListDevicesCommandInput extends AdminListDevicesRequest {} export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse, __MetadataBearer {} /** - *
Lists a user's registered devices.
+ *Lists a user's registered devices. Remembered devices are used in authentication + * services where you offer a "Remember me" option for users who you want to permit to sign + * in without MFA from a trusted device. Users can bypass MFA while your application + * performs device SRP authentication on the back end. For more information, see Working with devices.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminListGroupsForUserCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminListGroupsForUserCommand.ts index f6dfe0dd0306..a4e9d8556ae1 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminListGroupsForUserCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminListGroupsForUserCommand.ts @@ -36,7 +36,9 @@ export interface AdminListGroupsForUserCommandInput extends AdminListGroupsForUs export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForUserResponse, __MetadataBearer {} /** - *
Lists the groups that a user belongs to.
+ *Lists the groups that a user belongs to. User pool groups are identifiers that you can + * reference from the contents of ID and access tokens, and set preferred IAM roles for + * identity-pool authentication. For more information, see Adding groups to a user pool.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminListUserAuthEventsCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminListUserAuthEventsCommand.ts index a006ef475a92..30f64f1e6c95 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminListUserAuthEventsCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminListUserAuthEventsCommand.ts @@ -36,8 +36,8 @@ export interface AdminListUserAuthEventsCommandInput extends AdminListUserAuthEv export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthEventsResponse, __MetadataBearer {} /** - *
A history of user activity and any risks detected as part of Amazon Cognito advanced - * security.
+ *Requests a history of user activity and any risks detected as part of Amazon Cognito threat + * protection. For more information, see Viewing user event history.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminRemoveUserFromGroupCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminRemoveUserFromGroupCommand.ts index 5d6643dd06c7..dd1b581763d5 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminRemoveUserFromGroupCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminRemoveUserFromGroupCommand.ts @@ -32,7 +32,9 @@ export interface AdminRemoveUserFromGroupCommandInput extends AdminRemoveUserFro export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer {} /** - *
Removes the specified user from the specified group.
+ *Given a username and a group name. removes them from the group. User pool groups are + * identifiers that you can reference from the contents of ID and access tokens, and set + * preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminResetUserPasswordCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminResetUserPasswordCommand.ts index 46422675b737..d7978bf9de78 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminResetUserPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminResetUserPasswordCommand.ts @@ -36,8 +36,18 @@ export interface AdminResetUserPasswordCommandInput extends AdminResetUserPasswo export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPasswordResponse, __MetadataBearer {} /** - *
Resets the specified user's password in a user pool as an administrator. Works on any - * user.
+ *Resets the specified user's password in a user pool. This operation doesn't + * change the user's password, but sends a password-reset code. This operation is the + * administrative authentication API equivalent to ForgotPassword.
+ *This operation deactivates a user's password, requiring them to change it. If a user
+ * tries to sign in after the API request, Amazon Cognito responds with a
+ * PasswordResetRequiredException
error. Your app must then complete the
+ * forgot-password flow by prompting the user for their code and a new password, then
+ * submitting those values in a ConfirmForgotPassword request. In addition, if the user
+ * pool has phone verification selected and a verified phone number exists for the user, or
+ * if email verification is selected and a verified email exists for the user, calling this
+ * API will also result in sending a message to the end user with the code to change their
+ * password.
To use this API operation, your user pool must have self-service account recovery * configured. Use AdminSetUserPassword if you manage passwords as an administrator.
*Deactivates a user's password, requiring them to change it. If a user tries to sign in
- * after the API is called, Amazon Cognito responds with a
- * PasswordResetRequiredException
error. Your app must then perform the
- * actions that reset your user's password: the forgot-password flow. In addition, if the
- * user pool has phone verification selected and a verified phone number exists for the
- * user, or if email verification is selected and a verified email exists for the user,
- * calling this API will also result in sending a message to the end user with the code to
- * change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminSetUserMFAPreferenceCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminSetUserMFAPreferenceCommand.ts index 3f8eabf180c0..3a44d748db44 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminSetUserMFAPreferenceCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminSetUserMFAPreferenceCommand.ts @@ -41,6 +41,9 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP * preferred. The preferred MFA factor will be used to authenticate a user if multiple * factors are activated. If multiple options are activated and no preference is set, a * challenge to choose an MFA option will be returned during sign-in.
+ *This operation doesn't reset an existing TOTP MFA for a user. To register a new + * TOTP factor for a user, make an AssociateSoftwareToken request. For more information, + * see TOTP software token MFA.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminSetUserPasswordCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminSetUserPasswordCommand.ts index 8ad081fb4953..1aba6159e58d 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminSetUserPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminSetUserPasswordCommand.ts @@ -36,16 +36,21 @@ export interface AdminSetUserPasswordCommandInput extends AdminSetUserPasswordRe export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordResponse, __MetadataBearer {} /** - *
Sets the specified user's password in a user pool as an administrator. Works on any - * user.
- *The password can be temporary or permanent. If it is temporary, the user status enters
- * the FORCE_CHANGE_PASSWORD
state. When the user next tries to sign in, the
- * InitiateAuth/AdminInitiateAuth response will contain the
- * NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in before it
- * expires, the user won't be able to sign in, and an administrator must reset their
- * password.
Once the user has set a new password, or the password is permanent, the user status is
- * set to Confirmed
.
Sets the specified user's password in a user pool. This operation administratively
+ * sets a temporary or permanent password for a user. With this operation, you can bypass
+ * self-service password changes and permit immediate sign-in with the password that you
+ * set. To do this, set Permanent
to true
.
You can also set a new temporary password in this request, send it to a user, and
+ * require them to choose a new password on their next sign-in. To do this, set
+ * Permanent
to false
.
If the password is temporary, the user's Status
becomes
+ * FORCE_CHANGE_PASSWORD
. When the user next tries to sign in, the
+ * InitiateAuth
or AdminInitiateAuth
response includes the
+ * NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in
+ * before the temporary password expires, they can no longer sign in and you must repeat
+ * this operation to set a temporary or permanent password for them.
After the user sets a new password, or if you set a permanent password, their status
+ * becomes Confirmed
.
* AdminSetUserPassword
can set a password for the user profile that Amazon Cognito
* creates for third-party federated users. When you set a password, the federated user's
diff --git a/clients/client-cognito-identity-provider/src/commands/AdminUpdateAuthEventFeedbackCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminUpdateAuthEventFeedbackCommand.ts
index 4dfdbbed5b25..acc237b49c0b 100644
--- a/clients/client-cognito-identity-provider/src/commands/AdminUpdateAuthEventFeedbackCommand.ts
+++ b/clients/client-cognito-identity-provider/src/commands/AdminUpdateAuthEventFeedbackCommand.ts
@@ -43,7 +43,11 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput
/**
*
Provides feedback for an authentication event indicating if it was from a valid user. * This feedback is used for improving the risk evaluation decision for the user pool as - * part of Amazon Cognito advanced security.
+ * part of Amazon Cognito threat protection. To train the threat-protection model to recognize + * trusted and untrusted sign-in characteristics, configure threat protection in audit-only + * mode and provide a mechanism for users or administrators to submit feedback. Your + * feedback can tell Amazon Cognito that a risk rating was assigned at a level you don't agree + * with. *Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminUpdateDeviceStatusCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminUpdateDeviceStatusCommand.ts index 221d7ee9da38..ec83005b60a0 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminUpdateDeviceStatusCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminUpdateDeviceStatusCommand.ts @@ -36,7 +36,12 @@ export interface AdminUpdateDeviceStatusCommandInput extends AdminUpdateDeviceSt export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceStatusResponse, __MetadataBearer {} /** - *
Updates the device status as an administrator.
+ *Updates the status of a user's device so that it is marked as remembered or not + * remembered for the purpose of device authentication. Device authentication is a + * "remember me" mechanism that silently completes sign-in from trusted devices with a + * device key instead of a user-provided MFA code. This operation changes the status of a + * device without deleting it, so you can enable it again later. For more information about + * device authentication, see Working with devices.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminUpdateUserAttributesCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminUpdateUserAttributesCommand.ts index 1e802778ca71..c710af659710 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminUpdateUserAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminUpdateUserAttributesCommand.ts @@ -53,13 +53,14 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito * Developer Guide.
*Updates the specified user's attributes, including developer attributes, as an - * administrator. Works on any user. To delete an attribute from your user, submit the - * attribute in your API request with a blank value.
+ *Updates the specified user's attributes. To delete an attribute from your user, + * submit the attribute in your API request with a blank value.
*For custom attributes, you must prepend the custom:
prefix to the
* attribute name.
In addition to updating user attributes, this API can also be used to mark phone and - * email as verified.
+ *This operation can set a user's email address or phone number as verified and
+ * permit immediate sign-in in user pools that require verification of these attributes. To
+ * do this, set the email_verified
or phone_number_verified
+ * attribute to true
.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AdminUserGlobalSignOutCommand.ts b/clients/client-cognito-identity-provider/src/commands/AdminUserGlobalSignOutCommand.ts index 2e9106ab8ebd..7a48dac0cd5f 100644 --- a/clients/client-cognito-identity-provider/src/commands/AdminUserGlobalSignOutCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AdminUserGlobalSignOutCommand.ts @@ -38,7 +38,7 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign /** *
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call * this operation with your administrative credentials when your user signs out of your - * app. This results in the following behavior.
+ * app. This results in the following behavior. *Amazon Cognito no longer accepts token-authorized user operations @@ -59,7 +59,10 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign * requests.
*Other requests might be valid until your user's token expires.
+ *Other requests might be valid until your user's token expires. This operation + * doesn't clear the managed login session cookie. To clear the session for + * a user who signed in with managed login or the classic hosted UI, direct their browser + * session to the logout endpoint.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/AssociateSoftwareTokenCommand.ts b/clients/client-cognito-identity-provider/src/commands/AssociateSoftwareTokenCommand.ts index 431addf27810..edbea79b3dec 100644 --- a/clients/client-cognito-identity-provider/src/commands/AssociateSoftwareTokenCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/AssociateSoftwareTokenCommand.ts @@ -60,6 +60,7 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo * grant IAM permissions in policies. For more information about authorization models in * Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
*Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Confirms tracking of the device. This API call is the call that begins device - * tracking. For more information about device authentication, see Working with user devices in your user pool.
+ *Confirms a device that a user wants to remember. A remembered device is a "Remember me + * on this device" option for user pools that perform authentication with the device key of + * a trusted device in the back end, instead of a user-provided MFA code. For more + * information about device authentication, see Working with user devices in your user pool.
*Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For diff --git a/clients/client-cognito-identity-provider/src/commands/ConfirmForgotPasswordCommand.ts b/clients/client-cognito-identity-provider/src/commands/ConfirmForgotPasswordCommand.ts index 2175300daeb4..dd52a3900512 100644 --- a/clients/client-cognito-identity-provider/src/commands/ConfirmForgotPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/ConfirmForgotPasswordCommand.ts @@ -36,7 +36,8 @@ export interface ConfirmForgotPasswordCommandInput extends ConfirmForgotPassword export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswordResponse, __MetadataBearer {} /** - *
Allows a user to enter a confirmation code to reset a forgotten password.
+ *This public API operation accepts a confirmation code that Amazon Cognito sent to a user and + * accepts a new password for that user.
*Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you can't use IAM credentials to authorize requests, and you can't diff --git a/clients/client-cognito-identity-provider/src/commands/ConfirmSignUpCommand.ts b/clients/client-cognito-identity-provider/src/commands/ConfirmSignUpCommand.ts index a06ff99befd5..2cdcaaf2445e 100644 --- a/clients/client-cognito-identity-provider/src/commands/ConfirmSignUpCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/ConfirmSignUpCommand.ts @@ -37,8 +37,8 @@ export interface ConfirmSignUpCommandInput extends ConfirmSignUpRequest {} export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __MetadataBearer {} /** - *
This public API operation provides a code that Amazon Cognito sent to your user when they - * signed up in your user pool via the SignUp + *
This public API operation submits a code that Amazon Cognito sent to your user when they signed + * up in your user pool via the SignUp * API operation. After your user enters their code, they confirm ownership of the email * address or phone number that they provided, and their user account becomes active. * Depending on your user pool configuration, your users will receive their confirmation diff --git a/clients/client-cognito-identity-provider/src/commands/CreateGroupCommand.ts b/clients/client-cognito-identity-provider/src/commands/CreateGroupCommand.ts index aa5348a8fb1d..63e0ab12a31f 100644 --- a/clients/client-cognito-identity-provider/src/commands/CreateGroupCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/CreateGroupCommand.ts @@ -32,7 +32,8 @@ export interface CreateGroupCommandInput extends CreateGroupRequest {} export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer {} /** - *
Creates a new group in the specified user pool.
+ *Creates a new group in the specified user pool. For more information about user pool + * groups see Adding groups to a user pool.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/CreateIdentityProviderCommand.ts b/clients/client-cognito-identity-provider/src/commands/CreateIdentityProviderCommand.ts index 914fa916d97f..9dc22d9e2c23 100644 --- a/clients/client-cognito-identity-provider/src/commands/CreateIdentityProviderCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/CreateIdentityProviderCommand.ts @@ -33,7 +33,8 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi /** *
Adds a configuration and trust relationship between a third-party identity provider - * (IdP) and a user pool.
+ * (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through + * managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in. *Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/CreateManagedLoginBrandingCommand.ts b/clients/client-cognito-identity-provider/src/commands/CreateManagedLoginBrandingCommand.ts index e80d6ad287b1..9da1e9f238bc 100644 --- a/clients/client-cognito-identity-provider/src/commands/CreateManagedLoginBrandingCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/CreateManagedLoginBrandingCommand.ts @@ -42,14 +42,17 @@ export interface CreateManagedLoginBrandingCommandOutput extends CreateManagedLo *
Provides values for UI customization in a Settings
JSON object and image
* files in an Assets
array. To send the JSON object Document
* type parameter in Settings
, you might need to update to the most recent
- * version of your Amazon Web Services SDK.
UseCognitoProvidedValues
to true
and don't provide
+ * values for any other options.
* This operation has a 2-megabyte request-size limit and include the CSS settings and * image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito * doesn't require that you pass all parameters in one request and preserves existing * style settings that you don't specify. If your request is larger than 2MB, separate it * into multiple requests, each with a size smaller than the limit.
- *For more information, see API and SDK operations for managed login branding - *
+ *As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this
+ * operation. To get all settings, set ReturnMergedResources
to
+ * true
. For more information, see API and SDK operations for managed login branding.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/CreateResourceServerCommand.ts b/clients/client-cognito-identity-provider/src/commands/CreateResourceServerCommand.ts index 9eb4edc49bdc..a1bf19f8028d 100644 --- a/clients/client-cognito-identity-provider/src/commands/CreateResourceServerCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/CreateResourceServerCommand.ts @@ -32,7 +32,9 @@ export interface CreateResourceServerCommandInput extends CreateResourceServerRe export interface CreateResourceServerCommandOutput extends CreateResourceServerResponse, __MetadataBearer {} /** - *
Creates a new OAuth2.0 resource server and defines custom scopes within it.
+ *Creates a new OAuth2.0 resource server and defines custom scopes within it. Resource + * servers are associated with custom scopes and machine-to-machine (M2M) authorization. + * For more information, see Access control with resource servers.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/CreateUserImportJobCommand.ts b/clients/client-cognito-identity-provider/src/commands/CreateUserImportJobCommand.ts index 2bb108e02400..bf5c3060a960 100644 --- a/clients/client-cognito-identity-provider/src/commands/CreateUserImportJobCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/CreateUserImportJobCommand.ts @@ -32,7 +32,10 @@ export interface CreateUserImportJobCommandInput extends CreateUserImportJobRequ export interface CreateUserImportJobCommandOutput extends CreateUserImportJobResponse, __MetadataBearer {} /** - *
Creates a user import job.
+ *Creates a user import job. You can import users into user pools from a comma-separated + * values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill. To generate a + * template for your import, see GetCSVHeader. To learn more about CSV import, see + * Importing users from a CSV file.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/CreateUserPoolClientCommand.ts b/clients/client-cognito-identity-provider/src/commands/CreateUserPoolClientCommand.ts index b8d92ff15c1e..fbf1f843c9c2 100644 --- a/clients/client-cognito-identity-provider/src/commands/CreateUserPoolClientCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/CreateUserPoolClientCommand.ts @@ -36,9 +36,12 @@ export interface CreateUserPoolClientCommandInput extends CreateUserPoolClientRe export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientResponse, __MetadataBearer {} /** - *
Creates the user pool client.
- *When you create a new user pool client, token revocation is automatically activated. - * For more information about revoking tokens, see RevokeToken.
+ *Creates an app client in a user pool. This operation sets basic and advanced + * configuration options. You can create an app client in the Amazon Cognito console to your + * preferences and use the output of DescribeUserPoolClient to generate requests from that + * baseline.
+ *New app clients activate token revocation by default. For more information about + * revoking tokens, see RevokeToken.
*If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
*Creates a new Amazon Cognito user pool and sets the password policy for the - * pool.
+ *Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration + * options. You can create a user pool in the Amazon Cognito console to your preferences and use the + * output of DescribeUserPool to generate requests from that + * baseline.
*If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
*Creates a new domain for a user pool. The domain hosts user pool domain services like - * managed login, the hosted UI (classic), and the user pool authorization server.
+ *A user pool domain hosts managed login, an authorization server and web server for
+ * authentication in your application. This operation creates a new user pool prefix or
+ * custom domain and sets the managed login branding version. Set the branding version to
+ * 1
for hosted UI (classic) or 2
for managed login. When you
+ * choose a custom domain, you must provide an SSL certificate in the US East (N. Virginia)
+ * Amazon Web Services Region in your request.
Your prefix domain might take up to one minute to take effect. Your custom domain is + * online within five minutes, but it can take up to one hour to distribute your SSL + * certificate.
+ *For more information about adding a custom domain to your user pool, see Configuring a user pool domain.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/DeleteGroupCommand.ts b/clients/client-cognito-identity-provider/src/commands/DeleteGroupCommand.ts index df3d2487c529..14015ebbc5bb 100644 --- a/clients/client-cognito-identity-provider/src/commands/DeleteGroupCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DeleteGroupCommand.ts @@ -32,8 +32,31 @@ export interface DeleteGroupCommandInput extends DeleteGroupRequest {} export interface DeleteGroupCommandOutput extends __MetadataBearer {} /** - *
Deletes a group.
- *Calling this action requires developer credentials.
+ *Deletes a group from the specified user pool. When you delete a group, that group no
+ * longer contributes to users' cognito:preferred_group
or
+ * cognito:groups
claims, and no longer influence access-control decision
+ * that are based on group membership. For more information about user pool groups, see
+ * Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For + * this operation, you must use IAM credentials to authorize requests, and you must + * grant yourself the corresponding IAM permission in a policy.
+ *+ * Learn more + *
+ *+ * Using the Amazon Cognito user pools API and user pool endpoints + *
+ *Deletes an IdP for a user pool.
+ *Deletes a user pool identity provider (IdP). After you delete an IdP, users can no + * longer sign in to your user pool through that IdP. For more information about user pool + * IdPs, see Third-party IdP sign-in.
+ *Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For + * this operation, you must use IAM credentials to authorize requests, and you must + * grant yourself the corresponding IAM permission in a policy.
+ *+ * Learn more + *
+ *+ * Using the Amazon Cognito user pools API and user pool endpoints + *
+ *Deletes a managed login branding style. When you delete a style, you delete the - * branding association for an app client and restore it to default settings.
+ * branding association for an app client. When an app client doesn't have a style + * assigned, your managed login pages for that app client are nonfunctional until you + * create a new style or switch the domain branding version. *Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/DeleteResourceServerCommand.ts b/clients/client-cognito-identity-provider/src/commands/DeleteResourceServerCommand.ts index 3fdaa64bcf5d..2605295735bf 100644 --- a/clients/client-cognito-identity-provider/src/commands/DeleteResourceServerCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DeleteResourceServerCommand.ts @@ -32,7 +32,30 @@ export interface DeleteResourceServerCommandInput extends DeleteResourceServerRe export interface DeleteResourceServerCommandOutput extends __MetadataBearer {} /** - *
Deletes a resource server.
+ *Deletes a resource server. After you delete a resource server, users can no longer + * generate access tokens with scopes that are associate with that resource server.
+ *Resource servers are associated with custom scopes and machine-to-machine (M2M) + * authorization. For more information, see Access control with resource servers.
+ *Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For + * this operation, you must use IAM credentials to authorize requests, and you must + * grant yourself the corresponding IAM permission in a policy.
+ *+ * Learn more + *
+ *+ * Using the Amazon Cognito user pools API and user pool endpoints + *
+ *Deletes the attributes for a user.
+ *Self-deletes attributes for a user. For example, your application can submit a request
+ * to this operation when a user wants to remove their birthdate
attribute
+ * value.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For diff --git a/clients/client-cognito-identity-provider/src/commands/DeleteUserCommand.ts b/clients/client-cognito-identity-provider/src/commands/DeleteUserCommand.ts index 7d383e302a6f..516aef57363a 100644 --- a/clients/client-cognito-identity-provider/src/commands/DeleteUserCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DeleteUserCommand.ts @@ -32,7 +32,8 @@ export interface DeleteUserCommandInput extends DeleteUserRequest {} export interface DeleteUserCommandOutput extends __MetadataBearer {} /** - *
Allows a user to delete their own user profile.
+ *Self-deletes a user profile. A deleted user profile can no longer be used to sign in + * and can't be restored.
*Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For diff --git a/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolClientCommand.ts b/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolClientCommand.ts index d327c70af345..6dbe0213790f 100644 --- a/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolClientCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolClientCommand.ts @@ -32,7 +32,8 @@ export interface DeleteUserPoolClientCommandInput extends DeleteUserPoolClientRe export interface DeleteUserPoolClientCommandOutput extends __MetadataBearer {} /** - *
Allows the developer to delete the user pool client.
+ *Deletes a user pool app client. After you delete an app client, users can no longer + * sign in to the associated application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolCommand.ts b/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolCommand.ts index 1e7ad46813dd..e5d15c336f5f 100644 --- a/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolCommand.ts @@ -32,7 +32,9 @@ export interface DeleteUserPoolCommandInput extends DeleteUserPoolRequest {} export interface DeleteUserPoolCommandOutput extends __MetadataBearer {} /** - *Deletes the specified Amazon Cognito user pool.
+ *Deletes a user pool. After you delete a user pool, users can no longer sign in to any + * associated applications.
+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolDomainCommand.ts index e177ab57d604..189e03512ade 100644 --- a/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DeleteUserPoolDomainCommand.ts @@ -32,7 +32,9 @@ export interface DeleteUserPoolDomainCommandInput extends DeleteUserPoolDomainRe export interface DeleteUserPoolDomainCommandOutput extends DeleteUserPoolDomainResponse, __MetadataBearer {} /** - *Deletes a domain for a user pool.
+ *Given a user pool ID and domain identifier, deletes a user pool domain. After you + * delete a user pool domain, your managed login pages and authorization server are no + * longer available.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DeleteWebAuthnCredentialCommand.ts b/clients/client-cognito-identity-provider/src/commands/DeleteWebAuthnCredentialCommand.ts index ccca388c1521..1f98dcc00050 100644 --- a/clients/client-cognito-identity-provider/src/commands/DeleteWebAuthnCredentialCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DeleteWebAuthnCredentialCommand.ts @@ -36,9 +36,15 @@ export interface DeleteWebAuthnCredentialCommandInput extends DeleteWebAuthnCred export interface DeleteWebAuthnCredentialCommandOutput extends DeleteWebAuthnCredentialResponse, __MetadataBearer {} /** - *Deletes a registered passkey, or webauthN, device for the currently signed-in + *
Deletes a registered passkey, or webauthN, authenticator for the currently signed-in * user.
*Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For + * this operation, you can't use IAM credentials to authorize requests, and you can't + * grant IAM permissions in policies. For more information about authorization models in + * Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
+ *Gets information about a specific IdP.
+ *Given a user pool ID and identity provider (IdP) name, returns details about the + * IdP.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingByClientCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingByClientCommand.ts index 9012db91f0e8..2d959dc58ba3 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingByClientCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingByClientCommand.ts @@ -41,8 +41,8 @@ export interface DescribeManagedLoginBrandingByClientCommandOutput __MetadataBearer {} /** - *When given the ID of a user pool app client, returns detailed information about the - * style assigned to the app client.
+ *Given the ID of a user pool app client, returns detailed information about the style + * assigned to the app client.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingCommand.ts index 3a671042aba5..b2850cd83ace 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeManagedLoginBrandingCommand.ts @@ -37,8 +37,8 @@ export interface DescribeManagedLoginBrandingCommandOutput __MetadataBearer {} /** - *When given the ID of a managed login branding style, returns detailed information - * about the style.
+ *Given the ID of a managed login branding style, returns detailed information about the + * style.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeResourceServerCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeResourceServerCommand.ts index 2c65c721ebed..1d9410140b99 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeResourceServerCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeResourceServerCommand.ts @@ -32,7 +32,7 @@ export interface DescribeResourceServerCommandInput extends DescribeResourceServ export interface DescribeResourceServerCommandOutput extends DescribeResourceServerResponse, __MetadataBearer {} /** - *Describes a resource server.
+ *Describes a resource server. For more information about resource servers, see Access control with resource servers.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeRiskConfigurationCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeRiskConfigurationCommand.ts index 5c37396ae64c..381180668dbe 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeRiskConfigurationCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeRiskConfigurationCommand.ts @@ -37,7 +37,10 @@ export interface DescribeRiskConfigurationCommandInput extends DescribeRiskConfi export interface DescribeRiskConfigurationCommandOutput extends DescribeRiskConfigurationResponse, __MetadataBearer {} /** - *Describes the risk configuration.
+ *Given an app client or user pool ID where threat protection is configured, describes + * the risk configuration. This operation returns details about adaptive authentication, + * compromised credentials, and IP-address allow- and denylists. For more information about + * threat protection, see Threat protection.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeUserImportJobCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeUserImportJobCommand.ts index 56c1ff73e386..65d52aede98e 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeUserImportJobCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeUserImportJobCommand.ts @@ -32,7 +32,7 @@ export interface DescribeUserImportJobCommandInput extends DescribeUserImportJob export interface DescribeUserImportJobCommandOutput extends DescribeUserImportJobResponse, __MetadataBearer {} /** - *Describes the user import job.
+ *Describes a user import job. For more information about user CSV import, see Importing users from a CSV file.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolClientCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolClientCommand.ts index fa8966c152c8..3ba443ab20ac 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolClientCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolClientCommand.ts @@ -37,8 +37,9 @@ export interface DescribeUserPoolClientCommandInput extends DescribeUserPoolClie export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolClientResponse, __MetadataBearer {} /** - *Client method for returning the configuration information and metadata of the - * specified user pool app client.
+ *Given an app client ID, returns configuration information. This operation is useful + * when you want to inspect an existing app client and programmatically replicate the + * configuration to another app client. For more information about app clients, see App clients.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolCommand.ts index b3b5b7378a13..5f0ab5f61ce9 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolCommand.ts @@ -32,7 +32,9 @@ export interface DescribeUserPoolCommandInput extends DescribeUserPoolRequest {} export interface DescribeUserPoolCommandOutput extends DescribeUserPoolResponse, __MetadataBearer {} /** - *
Returns the configuration information and metadata of the specified user pool.
+ *Given a user pool ID, returns configuration information. This operation is useful when + * you want to inspect an existing user pool and programmatically replicate the + * configuration to another user pool.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolDomainCommand.ts index 2d4fa1a3ae17..3ad94220555d 100644 --- a/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/DescribeUserPoolDomainCommand.ts @@ -32,7 +32,28 @@ export interface DescribeUserPoolDomainCommandInput extends DescribeUserPoolDoma export interface DescribeUserPoolDomainCommandOutput extends DescribeUserPoolDomainResponse, __MetadataBearer {} /** - *
Gets information about a domain.
+ *Given a user pool domain name, returns information about the domain + * configuration.
+ *Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For + * this operation, you must use IAM credentials to authorize requests, and you must + * grant yourself the corresponding IAM permission in a policy.
+ *+ * Learn more + *
+ *+ * Using the Amazon Cognito user pools API and user pool endpoints + *
+ *Other requests might be valid until your user's token expires.
+ *Other requests might be valid until your user's token expires. This operation + * doesn't clear the managed login session cookie. To clear the session for + * a user who signed in with managed login or the classic hosted UI, direct their browser + * session to the logout endpoint.
*Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For diff --git a/clients/client-cognito-identity-provider/src/commands/SetUserMFAPreferenceCommand.ts b/clients/client-cognito-identity-provider/src/commands/SetUserMFAPreferenceCommand.ts index 9a931d70d49c..1311ed8eed55 100644 --- a/clients/client-cognito-identity-provider/src/commands/SetUserMFAPreferenceCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/SetUserMFAPreferenceCommand.ts @@ -45,6 +45,9 @@ export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceR * unless device tracking is turned on and the device has been trusted. If you want MFA to * be applied selectively based on the assessed risk level of sign-in attempts, deactivate * MFA for users and turn on Adaptive Authentication for the user pool.
+ *This operation doesn't reset an existing TOTP MFA for a user. To register a new + * TOTP factor for a user, make an AssociateSoftwareToken request. For more information, + * see TOTP software token MFA.
*Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For diff --git a/clients/client-cognito-identity-provider/src/commands/UpdateManagedLoginBrandingCommand.ts b/clients/client-cognito-identity-provider/src/commands/UpdateManagedLoginBrandingCommand.ts index 3889bdaab388..37e04aff1912 100644 --- a/clients/client-cognito-identity-provider/src/commands/UpdateManagedLoginBrandingCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/UpdateManagedLoginBrandingCommand.ts @@ -41,7 +41,10 @@ export interface UpdateManagedLoginBrandingCommandOutput extends UpdateManagedLo * doesn't require that you pass all parameters in one request and preserves existing * style settings that you don't specify. If your request is larger than 2MB, separate it * into multiple requests, each with a size smaller than the limit.
- *For more information, see API and SDK operations for managed login branding.
+ *As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this
+ * operation. To get all settings, set ReturnMergedResources
to
+ * true
. For more information, see API and SDK operations for managed login branding
+ *
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/commands/UpdateUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/src/commands/UpdateUserPoolDomainCommand.ts index f0e0452be9bb..d219fcc99945 100644 --- a/clients/client-cognito-identity-provider/src/commands/UpdateUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/src/commands/UpdateUserPoolDomainCommand.ts @@ -32,25 +32,23 @@ export interface UpdateUserPoolDomainCommandInput extends UpdateUserPoolDomainRe export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainResponse, __MetadataBearer {} /** - *
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user - * pool.
- *You can use this operation to provide the Amazon Resource Name (ARN) of a new - * certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
- *A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and - * sign-in pages for your application. When you set up a custom domain, you provide a - * certificate that you manage with Certificate Manager (ACM). When necessary, you can use this - * operation to change the certificate that you applied to your custom domain.
- *Usually, this is unnecessary following routine certificate renewal with ACM. When - * you renew your existing certificate in ACM, the ARN for your certificate remains the - * same, and your custom domain uses the new certificate automatically.
- *However, if you replace your existing certificate with a new one, ACM gives the new - * certificate a new ARN. To apply the new certificate to your custom domain, you must - * provide this ARN to Amazon Cognito.
- *When you add your new certificate in ACM, you must choose US East (N. Virginia) as - * the Amazon Web Services Region.
- *After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new - * certificate to your custom domain.
- *For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
+ *A user pool domain hosts managed login, an authorization server and web server for
+ * authentication in your application. This operation updates the branding version for user
+ * pool domains between 1
for hosted UI (classic) and 2
for
+ * managed login. It also updates the SSL certificate for user pool custom domains.
Changes to the domain branding version take up to one minute to take effect for a + * prefix domain and up to five minutes for a custom domain.
+ *This operation doesn't change the name of your user pool domain. To change your
+ * domain, delete it with DeleteUserPoolDomain
and create a new domain with
+ * CreateUserPoolDomain
.
You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM + * certificates automatically renew and you user pool can continue to use the same ARN. But + * if you generate a new certificate for your custom domain name, replace the original + * configuration with the new ARN in this request.
+ *ACM certificates for custom domains must be in the US East (N. Virginia) + * Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute + * your new certificate to your custom domain.
+ *For more information about adding a custom domain to your user pool, see Configuring a user pool domain.
*Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must diff --git a/clients/client-cognito-identity-provider/src/index.ts b/clients/client-cognito-identity-provider/src/index.ts index 7bd8be1c0837..c70da33af304 100644 --- a/clients/client-cognito-identity-provider/src/index.ts +++ b/clients/client-cognito-identity-provider/src/index.ts @@ -81,6 +81,11 @@ * for Ruby V3 *
* + *To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services * SDKs.
diff --git a/clients/client-cognito-identity-provider/src/models/models_0.ts b/clients/client-cognito-identity-provider/src/models/models_0.ts index 78f9f1d7864f..ec07d85f5bd2 100644 --- a/clients/client-cognito-identity-provider/src/models/models_0.ts +++ b/clients/client-cognito-identity-provider/src/models/models_0.ts @@ -420,13 +420,53 @@ export interface SchemaAttributeType { */ export interface AddCustomAttributesRequest { /** - *The user pool ID for the user pool where you want to add custom attributes.
+ *The ID of the user pool where you want to add custom attributes.
* @public */ UserPoolId: string | undefined; /** - *An array of custom attributes, such as Mutable and Name.
+ *An array of custom attribute names and other properties. Sets the following + * characteristics:
+ *The expected data type. Can be a string, a number, a date and time, or a + * boolean.
+ *If true, you can grant app clients write access to the attribute value. If + * false, the attribute value can only be set up on sign-up or administrator + * creation of users.
+ *The attribute name. For an attribute like custom:myAttribute
,
+ * enter myAttribute
for this field.
When true, users who sign up or are created must set a value for the + * attribute.
+ *The minimum and maximum length of accepted values for a
+ * Number
-type attribute.
The minimum and maximum length of accepted values for a
+ * String
-type attribute.
This legacy option creates an attribute with a dev:
prefix.
+ * You can only set the value of a developer-only attribute with administrative
+ * IAM credentials.
The user pool ID for the user pool.
+ *The ID of the user pool that contains the group that you want to add the user + * to.
* @public */ UserPoolId: string | undefined; @@ -623,7 +664,8 @@ export class UserNotFoundException extends __BaseException { */ export interface AdminConfirmSignUpRequest { /** - *The user pool ID for which you want to confirm user registration.
+ *The ID of the user pool where you want to confirm a user's sign-up + * request.
* @public */ UserPoolId: string | undefined; @@ -652,21 +694,21 @@ export interface AdminConfirmSignUpRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The user pool ID for the user pool where the user will be created.
+ *The ID of the user pool where you want to create a user.
* @public */ UserPoolId: string | undefined; @@ -948,9 +990,10 @@ export interface AdminCreateUserRequest { *email_verified
attribute is set to True
. Otherwise, it is
* ignored.
* If this parameter is set to True
and the phone number or email address
- * specified in the UserAttributes parameter already exists as an alias with a different
- * user, the API call will migrate the alias from the previous user to the newly created
- * user. The previous user will no longer be able to log in using that alias.
UserAttributes
parameter already exists as an alias with a
+ * different user, this request migrates the alias from the previous user to the
+ * newly-created user. The previous user will no longer be able to log in using that
+ * alias.
* If this parameter is set to False
, the API throws an
* AliasExistsException
error if the alias already exists. The default
* value is False
.
Set to RESEND
to resend the invitation message to a user that already
- * exists and reset the expiration limit on the user's account. Set to
- * SUPPRESS
to suppress sending the message. You can specify only one
+ * exists, and to reset the temporary-password duration with a new temporary password. Set
+ * to SUPPRESS
to suppress sending the message. You can specify only one
* value.
Specify "EMAIL"
if email will be used to send the welcome message.
- * Specify "SMS"
if the phone number will be used. The default value is
- * "SMS"
. You can specify more than one value.
Specify EMAIL
if email will be used to send the welcome message. Specify
+ * SMS
if the phone number will be used. The default value is
+ * SMS
. You can specify more than one value.
clientMetadata
attribute, which provides the data that you assigned to
+ * ClientMetadata
attribute, which provides the data that you assigned to
* the ClientMetadata parameter in your AdminCreateUser request. In your function code in
* Lambda, you can process the clientMetadata
value to enhance your
* workflow for your specific needs.
* For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The newly created user.
+ *The new user's profile details.
* @public */ User?: UserType | undefined; @@ -1357,7 +1400,7 @@ export interface AdminCreateUserConfigType { */ export interface AdminDeleteUserRequest { /** - *The user pool ID for the user pool where you want to delete the user.
+ *The ID of the user pool where you want to delete the user.
* @public */ UserPoolId: string | undefined; @@ -1379,7 +1422,7 @@ export interface AdminDeleteUserRequest { */ export interface AdminDeleteUserAttributesRequest { /** - *The user pool ID for the user pool where you want to delete user attributes.
+ *The ID of the user pool where you want to delete user attributes.
* @public */ UserPoolId: string | undefined; @@ -1442,13 +1485,14 @@ export interface ProviderUserIdentifierType { */ export interface AdminDisableProviderForUserRequest { /** - *The user pool ID for the user pool.
+ *The ID of the user pool where you want to delete the user's linked + * identities.
* @public */ UserPoolId: string | undefined; /** - *The user to be disabled.
+ *The user profile that you want to delete a linked identity from.
* @public */ User: ProviderUserIdentifierType | undefined; @@ -1489,7 +1533,7 @@ export class AliasExistsException extends __BaseException { */ export interface AdminDisableUserRequest { /** - *The user pool ID for the user pool where you want to disable the user.
+ *The ID of the user pool where you want to disable the user.
* @public */ UserPoolId: string | undefined; @@ -1518,7 +1562,7 @@ export interface AdminDisableUserResponse {} */ export interface AdminEnableUserRequest { /** - *The user pool ID for the user pool where you want to enable the user.
+ *The ID of the user pool where you want to activate sign-in for the user.
* @public */ UserPoolId: string | undefined; @@ -1547,7 +1591,7 @@ export interface AdminEnableUserResponse {} */ export interface AdminForgetDeviceRequest { /** - *The user pool ID.
+ *The ID of the user pool where the device owner is a user.
* @public */ UserPoolId: string | undefined; @@ -1563,7 +1607,8 @@ export interface AdminForgetDeviceRequest { Username: string | undefined; /** - *The device key.
+ *The key ID of the device that you want to delete. You can get device keys in the + * response to an AdminListDevices request.
* @public */ DeviceKey: string | undefined; @@ -1595,13 +1640,14 @@ export class InvalidUserPoolConfigurationException extends __BaseException { */ export interface AdminGetDeviceRequest { /** - *The device key.
+ *The key of the device that you want to delete. You can get device IDs in the response + * to an AdminListDevices request.
* @public */ DeviceKey: string | undefined; /** - *The user pool ID.
+ *The ID of the user pool where the device owner is a user.
* @public */ UserPoolId: string | undefined; @@ -1664,7 +1710,8 @@ export interface DeviceType { */ export interface AdminGetDeviceResponse { /** - *The device.
+ *Details of the requested device. Includes device information, last-accessed and + * created dates, and the device key.
* @public */ Device: DeviceType | undefined; @@ -1676,8 +1723,7 @@ export interface AdminGetDeviceResponse { */ export interface AdminGetUserRequest { /** - *The user pool ID for the user pool where you want to get information about the - * user.
+ *The ID of the user pool where you want to get information about the user.
* @public */ UserPoolId: string | undefined; @@ -1706,13 +1752,15 @@ export interface AdminGetUserResponse { Username: string | undefined; /** - *An array of name-value pairs representing user attributes.
+ *An array of name-value pairs of user attributes and their values, for example
+ * "email": "testuser@example.com"
.
The date the user was created.
+ *The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
+ * human-readable format like ISO 8601 or a Java Date
object.
Indicates that the status is enabled
.
Indicates whether the user is activated for sign-in. The AdminDisableUser and AdminEnableUser API operations deactivate and activate + * user sign-in, respectively.
* @public */ Enabled?: boolean | undefined; /** - *The user status. Can be one of the following:
+ *The user's status. Can be one of the following:
*UNCONFIRMED - User has been created but not confirmed.
@@ -1751,6 +1800,10 @@ export interface AdminGetUserResponse { * temporary password, but on first sign-in, the user must change their password to * a new value before doing anything else. *EXTERNAL_PROVIDER - The user signed in with a third-party identity + * provider.
+ *The user's preferred MFA setting.
+ *The user's preferred MFA. Users can prefer SMS message, email message, or TOTP + * MFA.
* @public */ PreferredMfaSetting?: string | undefined; /** *The MFA options that are activated for the user. The possible values in this list are
- * SMS_MFA
, EMAIL_OTP
, and
- * SOFTWARE_TOKEN_MFA
.
SMS_MFA
, EMAIL_OTP
, and SOFTWARE_TOKEN_MFA
.
+ * You can change the MFA preference for users who have more than one available MFA factor
+ * with AdminSetUserMFAPreference or SetUserMFAPreference.
* @public
*/
UserMFASettingList?: string[] | undefined;
@@ -1886,20 +1941,21 @@ export interface ContextDataType {
*/
export interface AdminInitiateAuthRequest {
/**
- * The ID of the Amazon Cognito user pool.
+ *The ID of the user pool where the user wants to sign in.
* @public */ UserPoolId: string | undefined; /** - *The app client ID.
+ *The ID of the app client where the user wants to sign in.
* @public */ ClientId: string | undefined; /** - *The authentication flow that you want to initiate. The AuthParameters
- * that you must submit are linked to the flow that you submit. For example:
The authentication flow that you want to initiate. Each AuthFlow
has
+ * linked AuthParameters
that you must submit. The following are some example
+ * flows and their parameters.
@@ -1927,12 +1983,14 @@ export interface AdminInitiateAuthRequest {
* USERNAME
and PASSWORD
parameters.
Valid values include the following:
+ *+ * All flows + *
*The entry point for sign-in with passwords, one-time passwords, biometric - * devices, and security keys.
+ *The entry point for sign-in with passwords, one-time passwords, and + * WebAuthN authenticators.
*For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The analytics metadata for collecting Amazon Pinpoint metrics for
- * AdminInitiateAuth
calls.
The analytics metadata for collecting Amazon Pinpoint metrics.
* @public */ AnalyticsMetadata?: AnalyticsMetadataType | undefined; @@ -2090,14 +2147,18 @@ export interface AdminInitiateAuthRequest { *Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ ContextData?: ContextDataType | undefined; /** *The optional session ID from a ConfirmSignUp
API request. You can sign in
- * a user directly from the sign-up process with the USER_AUTH
authentication
- * flow.
AuthFlow
of
+ * USER_AUTH
and AuthParameters
of EMAIL_OTP
or
+ * SMS_OTP
, depending on how your user pool sent the confirmation-code
+ * message.
* @public
*/
Session?: string | undefined;
@@ -2332,11 +2393,11 @@ export interface AdminInitiateAuthResponse {
ChallengeName?: ChallengeNameType | undefined;
/**
- * The session that should be passed both ways in challenge-response calls to the
- * service. If AdminInitiateAuth
or AdminRespondToAuthChallenge
- * API call determines that the caller must pass another challenge, they return a session
- * with other challenge parameters. This session should be passed as it is to the next
- * AdminRespondToAuthChallenge
API call.
The session that must be passed to challenge-response requests. If an
+ * AdminInitiateAuth
or AdminRespondToAuthChallenge
API
+ * request determines that the caller must pass another challenge, Amazon Cognito returns a session
+ * ID and the parameters of the next challenge. Pass this session Id in the
+ * Session
parameter of AdminRespondToAuthChallenge
.
The result of the authentication response. This is only returned if the caller doesn't
- * need to pass another challenge. If the caller does need to pass another challenge before
- * it gets tokens, ChallengeName
, ChallengeParameters
, and
- * Session
are returned.
The outcome of successful authentication. This is only returned if the user pool has
+ * no additional challenges to return. If Amazon Cognito returns another challenge, the response
+ * includes ChallengeName
, ChallengeParameters
, and
+ * Session
so that your user can answer the challenge.
The user pool ID for the user pool.
+ *The ID of the user pool where you want to link a federated identity.
* @public */ UserPoolId: string | undefined; @@ -2530,7 +2591,7 @@ export interface AdminLinkProviderForUserResponse {} */ export interface AdminListDevicesRequest { /** - *The user pool ID.
+ *The ID of the user pool where the device owner is a user.
* @public */ UserPoolId: string | undefined; @@ -2546,7 +2607,7 @@ export interface AdminListDevicesRequest { Username: string | undefined; /** - *The limit of the devices request.
+ *The maximum number of devices that you want Amazon Cognito to return in the response.
* @public */ Limit?: number | undefined; @@ -2568,7 +2629,8 @@ export interface AdminListDevicesRequest { */ export interface AdminListDevicesResponse { /** - *The devices in the list of devices response.
+ *An array of devices and their information. Each entry that's returned includes + * device information, last-accessed and created dates, and the device key.
* @public */ Devices?: DeviceType[] | undefined; @@ -2597,20 +2659,23 @@ export interface AdminListGroupsForUserRequest { Username: string | undefined; /** - *The user pool ID for the user pool.
+ *The ID of the user pool where you want to view a user's groups.
* @public */ UserPoolId: string | undefined; /** - *The limit of the request to list groups.
+ *The maximum number of groups that you want Amazon Cognito to return in the response.
* @public */ Limit?: number | undefined; /** - *An identifier that was returned from the previous call to this operation, which can be - * used to return the next set of items in the list.
+ *This API operation returns a limited number of results. The pagination token is + * an identifier that you can present in an additional API request with the same parameters. When + * you include the pagination token, Amazon Cognito returns the next set of items after the current list. + * Subsequent requests return a new pagination token. By use of this token, you can paginate + * through the full list of items.
* @public */ NextToken?: string | undefined; @@ -2690,14 +2755,15 @@ export interface GroupType { */ export interface AdminListGroupsForUserResponse { /** - *The groups that the user belongs to.
+ *An array of groups and information about them.
* @public */ Groups?: GroupType[] | undefined; /** - *An identifier that was returned from the previous call to this operation, which can be - * used to return the next set of items in the list.
+ *The identifier that Amazon Cognito returned with the previous request to this operation. When + * you include a pagination token in your request, Amazon Cognito returns the next set of items in + * the list. By use of this token, you can paginate through the full list of items.
* @public */ NextToken?: string | undefined; @@ -2708,7 +2774,7 @@ export interface AdminListGroupsForUserResponse { */ export interface AdminListUserAuthEventsRequest { /** - *The user pool ID.
+ *The Id of the user pool that contains the user profile with the logged events.
* @public */ UserPoolId: string | undefined; @@ -2732,7 +2798,11 @@ export interface AdminListUserAuthEventsRequest { MaxResults?: number | undefined; /** - *A pagination token.
+ *This API operation returns a limited number of results. The pagination token is + * an identifier that you can present in an additional API request with the same parameters. When + * you include the pagination token, Amazon Cognito returns the next set of items after the current list. + * Subsequent requests return a new pagination token. By use of this token, you can paginate + * through the full list of items.
* @public */ NextToken?: string | undefined; @@ -3213,7 +3283,9 @@ export interface AdminListUserAuthEventsResponse { AuthEvents?: AuthEventType[] | undefined; /** - *A pagination token.
+ *The identifier that Amazon Cognito returned with the previous request to this operation. When + * you include a pagination token in your request, Amazon Cognito returns the next set of items in + * the list. By use of this token, you can paginate through the full list of items.
* @public */ NextToken?: string | undefined; @@ -3244,7 +3316,8 @@ export class UserPoolAddOnNotEnabledException extends __BaseException { */ export interface AdminRemoveUserFromGroupRequest { /** - *The user pool ID for the user pool.
+ *The ID of the user pool that contains the group and the user that you want to + * remove.
* @public */ UserPoolId: string | undefined; @@ -3260,7 +3333,8 @@ export interface AdminRemoveUserFromGroupRequest { Username: string | undefined; /** - *The group name.
+ *The name of the group that you want to remove the user from, for example
+ * MyTestGroup
.
The user pool ID for the user pool where you want to reset the user's password.
+ *The ID of the user pool where you want to reset the user's password.
* @public */ UserPoolId: string | undefined; @@ -3291,7 +3365,7 @@ export interface AdminResetUserPasswordRequest { *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool
- * triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function
+ * triggers. The AdminResetUserPassword
API operation invokes the function
* that is assigned to the custom message trigger. When Amazon Cognito invokes
* this function, it passes a JSON payload, which the function receives as input. This
* payload contains a clientMetadata
attribute, which provides the data that
@@ -3301,21 +3375,21 @@ export interface AdminResetUserPasswordRequest {
*
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The ID of the Amazon Cognito user pool.
+ *The ID of the user pool where you want to respond to an authentication + * challenge.
* @public */ UserPoolId: string | undefined; /** - *The app client ID.
+ *The ID of the app client where you initiated sign-in.
* @public */ ClientId: string | undefined; /** - *The challenge name. For more information, see AdminInitiateAuth.
+ *The name of the challenge that you are responding to. You can find more information
+ * about values for ChallengeName
in the response parameters of AdminInitiateAuth.
The session that should be passed both ways in challenge-response calls to the
- * service. If an InitiateAuth
or RespondToAuthChallenge
API call
- * determines that the caller must pass another challenge, it returns a session with other
- * challenge parameters. This session should be passed as it is to the next
- * RespondToAuthChallenge
API call.
The session identifier that maintains the state of authentication requests and
+ * challenge responses. If an AdminInitiateAuth
or
+ * AdminRespondToAuthChallenge
API request results in a determination that
+ * your application must pass another challenge, Amazon Cognito returns a session with other
+ * challenge parameters. Send this session identifier, unmodified, to the next
+ * AdminRespondToAuthChallenge
request.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ ContextData?: ContextDataType | undefined; @@ -3566,28 +3645,28 @@ export interface AdminRespondToAuthChallengeRequest { * that you have assigned to the following triggers: *pre sign-up
+ *Pre sign-up
*custom message
*post authentication
+ *Post authentication
*user migration
+ *User migration
*pre token generation
+ *Pre token generation
*define auth challenge
+ *Define auth challenge
*create auth challenge
+ *Create auth challenge
*verify auth challenge response
+ *Verify auth challenge response
*When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the @@ -3599,21 +3678,21 @@ export interface AdminRespondToAuthChallengeRequest { *
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The name of the challenge. For more information, see AdminInitiateAuth.
+ *The name of the challenge that you must next respond to. You can find more information
+ * about values for ChallengeName
in the response parameters of AdminInitiateAuth.
The session that should be passed both ways in challenge-response calls to the
- * service. If the caller must pass another challenge, they return a session with other
- * challenge parameters. This session should be passed as it is to the next
- * RespondToAuthChallenge
API call.
The session identifier that maintains the state of authentication requests and
+ * challenge responses. If an AdminInitiateAuth
or
+ * AdminRespondToAuthChallenge
API request results in a determination that
+ * your application must pass another challenge, Amazon Cognito returns a session with other
+ * challenge parameters. Send this session identifier, unmodified, to the next
+ * AdminRespondToAuthChallenge
request.
The challenge parameters. For more information, see AdminInitiateAuth.
+ *The parameters that define your response to the next challenge. Take the values in
+ * ChallengeParameters
and provide values for them in the ChallengeResponses of the next AdminRespondToAuthChallenge
+ * request.
The result returned by the server in response to the authentication request.
+ *The outcome of a successful authentication process. After your application has passed
+ * all challenges, Amazon Cognito returns an AuthenticationResult
with the JSON web
+ * tokens (JWTs) that indicate successful sign-in.
The user pool ID for the user pool where you want to set the user's password.
+ *The ID of the user pool where you want to set the user's password.
* @public */ UserPoolId: string | undefined; @@ -3882,15 +3968,18 @@ export interface AdminSetUserPasswordRequest { Username: string | undefined; /** - *The password for the user.
+ *The new temporary or permanent password that you want to set for the user. You + * can't remove the password for a user who already has a password so that they can + * only sign in with passwordless methods. In this scenario, you must create a new user + * without a password.
* @public */ Password: string | undefined; /** - *
- * True
if the password is permanent, False
if it is
- * temporary.
Set to true
to set a password that the user can immediately sign in with.
+ * Set to false
to set a temporary password that the user must change on their
+ * next sign-in.
The user pool ID.
+ *The ID of the user pool where you want to submit authentication-event feedback.
* @public */ UserPoolId: string | undefined; @@ -3959,7 +4048,7 @@ export interface AdminUpdateAuthEventFeedbackRequest { Username: string | undefined; /** - *The authentication event ID.
+ *The authentication event ID. To query authentication events for a user, see AdminListUserAuthEvents.
* @public */ EventId: string | undefined; @@ -4000,7 +4089,7 @@ export type DeviceRememberedStatusType = (typeof DeviceRememberedStatusType)[key */ export interface AdminUpdateDeviceStatusRequest { /** - *The user pool ID.
+ *The ID of the user pool where you want to change a user's device status.
* @public */ UserPoolId: string | undefined; @@ -4016,13 +4105,15 @@ export interface AdminUpdateDeviceStatusRequest { Username: string | undefined; /** - *The device key.
+ *The unique identifier, or device key, of the device that you want to update the status + * for.
* @public */ DeviceKey: string | undefined; /** - *The status indicating whether a device has been remembered or not.
+ *To enable device authentication with the specified device, set to
+ * remembered
.To disable, set to not_remembered
.
The user pool ID for the user pool where you want to update user attributes.
+ *The ID of the user pool where you want to update user attributes.
* @public */ UserPoolId: string | undefined; @@ -4089,21 +4180,21 @@ export interface AdminUpdateUserAttributesRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The user pool ID.
+ *The ID of the user pool where you want to sign out a user.
* @public */ UserPoolId: string | undefined; @@ -4380,14 +4471,16 @@ export interface AssetType { export interface AssociateSoftwareTokenRequest { /** *A valid access token that Amazon Cognito issued to the user whose software token you want to - * generate.
+ * generate. You can provide either an access token or a session ID in the request. * @public */ AccessToken?: string | undefined; /** - *The session that should be passed both ways in challenge-response calls to the - * service. This allows authentication of the user as part of the MFA setup process.
+ *The session identifier that maintains the state of authentication requests and
+ * challenge responses. In AssociateSoftwareToken
, this is the session ID from
+ * a successful sign-in. You can provide either an access token or a session ID in the
+ * request.
A unique generated shared secret code that is used in the TOTP algorithm to generate a + *
A unique generated shared secret code that is used by the TOTP algorithm to generate a * one-time code.
* @public */ SecretCode?: string | undefined; /** - *The session that should be passed both ways in challenge-response calls to the - * service. This allows authentication of the user as part of the MFA setup process.
+ *The session identifier that maintains the state of authentication requests and + * challenge responses. This session ID is valid for the next request in this flow, VerifySoftwareToken.
* @public */ Session?: string | undefined; @@ -4482,7 +4575,7 @@ export interface ChangePasswordRequest { PreviousPassword?: string | undefined; /** - *The new password.
+ *A new password that you prompted the user to enter in your application.
* @public */ ProposedPassword: string | undefined; @@ -4507,7 +4600,7 @@ export interface ChangePasswordResponse {} export interface CompleteWebAuthnRegistrationRequest { /** *A valid access token that Amazon Cognito issued to the user whose passkey registration you want - * to verify.
+ * to complete. * @public */ AccessToken: string | undefined; @@ -4672,7 +4765,7 @@ export interface DeviceSecretVerifierConfigType { } /** - *Confirms the device request.
+ *The confirm-device request.
* @public */ export interface ConfirmDeviceRequest { @@ -4684,7 +4777,8 @@ export interface ConfirmDeviceRequest { AccessToken: string | undefined; /** - *The device key.
+ *The unique identifier, or device key, of the device that you want to update the status + * for.
* @public */ DeviceKey: string | undefined; @@ -4696,19 +4790,28 @@ export interface ConfirmDeviceRequest { DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType | undefined; /** - *The device name.
+ *A friendly name for the device, for example MyMobilePhone
.
Confirms the device response.
+ *The confirm-device response.
* @public */ export interface ConfirmDeviceResponse { /** - *Indicates whether the user confirmation must confirm the device response.
+ *When true
, your user must confirm that they want to remember the device.
+ * Prompt the user for an answer. You must then make an UpdateUserDevice request that sets the device to
+ * remembered
or not_remembered
.
When false
, immediately sets the device as remembered and eligible for
+ * device authentication.
You can configure your user pool to always remember devices, in which case this
+ * response is false
, or to allow users to opt in, in which case this response
+ * is true
. Configure this option under Device tracking
+ * in the Sign-in menu of your user pool. You can also configure this
+ * option with the DeviceConfiguration parameter of a CreateUserPool or UpdateUserPool request.
The app client ID of the app associated with the user pool.
+ *The ID of the app client where the user wants to reset their password. This parameter + * is an identifier of the client application that users are resetting their password from, + * but this operation resets users' passwords for all app clients in the user + * pool.
* @public */ ClientId: string | undefined; @@ -4766,8 +4872,7 @@ export interface ConfirmForgotPasswordRequest { Username: string | undefined; /** - *The confirmation code from your user's request to reset their password. For more - * information, see ForgotPassword.
+ *The confirmation code that your user pool sent in response to an AdminResetUserPassword or a ForgotPassword request.
* @public */ ConfirmationCode: string | undefined; @@ -4789,6 +4894,8 @@ export interface ConfirmForgotPasswordRequest { *Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ UserContextData?: UserContextDataType | undefined; @@ -4807,21 +4914,21 @@ export interface ConfirmForgotPasswordRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
A keyed-hash message authentication code (HMAC) calculated using the secret key of a - * user pool client and username plus the client ID in the message.
+ * user pool client and username plus the client ID in the message. For more information + * aboutSecretHash
, see Computing secret hash values.
* @public
*/
SecretHash?: string | undefined;
@@ -4866,18 +4974,26 @@ export interface ConfirmSignUpRequest {
Username: string | undefined;
/**
- * The confirmation code sent by a user's request to confirm registration.
+ *The confirmation code that your user pool sent in response to the SignUp
+ * request.
Boolean to be specified to force user confirmation irrespective of existing alias. By
- * default set to False
. If this parameter is set to True
and the
- * phone number/email used for sign up confirmation already exists as an alias with a
- * different user, the API call will migrate the alias from the previous user to the newly
- * created user being confirmed. If set to False
, the API will throw an
- * AliasExistsException error.
When true
, forces user confirmation despite any existing aliases.
+ * Defaults to false
. A value of true
migrates the alias from an
+ * existing user to the new user if an existing user already has the phone number or email
+ * address as an alias.
Say, for example, that an existing user has an email
attribute of
+ * bob@example.com
and email is an alias in your user pool. If the new
+ * user also has an email of bob@example.com
and your
+ * ConfirmSignUp
response sets ForceAliasCreation
to
+ * true
, the new user can sign in with a username of
+ * bob@example.com
and the existing user can no longer do so.
If false
and an attribute belongs to an existing alias, this request
+ * returns an AliasExistsException error.
For more information about sign-in aliases, see Customizing sign-in attributes.
* @public */ ForceAliasCreation?: boolean | undefined; @@ -4893,6 +5009,8 @@ export interface ConfirmSignUpRequest { *Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ UserContextData?: UserContextDataType | undefined; @@ -4911,21 +5029,21 @@ export interface ConfirmSignUpRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
You can automatically sign users in with the one-time password that they provided in a + *
A session identifier that you can use to immediately sign in the confirmed user. You
+ * can automatically sign users in with the one-time password that they provided in a
* successful ConfirmSignUp
request. To do this, pass the Session
- * parameter from the ConfirmSignUp
response in the Session
- * parameter of an InitiateAuth or AdminInitiateAuth request.
Session
parameter of an InitiateAuth or AdminInitiateAuth request.
* @public
*/
Session?: string | undefined;
@@ -4962,25 +5080,30 @@ export interface ConfirmSignUpResponse {
*/
export interface CreateGroupRequest {
/**
- * The name of the group. Must be unique.
+ *A name for the group. This name must be unique in your user pool.
* @public */ GroupName: string | undefined; /** - *The user pool ID for the user pool.
+ *The ID of the user pool where you want to create a user group.
* @public */ UserPoolId: string | undefined; /** - *A string containing the description of the group.
+ *A description of the group that you're creating.
* @public */ Description?: string | undefined; /** - *The role Amazon Resource Name (ARN) for the group.
+ *The Amazon Resource Name (ARN) for the IAM role that you want to associate with the
+ * group. A group role primarily declares a preferred role for the credentials that you get
+ * from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role
claim
+ * that presents the highest-precedence group that a user belongs to. Both ID and access
+ * tokens also contain a cognito:groups
claim that list all the groups that a
+ * user is a member of.
The group object for the group.
+ *The response object for a created group.
* @public */ Group?: GroupType | undefined; @@ -5061,19 +5184,22 @@ export type IdentityProviderTypeType = (typeof IdentityProviderTypeType)[keyof t */ export interface CreateIdentityProviderRequest { /** - *The user pool ID.
+ *The Id of the user pool where you want to create an IdP.
* @public */ UserPoolId: string | undefined; /** - *The IdP name.
+ *The name that you want to assign to the IdP. You can pass the identity provider name
+ * in the identity_provider
query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated
+ * IdP.
The IdP type.
+ *The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With + * Amazon, Sign In With Apple, Google, and Facebook IdPs.
* @public */ ProviderType: IdentityProviderTypeType | undefined; @@ -5203,13 +5329,18 @@ export interface CreateIdentityProviderRequest { ProviderDetails: RecordA mapping of IdP attributes to standard and custom user pool attributes.
+ *A mapping of IdP attributes to standard and custom user pool attributes. Specify a + * user pool attribute as the key of the key-value pair, and the IdP attribute claim name + * as the value.
* @public */ AttributeMapping?: RecordA list of IdP identifiers.
+ *An array of IdP identifiers, for example "IdPIdentifiers": [ "MyIdP", "MyIdP2"
+ * ]
. Identifiers are friendly names that you can pass in the
+ * idp_identifier
query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated IdP.
+ * Identifiers in a domain format also enable the use of email-address matching with SAML providers.
The newly created IdP object.
+ *The details of the new user pool IdP.
* @public */ IdentityProvider: IdentityProviderType | undefined; @@ -5447,9 +5578,8 @@ export interface CreateManagedLoginBrandingRequest { ClientId: string | undefined; /** - *When true, applies the default branding style options. This option reverts to default - * style options that are managed by Amazon Cognito. You can modify them later in the branding - * designer.
+ *When true, applies the default branding style options. These default options are + * managed by Amazon Cognito. You can modify them later in the branding designer.
*When you specify true
for this option, you must also omit values for
* Settings
and Assets
in the request.
When true, applies the default branding style options. This option reverts to a - * "blank" style that you can modify later in the branding designer.
+ *When true, applies the default branding style options. This option reverts to default + * style options that are managed by Amazon Cognito. You can modify them later in the branding + * designer.
+ *When you specify true
for this option, you must also omit values for
+ * Settings
and Assets
in the request.
The user pool ID for the user pool.
+ *The ID of the user pool where you want to create a resource server.
* @public */ UserPoolId: string | undefined; @@ -5612,8 +5745,10 @@ export interface CreateResourceServerRequest { Name: string | undefined; /** - *A list of scopes. Each scope is a key-value map with the keys name
and
- * description
.
A list of custom scopes. Each scope is a key-value map with the keys
+ * ScopeName
and ScopeDescription
. The name of a custom scope
+ * is a combination of ScopeName
and the resource server Name
in
+ * this request, for example MyResourceServerName/MyScopeName
.
The newly created resource server.
+ *The details of the new resource server.
* @public */ ResourceServer: ResourceServerType | undefined; @@ -5673,19 +5808,20 @@ export interface CreateResourceServerResponse { */ export interface CreateUserImportJobRequest { /** - *The job name for the user import job.
+ *A friendly name for the user import job.
* @public */ JobName: string | undefined; /** - *The user pool ID for the user pool that the users are being imported into.
+ *The ID of the user pool that you want to import users into.
* @public */ UserPoolId: string | undefined; /** - *The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
+ *You must specify an IAM role that has permission to log import-job results to + * Amazon CloudWatch Logs. This parameter is the ARN of that role.
* @public */ CloudWatchLogsRoleArn: string | undefined; @@ -5847,7 +5983,7 @@ export interface UserImportJobType { */ export interface CreateUserImportJobResponse { /** - *The job object that represents the user import job.
+ *The details of the user import job.
* @public */ UserImportJob?: UserImportJobType | undefined; @@ -6639,13 +6775,15 @@ export interface VerificationMessageTemplateType { */ export interface CreateUserPoolRequest { /** - *A string used to name the user pool.
+ *A friendlhy name for your user pool.
* @public */ PoolName: string | undefined; /** - *The policies associated with the new user pool.
+ *The password policy and sign-in policy in the user pool. The password policy sets + * options like password complexity requirements and password history. The sign-in policy + * sets the options available to applications in choice-based authentication.
* @public */ Policies?: UserPoolPolicyType | undefined; @@ -6671,21 +6809,23 @@ export interface CreateUserPoolRequest { LambdaConfig?: LambdaConfigType | undefined; /** - *The attributes to be auto-verified. Possible values: email, phone_number.
+ *The attributes that you want your user pool to automatically verify. Possible values: + * email, phone_number. For more information see Verifying contact information at sign-up.
* @public */ AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined; /** *Attributes supported as an alias for this user pool. Possible values: phone_number, email, or - * preferred_username.
+ * preferred_username. For more information about + * alias attributes, see Customizing sign-in attributes. * @public */ AliasAttributes?: AliasAttributeType[] | undefined; /** *Specifies whether a user can use an email address or phone number as a username when - * they sign up.
+ * they sign up. For more information, see Customizing sign-in attributes. * @public */ UsernameAttributes?: UsernameAttributeType[] | undefined; @@ -6728,7 +6868,11 @@ export interface CreateUserPoolRequest { SmsAuthenticationMessage?: string | undefined; /** - *Specifies MFA configuration details.
+ *Sets multi-factor authentication (MFA) to be on, off, or optional. When
+ * ON
, all users must set up MFA before they can sign in. When
+ * OPTIONAL
, your application must make a client-side determination of
+ * whether a user wants to register an MFA device. For user pools with adaptive
+ * authentication with threat protection, choose OPTIONAL
.
The device-remembering configuration for a user pool. A null value indicates that you - * have deactivated device remembering in your user pool.
+ *The device-remembering configuration for a user pool. Device remembering or device + * tracking is a "Remember me on this device" option for user pools that perform + * authentication with the device key of a trusted device in the back end, instead of a + * user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that + * you have deactivated device remembering in your user pool.
*When you provide a value for any DeviceConfiguration
field, you
- * activate the Amazon Cognito device-remembering feature.
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management - * (IAM) role in your Amazon Web Services account.
+ * (IAM) role in your Amazon Web Services account. For more information see SMS message settings. * @public */ SmsConfiguration?: SmsConfigurationType | undefined; @@ -6779,14 +6926,17 @@ export interface CreateUserPoolRequest { UserPoolTags?: RecordThe configuration for AdminCreateUser
requests.
The configuration for AdminCreateUser requests. Includes the template for the + * invitation message for new users, the duration of temporary passwords, and permitting + * self-service sign-up.
* @public */ AdminCreateUserConfig?: AdminCreateUserConfigType | undefined; /** - *An array of schema attributes for the new user pool. These attributes can be standard - * or custom attributes.
+ *An array of attributes for the new user pool. You can add custom attributes and modify + * the properties of default attributes. The specifications in this parameter set the + * required attributes in your user pool. For more information, see Working with user attributes.
* @public */ Schema?: SchemaAttributeType[] | undefined; @@ -6802,16 +6952,18 @@ export interface CreateUserPoolRequest { UserPoolAddOns?: UserPoolAddOnsType | undefined; /** - *Case sensitivity on the username input for the selected sign-in option. When case
- * sensitivity is set to False
(case insensitive), users can sign in with any
- * combination of capital and lowercase letters. For example, username
,
- * USERNAME
, or UserName
, or for email,
- * email@example.com
or EMaiL@eXamplE.Com
. For most use
- * cases, set case sensitivity to False
(case insensitive) as a best practice.
- * When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in
- * case as the same user, and prevents a case variation from being assigned to the same
- * attribute for a different user.
This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
+ *Sets the case sensitivity option for sign-in usernames. When
+ * CaseSensitive
is false
(case insensitive), users can sign
+ * in with any combination of capital and lowercase letters. For example,
+ * username
, USERNAME
, or UserName
, or for
+ * email, email@example.com
or EMaiL@eXamplE.Com
. For most use
+ * cases, set case sensitivity to false
as a best practice. When usernames and
+ * email addresses are case insensitive, Amazon Cognito treats any variation in case as the same
+ * user, and prevents a case variation from being assigned to the same attribute for a
+ * different user.
When CaseSensitive
is true
(case sensitive), Amazon Cognito
+ * interprets USERNAME
and UserName
as distinct users.
This configuration is immutable after you set it.
* @public */ UsernameConfiguration?: UsernameConfigurationType | undefined; @@ -7164,7 +7316,7 @@ export interface UserPoolType { */ export interface CreateUserPoolResponse { /** - *A container for the user pool details.
+ *The details of the created user pool.
* @public */ UserPool?: UserPoolType | undefined; @@ -7342,20 +7494,21 @@ export interface TokenValidityUnitsType { */ export interface CreateUserPoolClientRequest { /** - *The user pool ID for the user pool where you want to create a user pool client.
+ *The ID of the user pool where you want to create an app client.
* @public */ UserPoolId: string | undefined; /** - *The client name for the user pool client you would like to create.
+ *A friendly name for the app client that you want to create.
* @public */ ClientName: string | undefined; /** - *Boolean to specify whether you want to generate a secret for the user pool client - * being created.
+ *When true
, generates a client secret for the app client. Client secrets
+ * are used with server-side and machine-to-machine applications. For more information, see
+ * App client types.
The units in which the validity times are represented. The default unit for - * RefreshToken is days, and default for ID and access tokens are hours.
+ *The units that validity times are represented in. The default unit for refresh tokens + * is days, and the default for ID and access tokens are hours.
* @public */ TokenValidityUnits?: TokenValidityUnitsType | undefined; @@ -7521,8 +7674,8 @@ export interface CreateUserPoolClientRequest { *Google
, SignInWithApple
, and LoginWithAmazon
.
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
* user pool, for example MySAMLIdP
or MyOIDCIdP
.
- * This setting applies to providers that you can access with the hosted
- * UI and OAuth 2.0 authorization server. The removal of COGNITO
+ *
This setting applies to providers that you can access with managed
+ * login. The removal of COGNITO
* from this list doesn't prevent authentication operations for local users with the
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
* block access with a WAF rule.
Be an absolute URI.
* *Be registered with the authorization server.
+ *Be registered with the authorization server. Amazon Cognito doesn't accept
+ * authorization requests with redirect_uri
values that aren't in
+ * the list of CallbackURLs
that you provide in this parameter.
Not include a fragment component.
@@ -7554,7 +7709,8 @@ export interface CreateUserPoolClientRequest { CallbackURLs?: string[] | undefined; /** - *A list of allowed logout URLs for the IdPs.
+ *A list of allowed logout URLs for managed login authentication. For more information, + * see Logout endpoint.
* @public */ LogoutURLs?: string[] | undefined; @@ -7563,22 +7719,6 @@ export interface CreateUserPoolClientRequest { *The default redirect URI. In app clients with one assigned IdP, replaces
* redirect_uri
in authentication requests. Must be in the
* CallbackURLs
list.
A redirect URI must:
- *Be an absolute URI.
- *Be registered with the authorization server.
- *Not include a fragment component.
- *For more information, see Default redirect URI.
- *Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes - * only.
- *App callback URLs such as myapp://example are also supported.
* @public */ DefaultRedirectURI?: string | undefined; @@ -7611,10 +7751,13 @@ export interface CreateUserPoolClientRequest { AllowedOAuthFlows?: OAuthFlowType[] | undefined; /** - *The allowed OAuth scopes. Possible values provided by OAuth are phone
,
- * email
, openid
, and profile
. Possible values
- * provided by Amazon Web Services are aws.cognito.signin.user.admin
. Custom
- * scopes created in Resource Servers are also supported.
The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes
+ * govern access control to user pool self-service API operations, user data from the
+ * userInfo
endpoint, and third-party APIs. Possible values provided by
+ * OAuth are phone
, email
, openid
, and
+ * profile
. Possible values provided by Amazon Web Services are
+ * aws.cognito.signin.user.admin
. Custom scopes created in Resource
+ * Servers are also supported.
The user pool analytics configuration for collecting metrics and sending them to your * Amazon Pinpoint campaign.
- *In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending - * events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is - * available, user pools support sending events to Amazon Pinpoint projects within that same - * Region.
- *In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to + * analytics or might be configurable with campaigns in the US East (N. Virginia) Region. + * For more information, see Using Amazon Pinpoint analytics.
* @public */ AnalyticsConfiguration?: AnalyticsConfigurationType | undefined; @@ -7926,8 +8066,8 @@ export interface UserPoolClientType { *Google
, SignInWithApple
, and LoginWithAmazon
.
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
* user pool, for example MySAMLIdP
or MyOIDCIdP
.
- * This setting applies to providers that you can access with the hosted
- * UI and OAuth 2.0 authorization server. The removal of COGNITO
+ *
This setting applies to providers that you can access with managed
+ * login. The removal of COGNITO
* from this list doesn't prevent authentication operations for local users with the
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
* block access with a WAF rule.
The user pool client that was just created.
+ *The details of the new app client.
* @public */ UserPoolClient?: UserPoolClientType | undefined; @@ -8203,8 +8343,10 @@ export interface CustomDomainConfigType { export interface CreateUserPoolDomainRequest { /** *The domain string. For custom domains, this is the fully-qualified domain name, such
- * as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,
- * such as auth
.
auth.example.com
. For prefix domains, this is the prefix alone, such as
+ * myprefix
. A prefix value of myprefix
for a user pool in
+ * the us-east-1 Region results in a domain of
+ * myprefix.auth.us-east-1.amazoncognito.com
.
* @public
*/
Domain: string | undefined;
@@ -8217,19 +8359,18 @@ export interface CreateUserPoolDomainRequest {
/**
* The version of managed login branding that you want to apply to your domain. A value
- * of 1
indicates hosted UI (classic) branding and a version of 2
- * indicates managed login branding.
1
indicates hosted UI (classic) and a version of 2
+ * indicates managed login.
* Managed login requires that your user pool be configured for any feature plan other than Lite
.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for - * your application.
+ *The configuration for a custom domain. Configures your domain with an Certificate Manager
+ * certificate in the us-east-1
Region.
Provide this parameter only if you want to use a custom domain for your user pool. - * Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain - * instead.
+ * Otherwise, you can exclude this parameter and use a prefix domain instead. *For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
* @public */ @@ -8242,8 +8383,8 @@ export interface CreateUserPoolDomainRequest { export interface CreateUserPoolDomainResponse { /** *The version of managed login branding applied your domain. A value of 1
- * indicates hosted UI (classic) branding and a version of 2
indicates managed
- * login branding.
2
indicates managed
+ * login.
* @public
*/
ManagedLoginVersion?: number | undefined;
@@ -8263,13 +8404,13 @@ export interface CreateUserPoolDomainResponse {
*/
export interface DeleteGroupRequest {
/**
- * The name of the group.
+ *The name of the group that you want to delete.
* @public */ GroupName: string | undefined; /** - *The user pool ID for the user pool.
+ *The ID of the user pool where you want to delete the group.
* @public */ UserPoolId: string | undefined; @@ -8280,13 +8421,13 @@ export interface DeleteGroupRequest { */ export interface DeleteIdentityProviderRequest { /** - *The user pool ID.
+ *The ID of the user pool where you want to delete the identity provider.
* @public */ UserPoolId: string | undefined; /** - *The IdP name.
+ *The name of the IdP that you want to delete.
* @public */ ProviderName: string | undefined; @@ -8335,13 +8476,13 @@ export interface DeleteManagedLoginBrandingRequest { */ export interface DeleteResourceServerRequest { /** - *The user pool ID for the user pool that hosts the resource server.
+ *The ID of the user pool where you want to delete the resource server.
* @public */ UserPoolId: string | undefined; /** - *The identifier for the resource server.
+ *The identifier of the resource server that you want to delete.
* @public */ Identifier: string | undefined; @@ -8367,8 +8508,8 @@ export interface DeleteUserRequest { export interface DeleteUserAttributesRequest { /** *An array of strings representing the user attribute names you want to delete.
- *For custom attributes, you must prependattach the custom:
prefix to the
- * front of the attribute name.
For custom attributes, you must prepend the custom:
prefix to the
+ * attribute name, for example custom:department
.
The user pool ID for the user pool you want to delete.
+ *The ID of the user pool that you want to delete.
* @public */ UserPoolId: string | undefined; @@ -8405,13 +8546,13 @@ export interface DeleteUserPoolRequest { */ export interface DeleteUserPoolClientRequest { /** - *The user pool ID for the user pool where you want to delete the client.
+ *The ID of the user pool where you want to delete the client.
* @public */ UserPoolId: string | undefined; /** - *The app client ID of the app associated with the user pool.
+ *The ID of the user pool app client that you want to delete.
* @public */ ClientId: string | undefined; @@ -8422,15 +8563,15 @@ export interface DeleteUserPoolClientRequest { */ export interface DeleteUserPoolDomainRequest { /** - *The domain string. For custom domains, this is the fully-qualified domain name, such
- * as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,
- * such as auth
.
The domain that you want to delete. For custom domains, this is the fully-qualified
+ * domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is
+ * the prefix alone, such as auth
.
The user pool ID.
+ *The ID of the user pool where you want to delete the domain.
* @public */ UserPoolId: string | undefined; @@ -8446,15 +8587,15 @@ export interface DeleteUserPoolDomainResponse {} */ export interface DeleteWebAuthnCredentialRequest { /** - *A valid access token that Amazon Cognito issued to the user whose passkey you want to - * delete.
+ *A valid access token that Amazon Cognito issued to the user whose passkey credential you want + * to delete.
* @public */ AccessToken: string | undefined; /** *The unique identifier of the passkey that you want to delete. Look up registered - * devices with ListWebAuthnCredentials.
+ * devices with ListWebAuthnCredentials. * @public */ CredentialId: string | undefined; @@ -8470,13 +8611,13 @@ export interface DeleteWebAuthnCredentialResponse {} */ export interface DescribeIdentityProviderRequest { /** - *The user pool ID.
+ *The ID of the user pool that has the IdP that you want to describe..
* @public */ UserPoolId: string | undefined; /** - *The IdP name.
+ *The name of the IdP that you want to describe.
* @public */ ProviderName: string | undefined; @@ -8487,7 +8628,7 @@ export interface DescribeIdentityProviderRequest { */ export interface DescribeIdentityProviderResponse { /** - *The identity provider details.
+ *The details of the requested IdP.
* @public */ IdentityProvider: IdentityProviderType | undefined; @@ -8574,7 +8715,7 @@ export interface DescribeManagedLoginBrandingByClientResponse { */ export interface DescribeResourceServerRequest { /** - *The user pool ID for the user pool that hosts the resource server.
+ *The ID of the user pool that hosts the resource server.
* @public */ UserPoolId: string | undefined; @@ -8596,7 +8737,7 @@ export interface DescribeResourceServerRequest { */ export interface DescribeResourceServerResponse { /** - *The resource server.
+ *The details of the requested resource server.
* @public */ ResourceServer: ResourceServerType | undefined; @@ -8607,13 +8748,21 @@ export interface DescribeResourceServerResponse { */ export interface DescribeRiskConfigurationRequest { /** - *The user pool ID.
+ *The ID of the user pool with the risk configuration that you want to inspect. You can
+ * apply default risk configuration at the user pool level and further customize it from
+ * user pool defaults at the app-client level. Specify ClientId
to inspect
+ * client-level configuration, or UserPoolId
to inspect pool-level
+ * configuration.
The app client ID.
+ *The ID of the app client with the risk configuration that you want to inspect. You can
+ * apply default risk configuration at the user pool level and further customize it from
+ * user pool defaults at the app-client level. Specify ClientId
to inspect
+ * client-level configuration, or UserPoolId
to inspect pool-level
+ * configuration.
The risk configuration.
+ *The details of the requested risk configuration.
* @public */ RiskConfiguration: RiskConfigurationType | undefined; @@ -8774,13 +8923,13 @@ export interface DescribeRiskConfigurationResponse { */ export interface DescribeUserImportJobRequest { /** - *The user pool ID for the user pool that the users are being imported into.
+ *The ID of the user pool that's associated with the import job.
* @public */ UserPoolId: string | undefined; /** - *The job ID for the user import job.
+ *The Id of the user import job that you want to describe.
* @public */ JobId: string | undefined; @@ -8793,7 +8942,7 @@ export interface DescribeUserImportJobRequest { */ export interface DescribeUserImportJobResponse { /** - *The job object that represents the user import job.
+ *The details of the user import job.
* @public */ UserImportJob?: UserImportJobType | undefined; @@ -8805,7 +8954,7 @@ export interface DescribeUserImportJobResponse { */ export interface DescribeUserPoolRequest { /** - *The user pool ID for the user pool you want to describe.
+ *The ID of the user pool you want to describe.
* @public */ UserPoolId: string | undefined; @@ -8817,7 +8966,7 @@ export interface DescribeUserPoolRequest { */ export interface DescribeUserPoolResponse { /** - *The container of metadata returned by the server to describe the pool.
+ *The details of the requested user pool.
* @public */ UserPool?: UserPoolType | undefined; @@ -8829,13 +8978,13 @@ export interface DescribeUserPoolResponse { */ export interface DescribeUserPoolClientRequest { /** - *The user pool ID for the user pool you want to describe.
+ *The ID of the user pool that contains the app client you want to describe.
* @public */ UserPoolId: string | undefined; /** - *The app client ID of the app associated with the user pool.
+ *The ID of the app client that you want to describe.
* @public */ ClientId: string | undefined; @@ -8848,7 +8997,7 @@ export interface DescribeUserPoolClientRequest { */ export interface DescribeUserPoolClientResponse { /** - *The user pool client from a server response to describe the user pool client.
+ *The details of the request app client.
* @public */ UserPoolClient?: UserPoolClientType | undefined; @@ -8859,9 +9008,9 @@ export interface DescribeUserPoolClientResponse { */ export interface DescribeUserPoolDomainRequest { /** - *The domain string. For custom domains, this is the fully-qualified domain name, such
- * as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,
- * such as auth
.
The domain that you want to describe. For custom domains, this is the fully-qualified
+ * domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is
+ * the prefix alone, such as auth
.
A domain description object containing information about the domain.
+ *The details of the requested user pool domain.
* @public */ DomainDescription?: DomainDescriptionType | undefined; @@ -8995,7 +9144,8 @@ export interface ForgotPasswordRequest { /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a - * user pool client and username plus the client ID in the message.
+ * user pool client and username plus the client ID in the message. For more information + * aboutSecretHash
, see Computing secret hash values.
* @public
*/
SecretHash?: string | undefined;
@@ -9004,6 +9154,8 @@ export interface ForgotPasswordRequest {
* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ UserContextData?: UserContextDataType | undefined; @@ -9041,21 +9193,21 @@ export interface ForgotPasswordRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The user pool ID for the user pool that the users are to be imported into.
+ *The ID of the user pool that the users are to be imported into.
* @public */ UserPoolId: string | undefined; @@ -9124,7 +9276,7 @@ export interface GetCSVHeaderRequest { */ export interface GetCSVHeaderResponse { /** - *The user pool ID for the user pool that the users are to be imported into.
+ *The ID of the user pool that the users are to be imported into.
* @public */ UserPoolId?: string | undefined; @@ -9178,7 +9330,7 @@ export interface GetGroupRequest { GroupName: string | undefined; /** - *The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -9423,7 +9575,7 @@ export interface GetSigningCertificateResponse { */ export interface GetUICustomizationRequest { /** - *The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -9592,21 +9744,21 @@ export interface GetUserAttributeVerificationCodeRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The template for the email message that your user pool sends to users with an MFA
- * code. The message must contain the \{####\}
placeholder. In the message,
- * Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter,
- * Amazon Cognito sends messages in the default format.
The template for the email message that your user pool sends to users with a code for
+ * MFA and sign-in with an email OTP. The message must contain the \{####\}
+ * placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you
+ * don't provide this parameter, Amazon Cognito sends messages in the default format.
The subject of the email message that your user pool sends to users with an MFA - * code.
+ *The subject of the email message that your user pool sends to users with a code for + * MFA and email OTP sign-in.
* @public */ Subject?: string | undefined; diff --git a/clients/client-cognito-identity-provider/src/models/models_1.ts b/clients/client-cognito-identity-provider/src/models/models_1.ts index 7db7e08226d2..904e23018fb5 100644 --- a/clients/client-cognito-identity-provider/src/models/models_1.ts +++ b/clients/client-cognito-identity-provider/src/models/models_1.ts @@ -114,10 +114,10 @@ export interface WebAuthnConfigurationType { RelyingPartyId?: string | undefined; /** - *Sets or displays your user-pool treatment for MFA with a passkey. You can override - * other MFA options and require passkey MFA, or you can set it as preferred. When passkey - * MFA is preferred, the hosted UI encourages users to register a passkey at - * sign-in.
+ *When required
, users can only register and sign in users with passkeys
+ * that are capable of user
+ * verification. When preferred
, your user pool doesn't
+ * require the use of authenticators with user verification but encourages it.
The authentication flow that you want to initiate. The AuthParameters
- * that you must submit are linked to the flow that you submit. For example:
The authentication flow that you want to initiate. Each AuthFlow
has
+ * linked AuthParameters
that you must submit. The following are some example
+ * flows and their parameters.
@@ -231,12 +232,14 @@ export interface InitiateAuthRequest {
* PASSWORD
parameters.
Valid values include the following:
+ *+ * All flows + *
*The entry point for sign-in with passwords, one-time passwords, biometric - * devices, and security keys.
+ *The entry point for sign-in with passwords, one-time passwords, and + * WebAuthN authenticators.
*For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ UserContextData?: UserContextDataType | undefined; @@ -623,7 +628,7 @@ export interface ListDevicesResponse { */ export interface ListGroupsRequest { /** - *The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -740,7 +745,7 @@ export interface ListIdentityProvidersResponse { */ export interface ListResourceServersRequest { /** - *The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -803,7 +808,7 @@ export interface ListTagsForResourceResponse { */ export interface ListUserImportJobsRequest { /** - *The user pool ID for the user pool that the users are being imported into.
+ *The ID of the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; @@ -852,7 +857,7 @@ export interface ListUserImportJobsResponse { */ export interface ListUserPoolClientsRequest { /** - *The user pool ID for the user pool where you want to list user pool clients.
+ *The ID of the user pool where you want to list user pool clients.
* @public */ UserPoolId: string | undefined; @@ -1010,7 +1015,7 @@ export interface ListUserPoolsResponse { */ export interface ListUsersRequest { /** - *The user pool ID for the user pool on which the search should be performed.
+ *The ID of the user pool on which the search should be performed.
* @public */ UserPoolId: string | undefined; @@ -1175,7 +1180,7 @@ export interface ListUsersResponse { */ export interface ListUsersInGroupRequest { /** - *The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -1323,7 +1328,8 @@ export interface ResendConfirmationCodeRequest { /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a - * user pool client and username plus the client ID in the message.
+ * user pool client and username plus the client ID in the message. For more information + * aboutSecretHash
, see Computing secret hash values.
* @public
*/
SecretHash?: string | undefined;
@@ -1332,6 +1338,8 @@ export interface ResendConfirmationCodeRequest {
* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ UserContextData?: UserContextDataType | undefined; @@ -1367,21 +1375,21 @@ export interface ResendConfirmationCodeRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ UserContextData?: UserContextDataType | undefined; @@ -1645,21 +1655,21 @@ export interface RespondToAuthChallengeRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -2111,7 +2121,8 @@ export interface SignUpRequest { /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a - * user pool client and username plus the client ID in the message.
+ * user pool client and username plus the client ID in the message. For more information + * aboutSecretHash
, see Computing secret hash values.
* @public
*/
SecretHash?: string | undefined;
@@ -2166,6 +2177,8 @@ export interface SignUpRequest {
* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
+ *For more information, see Collecting data for threat protection in + * applications.
* @public */ UserContextData?: UserContextDataType | undefined; @@ -2185,21 +2198,21 @@ export interface SignUpRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The user pool ID for the user pool that the users are being imported into.
+ *The ID of the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; @@ -2325,7 +2338,7 @@ export class WebAuthnConfigurationMissingException extends __BaseException { */ export interface StopUserImportJobRequest { /** - *The user pool ID for the user pool that the users are being imported into.
+ *The ID of the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; @@ -2484,7 +2497,7 @@ export interface UpdateGroupRequest { GroupName: string | undefined; /** - *The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -2745,7 +2758,7 @@ export interface UpdateManagedLoginBrandingResponse { */ export interface UpdateResourceServerRequest { /** - *The user pool ID for the user pool.
+ *The ID of the user pool.
* @public */ UserPoolId: string | undefined; @@ -2824,21 +2837,21 @@ export interface UpdateUserAttributesRequest { *For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the + *
When you use the ClientMetadata
parameter, note that Amazon Cognito won't do the
* following:
Store the ClientMetadata value. This data is available only to Lambda - * triggers that are assigned to a user pool to support custom workflows. If - * your user pool configuration doesn't include triggers, the ClientMetadata - * parameter serves no purpose.
+ *Store the ClientMetadata
value. This data is available only
+ * to Lambda triggers that are assigned to a user pool to support custom
+ * workflows. If your user pool configuration doesn't include triggers, the
+ * ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata value.
+ *Validate the ClientMetadata
value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive - * information.
+ *Encrypt the ClientMetadata
value. Don't send sensitive
+ * information in this parameter.
The user pool ID for the user pool you want to update.
+ *The ID of the user pool you want to update.
* @public */ UserPoolId: string | undefined; @@ -3058,8 +3071,7 @@ export interface UpdateUserPoolResponse {} */ export interface UpdateUserPoolClientRequest { /** - *The user pool ID for the user pool where you want to update the user pool - * client.
+ *The ID of the user pool where you want to update the user pool client.
* @public */ UserPoolId: string | undefined; @@ -3238,8 +3250,8 @@ export interface UpdateUserPoolClientRequest { *Google
, SignInWithApple
, and LoginWithAmazon
.
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
* user pool, for example MySAMLIdP
or MyOIDCIdP
.
- * This setting applies to providers that you can access with the hosted
- * UI and OAuth 2.0 authorization server. The removal of COGNITO
+ *
This setting applies to providers that you can access with managed
+ * login. The removal of COGNITO
* from this list doesn't prevent authentication operations for local users with the
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
* block access with a WAF rule.
With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To\n authenticate users from third-party identity providers (IdPs) in this API, you can\n link IdP users to native user profiles. Learn more\n about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and hosted UI reference.
\nThis API reference provides detailed information about API operations and object types\n in Amazon Cognito.
\nAlong with resource management operations, the Amazon Cognito user pools API includes classes\n of operations and authorization models for client-side and server-side authentication of\n users. You can interact with operations in the Amazon Cognito user pools API as any of the\n following subjects.
\nAn administrator who wants to configure user pools, app clients, users,\n groups, or other user pool functions.
\nA server-side app, like a web application, that wants to use its Amazon Web Services\n privileges to manage, authenticate, or authorize a user.
\nA client-side app, like a mobile app, that wants to make unauthenticated\n requests to manage, authenticate, or authorize a user.
\nFor more information, see Using the Amazon Cognito user pools API and user pool endpoints\n in the Amazon Cognito Developer Guide.
\nWith your Amazon Web Services SDK, you can build the logic to support operational flows in every use\n case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started\n with the CognitoIdentityProvider
client in other supported Amazon Web Services\n SDKs.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services\n SDKs.
", + "smithy.api#documentation": "With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To\n authenticate users from third-party identity providers (IdPs) in this API, you can\n link IdP users to native user profiles. Learn more\n about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and hosted UI reference.
\nThis API reference provides detailed information about API operations and object types\n in Amazon Cognito.
\nAlong with resource management operations, the Amazon Cognito user pools API includes classes\n of operations and authorization models for client-side and server-side authentication of\n users. You can interact with operations in the Amazon Cognito user pools API as any of the\n following subjects.
\nAn administrator who wants to configure user pools, app clients, users,\n groups, or other user pool functions.
\nA server-side app, like a web application, that wants to use its Amazon Web Services\n privileges to manage, authenticate, or authorize a user.
\nA client-side app, like a mobile app, that wants to make unauthenticated\n requests to manage, authenticate, or authorize a user.
\nFor more information, see Using the Amazon Cognito user pools API and user pool endpoints\n in the Amazon Cognito Developer Guide.
\nWith your Amazon Web Services SDK, you can build the logic to support operational flows in every use\n case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started\n with the CognitoIdentityProvider
client in other supported Amazon Web Services\n SDKs.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services\n SDKs.
", "smithy.api#title": "Amazon Cognito Identity Provider", "smithy.api#xmlNamespace": { "uri": "http://cognito-idp.amazonaws.com/doc/2016-04-18/" @@ -1461,7 +1461,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds additional user attributes to the user pool schema.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nAdds additional user attributes to the user pool schema. Custom attributes can be\n mutable or immutable and have a custom:
or dev:
prefix. For\n more information, see Custom attributes.
You can also create custom attributes in the Schema parameter of CreateUserPool
and\n UpdateUserPool
. You can't delete custom attributes after you\n create them.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to add custom attributes.
", + "smithy.api#documentation": "The ID of the user pool where you want to add custom attributes.
", "smithy.api#required": {} } }, "CustomAttributes": { "target": "com.amazonaws.cognitoidentityprovider#CustomAttributesListType", "traits": { - "smithy.api#documentation": "An array of custom attributes, such as Mutable and Name.
", + "smithy.api#documentation": "An array of custom attribute names and other properties. Sets the following\n characteristics:
\nThe expected data type. Can be a string, a number, a date and time, or a\n boolean.
\nIf true, you can grant app clients write access to the attribute value. If\n false, the attribute value can only be set up on sign-up or administrator\n creation of users.
\nThe attribute name. For an attribute like custom:myAttribute
,\n enter myAttribute
for this field.
When true, users who sign up or are created must set a value for the\n attribute.
\nThe minimum and maximum length of accepted values for a\n Number
-type attribute.
The minimum and maximum length of accepted values for a\n String
-type attribute.
This legacy option creates an attribute with a dev:
prefix.\n You can only set the value of a developer-only attribute with administrative\n IAM credentials.
The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool that contains the group that you want to add the user\n to.
", "smithy.api#required": {} } }, @@ -1600,7 +1600,7 @@ } ], "traits": { - "smithy.api#documentation": "This IAM-authenticated API operation confirms user sign-up as an administrator.\n Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation.\n No confirmation code is required.
\nThis request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can\n configure your user pool to not send confirmation codes to new users and instead confirm\n them with this API operation on the back end.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nConfirms user sign-up as an administrator. Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation.\n No confirmation code is required.
\nThis request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can\n configure your user pool to not send confirmation codes to new users and instead confirm\n them with this API operation on the back end.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nTo configure your user pool to require administrative confirmation of users, set\n AllowAdminCreateUserOnly
to true
in a\n CreateUserPool
or UpdateUserPool
request.
The user pool ID for which you want to confirm user registration.
", + "smithy.api#documentation": "The ID of the user pool where you want to confirm a user's sign-up\n request.
", "smithy.api#required": {} } }, @@ -1623,7 +1623,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nIf your user pool configuration includes triggers, the AdminConfirmSignUp API action\n invokes the Lambda function that is specified for the post\n confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON\n payload, which the function receives as input. In this payload, the\n clientMetadata
attribute provides the data that you assigned to the\n ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in\n Lambda, you can process the ClientMetadata value to enhance your workflow for your\n specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nIf your user pool configuration includes triggers, the AdminConfirmSignUp API action\n invokes the Lambda function that is specified for the post\n confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON\n payload, which the function receives as input. In this payload, the\n clientMetadata
attribute provides the data that you assigned to the\n ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in\n Lambda, you can process the ClientMetadata value to enhance your workflow for your\n specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The user pool ID for the user pool where the user will be created.
", + "smithy.api#documentation": "The ID of the user pool where you want to create a user.
", "smithy.api#required": {} } }, @@ -1823,25 +1823,25 @@ "target": "com.amazonaws.cognitoidentityprovider#ForceAliasCreation", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "This parameter is used only if the phone_number_verified
or\n email_verified
attribute is set to True
. Otherwise, it is\n ignored.
If this parameter is set to True
and the phone number or email address\n specified in the UserAttributes parameter already exists as an alias with a different\n user, the API call will migrate the alias from the previous user to the newly created\n user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False
, the API throws an\n AliasExistsException
error if the alias already exists. The default\n value is False
.
This parameter is used only if the phone_number_verified
or\n email_verified
attribute is set to True
. Otherwise, it is\n ignored.
If this parameter is set to True
and the phone number or email address\n specified in the UserAttributes
parameter already exists as an alias with a\n different user, this request migrates the alias from the previous user to the\n newly-created user. The previous user will no longer be able to log in using that\n alias.
If this parameter is set to False
, the API throws an\n AliasExistsException
error if the alias already exists. The default\n value is False
.
Set to RESEND
to resend the invitation message to a user that already\n exists and reset the expiration limit on the user's account. Set to\n SUPPRESS
to suppress sending the message. You can specify only one\n value.
Set to RESEND
to resend the invitation message to a user that already\n exists, and to reset the temporary-password duration with a new temporary password. Set\n to SUPPRESS
to suppress sending the message. You can specify only one\n value.
Specify \"EMAIL\"
if email will be used to send the welcome message.\n Specify \"SMS\"
if the phone number will be used. The default value is\n \"SMS\"
. You can specify more than one value.
Specify EMAIL
if email will be used to send the welcome message. Specify\n SMS
if the phone number will be used. The default value is\n SMS
. You can specify more than one value.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned\n to the pre sign-up trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n clientMetadata
attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your AdminCreateUser request. In your function code in\n Lambda, you can process the clientMetadata
value to enhance your\n workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned\n to the pre sign-up trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n ClientMetadata
attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your AdminCreateUser request. In your function code in\n Lambda, you can process the clientMetadata
value to enhance your\n workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The newly created user.
" + "smithy.api#documentation": "The new user's profile details.
" } } }, @@ -1904,7 +1904,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a user as an administrator. Works on any user.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nDeletes a user profile in your user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nDeletes the user attributes in a user pool as an administrator. Works on any\n user.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nDeletes attribute values from a user. This operation doesn't affect tokens for\n existing user sessions. The next ID token that the user receives will no longer have\n this attribute.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to delete user attributes.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete user attributes.
", "smithy.api#required": {} } }, @@ -1983,7 +1983,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool where you want to delete the user.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete the user.
", "smithy.api#required": {} } }, @@ -2041,14 +2041,14 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete the user's linked\n identities.
", "smithy.api#required": {} } }, "User": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { - "smithy.api#documentation": "The user to be disabled.
", + "smithy.api#documentation": "The user profile that you want to delete a linked identity from.
", "smithy.api#required": {} } } @@ -2093,7 +2093,7 @@ } ], "traits": { - "smithy.api#documentation": "Deactivates a user and revokes all access tokens for the user. A deactivated user\n can't sign in, but still appears in the responses to GetUser
and\n ListUsers
API requests.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nDeactivates a user profile and revokes all access tokens for the user. A deactivated\n user can't sign in, but still appears in the responses to ListUsers
\n API requests.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to disable the user.
", + "smithy.api#documentation": "The ID of the user pool where you want to disable the user.
", "smithy.api#required": {} } }, @@ -2156,7 +2156,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables the specified user as an administrator. Works on any user.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nActivate sign-in for a user profile that previously had sign-in access\n disabled.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to enable the user.
", + "smithy.api#documentation": "The ID of the user pool where you want to activate sign-in for the user.
", "smithy.api#required": {} } }, @@ -2222,7 +2222,7 @@ } ], "traits": { - "smithy.api#documentation": "Forgets the device, as an administrator.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nForgets, or deletes, a remembered device from a user's profile. After you forget\n the device, the user can no longer complete device authentication with that device and\n when applicable, must submit MFA codes again. For more information, see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where the device owner is a user.
", "smithy.api#required": {} } }, @@ -2245,7 +2245,7 @@ "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { - "smithy.api#documentation": "The device key.
", + "smithy.api#documentation": "The key ID of the device that you want to delete. You can get device keys in the\n response to an AdminListDevices request.
", "smithy.api#required": {} } } @@ -2284,7 +2284,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the device, as an administrator.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven the device key, returns details for a user' device. For more information,\n see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe device key.
", + "smithy.api#documentation": "The key of the device that you want to delete. You can get device IDs in the response\n to an AdminListDevices request.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where the device owner is a user.
", "smithy.api#required": {} } }, @@ -2323,7 +2323,7 @@ "Device": { "target": "com.amazonaws.cognitoidentityprovider#DeviceType", "traits": { - "smithy.api#documentation": "The device.
", + "smithy.api#documentation": "Details of the requested device. Includes device information, last-accessed and\n created dates, and the device key.
", "smithy.api#required": {} } } @@ -2362,7 +2362,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the specified user by user name in a user pool as an administrator. Works on any\n user. This operation contributes to your monthly active user (MAU) count for the purpose\n of billing.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven the username, returns details about a user profile in a user pool. This\n operation contributes to your monthly active user (MAU) count for the purpose of\n billing. You can specify alias attributes in the Username
parameter.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to get information about the\n user.
", + "smithy.api#documentation": "The ID of the user pool where you want to get information about the user.
", "smithy.api#required": {} } }, @@ -2401,13 +2401,13 @@ "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "An array of name-value pairs representing user attributes.
" + "smithy.api#documentation": "An array of name-value pairs of user attributes and their values, for example\n \"email\": \"testuser@example.com\"
.
The date the user was created.
" + "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date
object.
Indicates that the status is enabled
.
Indicates whether the user is activated for sign-in. The AdminDisableUser and AdminEnableUser API operations deactivate and activate\n user sign-in, respectively.
" } }, "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { - "smithy.api#documentation": "The user status. Can be one of the following:
\nUNCONFIRMED - User has been created but not confirmed.
\nCONFIRMED - User has been confirmed.
\nUNKNOWN - User status isn't known.
\nRESET_REQUIRED - User is confirmed, but the user must request a code and reset\n their password before they can sign in.
\nFORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a\n temporary password, but on first sign-in, the user must change their password to\n a new value before doing anything else.
\nThe user's status. Can be one of the following:
\nUNCONFIRMED - User has been created but not confirmed.
\nCONFIRMED - User has been confirmed.
\nUNKNOWN - User status isn't known.
\nRESET_REQUIRED - User is confirmed, but the user must request a code and reset\n their password before they can sign in.
\nFORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a\n temporary password, but on first sign-in, the user must change their password to\n a new value before doing anything else.
\nEXTERNAL_PROVIDER - The user signed in with a third-party identity\n provider.
\nThe user's preferred MFA setting.
" + "smithy.api#documentation": "The user's preferred MFA. Users can prefer SMS message, email message, or TOTP\n MFA.
" } }, "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { - "smithy.api#documentation": "The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA
, EMAIL_OTP
, and\n SOFTWARE_TOKEN_MFA
.
The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA
, EMAIL_OTP
, and SOFTWARE_TOKEN_MFA
.\n You can change the MFA preference for users who have more than one available MFA factor\n with AdminSetUserMFAPreference or SetUserMFAPreference.
Initiates the authentication flow, as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nStarts sign-in for applications with a server-side component, for example a\n traditional web application. This operation specifies the authentication flow that\n you'd like to begin. The authentication flow that you specify must be supported in\n your app client configuration. For more information about authentication flows, see\n Authentication flows.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the Amazon Cognito user pool.
", + "smithy.api#documentation": "The ID of the user pool where the user wants to sign in.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "The app client ID.
", + "smithy.api#documentation": "The ID of the app client where the user wants to sign in.
", "smithy.api#required": {} } }, "AuthFlow": { "target": "com.amazonaws.cognitoidentityprovider#AuthFlowType", "traits": { - "smithy.api#documentation": "The authentication flow that you want to initiate. The AuthParameters
\n that you must submit are linked to the flow that you submit. For example:
\n USER_AUTH
: Request a preferred authentication type or review\n available authentication types. From the offered authentication types, select\n one in a challenge response and then authenticate with that method in an\n additional challenge response.
\n REFRESH_TOKEN_AUTH
: Receive new ID and access tokens when you\n pass a REFRESH_TOKEN
parameter with a valid refresh token as the\n value.
\n USER_SRP_AUTH
: Receive secure remote password (SRP) variables for\n the next challenge, PASSWORD_VERIFIER
, when you pass\n USERNAME
and SRP_A
parameters..
\n ADMIN_USER_PASSWORD_AUTH
: Receive new tokens or the next\n challenge, for example SOFTWARE_TOKEN_MFA
, when you pass\n USERNAME
and PASSWORD
parameters.
Valid values include the following:
\nThe entry point for sign-in with passwords, one-time passwords, biometric\n devices, and security keys.
\nUsername-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.
\nProvide a valid refresh token and receive new ID and access tokens. For\n more information, see Using the refresh token.
\nCustom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.
\nUsername-password authentication with the password sent directly in the\n request. For more information, see Admin authentication flow.
\n\n USER_PASSWORD_AUTH
is a flow type of InitiateAuth and isn't valid for\n AdminInitiateAuth.
The authentication flow that you want to initiate. Each AuthFlow
has\n linked AuthParameters
that you must submit. The following are some example\n flows and their parameters.
\n USER_AUTH
: Request a preferred authentication type or review\n available authentication types. From the offered authentication types, select\n one in a challenge response and then authenticate with that method in an\n additional challenge response.
\n REFRESH_TOKEN_AUTH
: Receive new ID and access tokens when you\n pass a REFRESH_TOKEN
parameter with a valid refresh token as the\n value.
\n USER_SRP_AUTH
: Receive secure remote password (SRP) variables for\n the next challenge, PASSWORD_VERIFIER
, when you pass\n USERNAME
and SRP_A
parameters..
\n ADMIN_USER_PASSWORD_AUTH
: Receive new tokens or the next\n challenge, for example SOFTWARE_TOKEN_MFA
, when you pass\n USERNAME
and PASSWORD
parameters.
\n All flows\n
\nThe entry point for sign-in with passwords, one-time passwords, and\n WebAuthN authenticators.
\nUsername-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.
\nProvide a valid refresh token and receive new ID and access tokens. For\n more information, see Using the refresh token.
\nCustom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.
\nUsername-password authentication with the password sent directly in the\n request. For more information, see Admin authentication flow.
\n\n USER_PASSWORD_AUTH
is a flow type of InitiateAuth and isn't valid for\n AdminInitiateAuth.
A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that\n are specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminInitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for\n the following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nCustom email sender
\nCustom SMS sender
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that\n are specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminInitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for\n the following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nCustom email sender
\nCustom SMS sender
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The analytics metadata for collecting Amazon Pinpoint metrics for\n AdminInitiateAuth
calls.
The analytics metadata for collecting Amazon Pinpoint metrics.
" } }, "ContextData": { "target": "com.amazonaws.cognitoidentityprovider#ContextDataType", "traits": { - "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "The optional session ID from a ConfirmSignUp
API request. You can sign in\n a user directly from the sign-up process with the USER_AUTH
authentication\n flow.
The optional session ID from a ConfirmSignUp
API request. You can sign in\n a user directly from the sign-up process with an AuthFlow
of\n USER_AUTH
and AuthParameters
of EMAIL_OTP
or\n SMS_OTP
, depending on how your user pool sent the confirmation-code\n message.
The session that should be passed both ways in challenge-response calls to the\n service. If AdminInitiateAuth
or AdminRespondToAuthChallenge
\n API call determines that the caller must pass another challenge, they return a session\n with other challenge parameters. This session should be passed as it is to the next\n AdminRespondToAuthChallenge
API call.
The session that must be passed to challenge-response requests. If an\n AdminInitiateAuth
or AdminRespondToAuthChallenge
API\n request determines that the caller must pass another challenge, Amazon Cognito returns a session\n ID and the parameters of the next challenge. Pass this session Id in the\n Session
parameter of AdminRespondToAuthChallenge
.
The result of the authentication response. This is only returned if the caller doesn't\n need to pass another challenge. If the caller does need to pass another challenge before\n it gets tokens, ChallengeName
, ChallengeParameters
, and\n Session
are returned.
The outcome of successful authentication. This is only returned if the user pool has\n no additional challenges to return. If Amazon Cognito returns another challenge, the response\n includes ChallengeName
, ChallengeParameters
, and\n Session
so that your user can answer the challenge.
The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool where you want to link a federated identity.
", "smithy.api#required": {} } }, @@ -2711,7 +2711,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists a user's registered devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nLists a user's registered devices. Remembered devices are used in authentication\n services where you offer a \"Remember me\" option for users who you want to permit to sign\n in without MFA from a trusted device. Users can bypass MFA while your application\n performs device SRP authentication on the back end. For more information, see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where the device owner is a user.
", "smithy.api#required": {} } }, @@ -2734,7 +2734,7 @@ "Limit": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { - "smithy.api#documentation": "The limit of the devices request.
" + "smithy.api#documentation": "The maximum number of devices that you want Amazon Cognito to return in the response.
" } }, "PaginationToken": { @@ -2755,7 +2755,7 @@ "Devices": { "target": "com.amazonaws.cognitoidentityprovider#DeviceListType", "traits": { - "smithy.api#documentation": "The devices in the list of devices response.
" + "smithy.api#documentation": "An array of devices and their information. Each entry that's returned includes\n device information, last-accessed and created dates, and the device key.
" } }, "PaginationToken": { @@ -2799,7 +2799,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the groups that a user belongs to.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nLists the groups that a user belongs to. User pool groups are identifiers that you can\n reference from the contents of ID and access tokens, and set preferred IAM roles for\n identity-pool authentication. For more information, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool where you want to view a user's groups.
", "smithy.api#required": {} } }, "Limit": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { - "smithy.api#documentation": "The limit of the request to list groups.
" + "smithy.api#documentation": "The maximum number of groups that you want Amazon Cognito to return in the response.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" + "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, @@ -2848,13 +2848,13 @@ "Groups": { "target": "com.amazonaws.cognitoidentityprovider#GroupListType", "traits": { - "smithy.api#documentation": "The groups that the user belongs to.
" + "smithy.api#documentation": "An array of groups and information about them.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" + "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, @@ -2894,7 +2894,7 @@ } ], "traits": { - "smithy.api#documentation": "A history of user activity and any risks detected as part of Amazon Cognito advanced\n security.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nRequests a history of user activity and any risks detected as part of Amazon Cognito threat\n protection. For more information, see Viewing user event history.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The Id of the user pool that contains the user profile with the logged events.
", "smithy.api#required": {} } }, @@ -2929,7 +2929,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "A pagination token.
" + "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, @@ -2949,7 +2949,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "A pagination token.
" + "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, @@ -2986,7 +2986,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified user from the specified group.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven a username and a group name. removes them from the group. User pool groups are\n identifiers that you can reference from the contents of ID and access tokens, and set\n preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool that contains the group and the user that you want to\n remove.
", "smithy.api#required": {} } }, @@ -3009,7 +3009,7 @@ "GroupName": { "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { - "smithy.api#documentation": "The group name.
", + "smithy.api#documentation": "The name of the group that you want to remove the user from, for example\n MyTestGroup
.
Resets the specified user's password in a user pool as an administrator. Works on any\n user.
\nTo use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nDeactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException
error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nResets the specified user's password in a user pool. This operation doesn't\n change the user's password, but sends a password-reset code. This operation is the\n administrative authentication API equivalent to ForgotPassword.
\nThis operation deactivates a user's password, requiring them to change it. If a user\n tries to sign in after the API request, Amazon Cognito responds with a\n PasswordResetRequiredException
error. Your app must then complete the\n forgot-password flow by prompting the user for their code and a new password, then\n submitting those values in a ConfirmForgotPassword request. In addition, if the user\n pool has phone verification selected and a verified phone number exists for the user, or\n if email verification is selected and a verified email exists for the user, calling this\n API will also result in sending a message to the end user with the code to change their\n password.
To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to reset the user's password.
", + "smithy.api#documentation": "The ID of the user pool where you want to reset the user's password.
", "smithy.api#required": {} } }, @@ -3091,7 +3091,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function\n that is assigned to the custom message trigger. When Amazon Cognito invokes\n this function, it passes a JSON payload, which the function receives as input. This\n payload contains a clientMetadata
attribute, which provides the data that\n you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In\n your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. The AdminResetUserPassword
API operation invokes the function\n that is assigned to the custom message trigger. When Amazon Cognito invokes\n this function, it passes a JSON payload, which the function receives as input. This\n payload contains a clientMetadata
attribute, which provides the data that\n you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In\n your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The ID of the Amazon Cognito user pool.
", + "smithy.api#documentation": "The ID of the user pool where you want to respond to an authentication\n challenge.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "The app client ID.
", + "smithy.api#documentation": "The ID of the app client where you initiated sign-in.
", "smithy.api#required": {} } }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "The challenge name. For more information, see AdminInitiateAuth.
", + "smithy.api#documentation": "The name of the challenge that you are responding to. You can find more information\n about values for ChallengeName
in the response parameters of AdminInitiateAuth.
The session that should be passed both ways in challenge-response calls to the\n service. If an InitiateAuth
or RespondToAuthChallenge
API call\n determines that the caller must pass another challenge, it returns a session with other\n challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge
API call.
The session identifier that maintains the state of authentication requests and\n challenge responses. If an AdminInitiateAuth
or\n AdminRespondToAuthChallenge
API request results in a determination that\n your application must pass another challenge, Amazon Cognito returns a session with other\n challenge parameters. Send this session identifier, unmodified, to the next\n AdminRespondToAuthChallenge
request.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions\n that you have assigned to the following triggers:
\npre sign-up
\ncustom message
\npost authentication
\nuser migration
\npre token generation
\ndefine auth challenge
\ncreate auth challenge
\nverify auth challenge response
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your AdminRespondToAuthChallenge request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions\n that you have assigned to the following triggers:
\nPre sign-up
\ncustom message
\nPost authentication
\nUser migration
\nPre token generation
\nDefine auth challenge
\nCreate auth challenge
\nVerify auth challenge response
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your AdminRespondToAuthChallenge request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The name of the challenge. For more information, see AdminInitiateAuth.
" + "smithy.api#documentation": "The name of the challenge that you must next respond to. You can find more information\n about values for ChallengeName
in the response parameters of AdminInitiateAuth.
The session that should be passed both ways in challenge-response calls to the\n service. If the caller must pass another challenge, they return a session with other\n challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge
API call.
The session identifier that maintains the state of authentication requests and\n challenge responses. If an AdminInitiateAuth
or\n AdminRespondToAuthChallenge
API request results in a determination that\n your application must pass another challenge, Amazon Cognito returns a session with other\n challenge parameters. Send this session identifier, unmodified, to the next\n AdminRespondToAuthChallenge
request.
The challenge parameters. For more information, see AdminInitiateAuth.
" + "smithy.api#documentation": "The parameters that define your response to the next challenge. Take the values in\n ChallengeParameters
and provide values for them in the ChallengeResponses of the next AdminRespondToAuthChallenge
\n request.
The result returned by the server in response to the authentication request.
" + "smithy.api#documentation": "The outcome of a successful authentication process. After your application has passed\n all challenges, Amazon Cognito returns an AuthenticationResult
with the JSON web\n tokens (JWTs) that indicate successful sign-in.
Sets the user's multi-factor authentication (MFA) preference, including which MFA\n options are activated, and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nSets the user's multi-factor authentication (MFA) preference, including which MFA\n options are activated, and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in.
\nThis operation doesn't reset an existing TOTP MFA for a user. To register a new\n TOTP factor for a user, make an AssociateSoftwareToken request. For more information,\n see TOTP software token MFA.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nSets the specified user's password in a user pool as an administrator. Works on any\n user.
\nThe password can be temporary or permanent. If it is temporary, the user status enters\n the FORCE_CHANGE_PASSWORD
state. When the user next tries to sign in, the\n InitiateAuth/AdminInitiateAuth response will contain the\n NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in before it\n expires, the user won't be able to sign in, and an administrator must reset their\n password.
Once the user has set a new password, or the password is permanent, the user status is\n set to Confirmed
.
\n AdminSetUserPassword
can set a password for the user profile that Amazon Cognito\n creates for third-party federated users. When you set a password, the federated user's\n status changes from EXTERNAL_PROVIDER
to CONFIRMED
. A user in\n this state can sign in as a federated user, and initiate authentication flows in the API\n like a linked native user. They can also modify their password and attributes in\n token-authenticated API requests like ChangePassword
and\n UpdateUserAttributes
. As a best security practice and to keep users in\n sync with your external IdP, don't set passwords on federated user profiles. To set up a\n federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user\n profile.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nSets the specified user's password in a user pool. This operation administratively\n sets a temporary or permanent password for a user. With this operation, you can bypass\n self-service password changes and permit immediate sign-in with the password that you\n set. To do this, set Permanent
to true
.
You can also set a new temporary password in this request, send it to a user, and\n require them to choose a new password on their next sign-in. To do this, set\n Permanent
to false
.
If the password is temporary, the user's Status
becomes\n FORCE_CHANGE_PASSWORD
. When the user next tries to sign in, the\n InitiateAuth
or AdminInitiateAuth
response includes the\n NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in\n before the temporary password expires, they can no longer sign in and you must repeat\n this operation to set a temporary or permanent password for them.
After the user sets a new password, or if you set a permanent password, their status\n becomes Confirmed
.
\n AdminSetUserPassword
can set a password for the user profile that Amazon Cognito\n creates for third-party federated users. When you set a password, the federated user's\n status changes from EXTERNAL_PROVIDER
to CONFIRMED
. A user in\n this state can sign in as a federated user, and initiate authentication flows in the API\n like a linked native user. They can also modify their password and attributes in\n token-authenticated API requests like ChangePassword
and\n UpdateUserAttributes
. As a best security practice and to keep users in\n sync with your external IdP, don't set passwords on federated user profiles. To set up a\n federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user\n profile.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to set the user's password.
", + "smithy.api#documentation": "The ID of the user pool where you want to set the user's password.
", "smithy.api#required": {} } }, @@ -3421,7 +3421,7 @@ "Password": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "The password for the user.
", + "smithy.api#documentation": "The new temporary or permanent password that you want to set for the user. You\n can't remove the password for a user who already has a password so that they can\n only sign in with passwordless methods. In this scenario, you must create a new user\n without a password.
", "smithy.api#required": {} } }, @@ -3429,7 +3429,7 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "\n True
if the password is permanent, False
if it is\n temporary.
Set to true
to set a password that the user can immediately sign in with.\n Set to false
to set a temporary password that the user must change on their\n next sign-in.
Provides feedback for an authentication event indicating if it was from a valid user.\n This feedback is used for improving the risk evaluation decision for the user pool as\n part of Amazon Cognito advanced security.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nProvides feedback for an authentication event indicating if it was from a valid user.\n This feedback is used for improving the risk evaluation decision for the user pool as\n part of Amazon Cognito threat protection. To train the threat-protection model to recognize\n trusted and untrusted sign-in characteristics, configure threat protection in audit-only\n mode and provide a mechanism for users or administrators to submit feedback. Your\n feedback can tell Amazon Cognito that a risk rating was assigned at a level you don't agree\n with.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where you want to submit authentication-event feedback.
", "smithy.api#required": {} } }, @@ -3566,7 +3566,7 @@ "EventId": { "target": "com.amazonaws.cognitoidentityprovider#EventIdType", "traits": { - "smithy.api#documentation": "The authentication event ID.
", + "smithy.api#documentation": "The authentication event ID. To query authentication events for a user, see AdminListUserAuthEvents.
", "smithy.api#required": {} } }, @@ -3621,7 +3621,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the device status as an administrator.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nUpdates the status of a user's device so that it is marked as remembered or not\n remembered for the purpose of device authentication. Device authentication is a\n \"remember me\" mechanism that silently completes sign-in from trusted devices with a\n device key instead of a user-provided MFA code. This operation changes the status of a\n device without deleting it, so you can enable it again later. For more information about\n device authentication, see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where you want to change a user's device status.
", "smithy.api#required": {} } }, @@ -3644,14 +3644,14 @@ "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { - "smithy.api#documentation": "The device key.
", + "smithy.api#documentation": "The unique identifier, or device key, of the device that you want to update the status\n for.
", "smithy.api#required": {} } }, "DeviceRememberedStatus": { "target": "com.amazonaws.cognitoidentityprovider#DeviceRememberedStatusType", "traits": { - "smithy.api#documentation": "The status indicating whether a device has been remembered or not.
" + "smithy.api#documentation": "To enable device authentication with the specified device, set to\n remembered
.To disable, set to not_remembered
.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user. To delete an attribute from your user, submit the\n attribute in your API request with a blank value.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user's attributes. To delete an attribute from your user,\n submit the attribute in your API request with a blank value.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
This operation can set a user's email address or phone number as verified and\n permit immediate sign-in in user pools that require verification of these attributes. To\n do this, set the email_verified
or phone_number_verified
\n attribute to true
.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to update user attributes.
", + "smithy.api#documentation": "The ID of the user pool where you want to update user attributes.
", "smithy.api#required": {} } }, @@ -3748,7 +3748,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the\n function that is assigned to the custom message trigger. When Amazon Cognito\n invokes this function, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata
attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes\n request. In your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the\n function that is assigned to the custom message trigger. When Amazon Cognito\n invokes this function, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata
attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes\n request. In your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call\n this operation with your administrative credentials when your user signs out of your\n app. This results in the following behavior.
\nAmazon Cognito no longer accepts token-authorized user operations\n that you authorize with a signed-out user's access tokens. For more information,\n see Using the Amazon Cognito user pools API and user pool\n endpoints.
\nAmazon Cognito returns an Access Token has been revoked
error when your\n app attempts to authorize a user pools API request with a revoked access token\n that contains the scope aws.cognito.signin.user.admin
.
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with\n ServerSideTokenCheck
enabled for its user pool IdP\n configuration in CognitoIdentityProvider.
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh\n requests.
\nOther requests might be valid until your user's token expires.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nInvalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call\n this operation with your administrative credentials when your user signs out of your\n app. This results in the following behavior.
\nAmazon Cognito no longer accepts token-authorized user operations\n that you authorize with a signed-out user's access tokens. For more information,\n see Using the Amazon Cognito user pools API and user pool\n endpoints.
\nAmazon Cognito returns an Access Token has been revoked
error when your\n app attempts to authorize a user pools API request with a revoked access token\n that contains the scope aws.cognito.signin.user.admin
.
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with\n ServerSideTokenCheck
enabled for its user pool IdP\n configuration in CognitoIdentityProvider.
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh\n requests.
\nOther requests might be valid until your user's token expires. This operation\n doesn't clear the managed login session cookie. To clear the session for\n a user who signed in with managed login or the classic hosted UI, direct their browser\n session to the logout endpoint.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where you want to sign out a user.
", "smithy.api#required": {} } }, @@ -4227,7 +4227,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken
request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a\n VerifySoftwareToken API request. If you don't verify the software\n token and your user pool doesn't require MFA, the user can then authenticate with\n user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito\n generates an MFA_SETUP
or SOFTWARE_TOKEN_SETUP
challenge\n each time your user signs in. Complete setup with\n AssociateSoftwareToken
and VerifySoftwareToken
.
After you set up software token MFA for your user, Amazon Cognito generates a\n SOFTWARE_TOKEN_MFA
challenge when they authenticate. Respond to\n this challenge with your user's TOTP.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nBegins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken
request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a\n VerifySoftwareToken API request. If you don't verify the software\n token and your user pool doesn't require MFA, the user can then authenticate with\n user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito\n generates an MFA_SETUP
or SOFTWARE_TOKEN_SETUP
challenge\n each time your user signs in. Complete setup with\n AssociateSoftwareToken
and VerifySoftwareToken
.
After you set up software token MFA for your user, Amazon Cognito generates a\n SOFTWARE_TOKEN_MFA
challenge when they authenticate. Respond to\n this challenge with your user's TOTP.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
A valid access token that Amazon Cognito issued to the user whose software token you want to\n generate.
" + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose software token you want to\n generate. You can provide either an access token or a session ID in the request.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the\n service. This allows authentication of the user as part of the MFA setup process.
" + "smithy.api#documentation": "The session identifier that maintains the state of authentication requests and\n challenge responses. In AssociateSoftwareToken
, this is the session ID from\n a successful sign-in. You can provide either an access token or a session ID in the\n request.
A unique generated shared secret code that is used in the TOTP algorithm to generate a\n one-time code.
" + "smithy.api#documentation": "A unique generated shared secret code that is used by the TOTP algorithm to generate a\n one-time code.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the\n service. This allows authentication of the user as part of the MFA setup process.
" + "smithy.api#documentation": "The session identifier that maintains the state of authentication requests and\n challenge responses. This session ID is valid for the next request in this flow, VerifySoftwareToken.
" } } }, @@ -4881,7 +4881,7 @@ "ProposedPassword": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "The new password.
", + "smithy.api#documentation": "A new password that you prompted the user to enter in your application.
", "smithy.api#required": {} } }, @@ -5121,7 +5121,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose passkey registration you want\n to verify.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose passkey registration you want\n to complete.
", "smithy.api#required": {} } }, @@ -5286,7 +5286,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Confirms tracking of the device. This API call is the call that begins device\n tracking. For more information about device authentication, see Working with user devices in your user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nConfirms a device that a user wants to remember. A remembered device is a \"Remember me\n on this device\" option for user pools that perform authentication with the device key of\n a trusted device in the back end, instead of a user-provided MFA code. For more\n information about device authentication, see Working with user devices in your user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe device key.
", + "smithy.api#documentation": "The unique identifier, or device key, of the device that you want to update the status\n for.
", "smithy.api#required": {} } }, @@ -5316,12 +5316,12 @@ "DeviceName": { "target": "com.amazonaws.cognitoidentityprovider#DeviceNameType", "traits": { - "smithy.api#documentation": "The device name.
" + "smithy.api#documentation": "A friendly name for the device, for example MyMobilePhone
.
Confirms the device request.
", + "smithy.api#documentation": "The confirm-device request.
", "smithy.api#input": {} } }, @@ -5332,12 +5332,12 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the user confirmation must confirm the device response.
" + "smithy.api#documentation": "When true
, your user must confirm that they want to remember the device.\n Prompt the user for an answer. You must then make an UpdateUserDevice request that sets the device to\n remembered
or not_remembered
.
When false
, immediately sets the device as remembered and eligible for\n device authentication.
You can configure your user pool to always remember devices, in which case this\n response is false
, or to allow users to opt in, in which case this response\n is true
. Configure this option under Device tracking\n in the Sign-in menu of your user pool. You can also configure this\n option with the DeviceConfiguration parameter of a CreateUserPool or UpdateUserPool request.
Confirms the device response.
", + "smithy.api#documentation": "The confirm-device response.
", "smithy.api#output": {} } }, @@ -5404,7 +5404,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Allows a user to enter a confirmation code to reset a forgotten password.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis public API operation accepts a confirmation code that Amazon Cognito sent to a user and\n accepts a new password for that user.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe app client ID of the app associated with the user pool.
", + "smithy.api#documentation": "The ID of the app client where the user wants to reset their password. This parameter\n is an identifier of the client application that users are resetting their password from,\n but this operation resets users' passwords for all app clients in the user\n pool.
", "smithy.api#required": {} } }, @@ -5434,7 +5434,7 @@ "ConfirmationCode": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmationCodeType", "traits": { - "smithy.api#documentation": "The confirmation code from your user's request to reset their password. For more\n information, see ForgotPassword.
", + "smithy.api#documentation": "The confirmation code that your user pool sent in response to an AdminResetUserPassword or a ForgotPassword request.
", "smithy.api#required": {} } }, @@ -5454,13 +5454,13 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your\n function code in Lambda, you can process the clientMetadata
value to\n enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your\n function code in Lambda, you can process the clientMetadata
value to\n enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
This public API operation provides a code that Amazon Cognito sent to your user when they\n signed up in your user pool via the SignUp\n API operation. After your user enters their code, they confirm ownership of the email\n address or phone number that they provided, and their user account becomes active.\n Depending on your user pool configuration, your users will receive their confirmation\n code in an email or SMS message.
\nLocal users who signed up in your user pool are the only type of user who can confirm\n sign-up with a code. Users who federate through an external identity provider (IdP) have\n already been confirmed by their IdP. Administrator-created users, users created with the\n AdminCreateUser API operation, confirm their accounts when they respond to\n their invitation email message and choose a password. They do not receive a confirmation\n code. Instead, they receive a temporary password.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis public API operation submits a code that Amazon Cognito sent to your user when they signed\n up in your user pool via the SignUp\n API operation. After your user enters their code, they confirm ownership of the email\n address or phone number that they provided, and their user account becomes active.\n Depending on your user pool configuration, your users will receive their confirmation\n code in an email or SMS message.
\nLocal users who signed up in your user pool are the only type of user who can confirm\n sign-up with a code. Users who federate through an external identity provider (IdP) have\n already been confirmed by their IdP. Administrator-created users, users created with the\n AdminCreateUser API operation, confirm their accounts when they respond to\n their invitation email message and choose a password. They do not receive a confirmation\n code. Instead, they receive a temporary password.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash
, see Computing secret hash values.
The confirmation code sent by a user's request to confirm registration.
", + "smithy.api#documentation": "The confirmation code that your user pool sent in response to the SignUp
\n request.
Boolean to be specified to force user confirmation irrespective of existing alias. By\n default set to False
. If this parameter is set to True
and the\n phone number/email used for sign up confirmation already exists as an alias with a\n different user, the API call will migrate the alias from the previous user to the newly\n created user being confirmed. If set to False
, the API will throw an\n AliasExistsException error.
When true
, forces user confirmation despite any existing aliases.\n Defaults to false
. A value of true
migrates the alias from an\n existing user to the new user if an existing user already has the phone number or email\n address as an alias.
Say, for example, that an existing user has an email
attribute of\n bob@example.com
and email is an alias in your user pool. If the new\n user also has an email of bob@example.com
and your\n ConfirmSignUp
response sets ForceAliasCreation
to\n true
, the new user can sign in with a username of\n bob@example.com
and the existing user can no longer do so.
If false
and an attribute belongs to an existing alias, this request\n returns an AliasExistsException error.
For more information about sign-in aliases, see Customizing sign-in attributes.
" } }, "AnalyticsMetadata": { @@ -5584,13 +5584,13 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function\n code in Lambda, you can process the clientMetadata
value to\n enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function\n code in Lambda, you can process the clientMetadata
value to\n enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
You can automatically sign users in with the one-time password that they provided in a\n successful ConfirmSignUp
request. To do this, pass the Session
\n parameter from the ConfirmSignUp
response in the Session
\n parameter of an InitiateAuth or AdminInitiateAuth request.
A session identifier that you can use to immediately sign in the confirmed user. You\n can automatically sign users in with the one-time password that they provided in a\n successful ConfirmSignUp
request. To do this, pass the Session
\n parameter from this response in the Session
parameter of an InitiateAuth or AdminInitiateAuth request.
Creates a new group in the specified user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates a new group in the specified user pool. For more information about user pool\n groups see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe name of the group. Must be unique.
", + "smithy.api#documentation": "A name for the group. This name must be unique in your user pool.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool where you want to create a user group.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.cognitoidentityprovider#DescriptionType", "traits": { - "smithy.api#documentation": "A string containing the description of the group.
" + "smithy.api#documentation": "A description of the group that you're creating.
" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "The role Amazon Resource Name (ARN) for the group.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that you want to associate with the\n group. A group role primarily declares a preferred role for the credentials that you get\n from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role
claim\n that presents the highest-precedence group that a user belongs to. Both ID and access\n tokens also contain a cognito:groups
claim that list all the groups that a\n user is a member of.
The group object for the group.
" + "smithy.api#documentation": "The response object for a created group.
" } } }, @@ -5793,7 +5793,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a configuration and trust relationship between a third-party identity provider\n (IdP) and a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nAdds a configuration and trust relationship between a third-party identity provider\n (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through\n managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The Id of the user pool where you want to create an IdP.
", "smithy.api#required": {} } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameTypeV2", "traits": { - "smithy.api#documentation": "The IdP name.
", + "smithy.api#documentation": "The name that you want to assign to the IdP. You can pass the identity provider name\n in the identity_provider
query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated\n IdP.
The IdP type.
", + "smithy.api#documentation": "The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With\n Amazon, Sign In With Apple, Google, and Facebook IdPs.
", "smithy.api#required": {} } }, @@ -5830,13 +5830,13 @@ "AttributeMapping": { "target": "com.amazonaws.cognitoidentityprovider#AttributeMappingType", "traits": { - "smithy.api#documentation": "A mapping of IdP attributes to standard and custom user pool attributes.
" + "smithy.api#documentation": "A mapping of IdP attributes to standard and custom user pool attributes. Specify a\n user pool attribute as the key of the key-value pair, and the IdP attribute claim name\n as the value.
" } }, "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { - "smithy.api#documentation": "A list of IdP identifiers.
" + "smithy.api#documentation": "An array of IdP identifiers, for example \"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\"\n ]
. Identifiers are friendly names that you can pass in the\n idp_identifier
query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated IdP.\n Identifiers in a domain format also enable the use of email-address matching with SAML providers.
The newly created IdP object.
", + "smithy.api#documentation": "The details of the new user pool IdP.
", "smithy.api#required": {} } } @@ -5894,7 +5894,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new set of branding settings for a user pool style and associates it with an\n app client. This operation is the programmatic option for the creation of a new style in\n the branding designer.
\nProvides values for UI customization in a Settings
JSON object and image\n files in an Assets
array. To send the JSON object Document
\n type parameter in Settings
, you might need to update to the most recent\n version of your Amazon Web Services SDK.
This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.
\nFor more information, see API and SDK operations for managed login branding\n
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates a new set of branding settings for a user pool style and associates it with an\n app client. This operation is the programmatic option for the creation of a new style in\n the branding designer.
\nProvides values for UI customization in a Settings
JSON object and image\n files in an Assets
array. To send the JSON object Document
\n type parameter in Settings
, you might need to update to the most recent\n version of your Amazon Web Services SDK. To create a new style with default settings, set\n UseCognitoProvidedValues
to true
and don't provide\n values for any other options.
This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.
\nAs a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this\n operation. To get all settings, set ReturnMergedResources
to\n true
. For more information, see API and SDK operations for managed login branding.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nWhen true, applies the default branding style options. This option reverts to default\n style options that are managed by Amazon Cognito. You can modify them later in the branding\n designer.
\nWhen you specify true
for this option, you must also omit values for\n Settings
and Assets
in the request.
When true, applies the default branding style options. These default options are\n managed by Amazon Cognito. You can modify them later in the branding designer.
\nWhen you specify true
for this option, you must also omit values for\n Settings
and Assets
in the request.
Creates a new OAuth2.0 resource server and defines custom scopes within it.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates a new OAuth2.0 resource server and defines custom scopes within it. Resource\n servers are associated with custom scopes and machine-to-machine (M2M) authorization.\n For more information, see Access control with resource servers.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool where you want to create a resource server.
", "smithy.api#required": {} } }, @@ -6011,7 +6011,7 @@ "Scopes": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeListType", "traits": { - "smithy.api#documentation": "A list of scopes. Each scope is a key-value map with the keys name
and\n description
.
A list of custom scopes. Each scope is a key-value map with the keys\n ScopeName
and ScopeDescription
. The name of a custom scope\n is a combination of ScopeName
and the resource server Name
in\n this request, for example MyResourceServerName/MyScopeName
.
The newly created resource server.
", + "smithy.api#documentation": "The details of the new resource server.
", "smithy.api#required": {} } } @@ -6066,7 +6066,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a user import job.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates a user import job. You can import users into user pools from a comma-separated\n values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill. To generate a\n template for your import, see GetCSVHeader. To learn more about CSV import, see\n Importing users from a CSV file.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe job name for the user import job.
", + "smithy.api#documentation": "A friendly name for the user import job.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported into.
", + "smithy.api#documentation": "The ID of the user pool that you want to import users into.
", "smithy.api#required": {} } }, "CloudWatchLogsRoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
", + "smithy.api#documentation": "You must specify an IAM role that has permission to log import-job results to\n Amazon CloudWatch Logs. This parameter is the ARN of that role.
", "smithy.api#required": {} } } @@ -6105,7 +6105,7 @@ "UserImportJob": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobType", "traits": { - "smithy.api#documentation": "The job object that represents the user import job.
" + "smithy.api#documentation": "The details of the user import job.
" } } }, @@ -6158,7 +6158,7 @@ } ], "traits": { - "smithy.api#documentation": "This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates a new Amazon Cognito user pool and sets the password policy for the\n pool.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates a new Amazon Cognito user pool. This operation sets basic and advanced configuration\n options. You can create a user pool in the Amazon Cognito console to your preferences and use the\n output of DescribeUserPool to generate requests from that\n baseline.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates the user pool client.
\nWhen you create a new user pool client, token revocation is automatically activated.\n For more information about revoking tokens, see RevokeToken.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates an app client in a user pool. This operation sets basic and advanced\n configuration options. You can create an app client in the Amazon Cognito console to your\n preferences and use the output of DescribeUserPoolClient to generate requests from that\n baseline.
\nNew app clients activate token revocation by default. For more information about\n revoking tokens, see RevokeToken.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool where you want to create a user pool client.
", + "smithy.api#documentation": "The ID of the user pool where you want to create an app client.
", "smithy.api#required": {} } }, "ClientName": { "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", "traits": { - "smithy.api#documentation": "The client name for the user pool client you would like to create.
", + "smithy.api#documentation": "A friendly name for the app client that you want to create.
", "smithy.api#required": {} } }, @@ -6742,7 +6742,7 @@ "target": "com.amazonaws.cognitoidentityprovider#GenerateSecret", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Boolean to specify whether you want to generate a secret for the user pool client\n being created.
" + "smithy.api#documentation": "When true
, generates a client secret for the app client. Client secrets\n are used with server-side and machine-to-machine applications. For more information, see\n App client types.
The units in which the validity times are represented. The default unit for\n RefreshToken is days, and default for ID and access tokens are hours.
" + "smithy.api#documentation": "The units that validity times are represented in. The default unit for refresh tokens\n is days, and the default for ID and access tokens are hours.
" } }, "ReadAttributes": { @@ -6791,25 +6791,25 @@ "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO
, Facebook
,\n Google
, SignInWithApple
, and LoginWithAmazon
.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP
or MyOIDCIdP
.
This setting applies to providers that you can access with the hosted\n UI and OAuth 2.0 authorization server. The removal of COGNITO
\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.
A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO
, Facebook
,\n Google
, SignInWithApple
, and LoginWithAmazon
.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP
or MyOIDCIdP
.
This setting applies to providers that you can access with managed \n login. The removal of COGNITO
\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.
A list of allowed redirect (callback) URLs for the IdPs.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" + "smithy.api#documentation": "A list of allowed redirect (callback) URLs for the IdPs.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server. Amazon Cognito doesn't accept\n authorization requests with redirect_uri
values that aren't in\n the list of CallbackURLs
that you provide in this parameter.
Not include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" } }, "LogoutURLs": { "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", "traits": { - "smithy.api#documentation": "A list of allowed logout URLs for the IdPs.
" + "smithy.api#documentation": "A list of allowed logout URLs for managed login authentication. For more information,\n see Logout endpoint.
" } }, "DefaultRedirectURI": { "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { - "smithy.api#documentation": "The default redirect URI. In app clients with one assigned IdP, replaces\n redirect_uri
in authentication requests. Must be in the\n CallbackURLs
list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nFor more information, see Default redirect URI.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" + "smithy.api#documentation": "The default redirect URI. In app clients with one assigned IdP, replaces\n redirect_uri
in authentication requests. Must be in the\n CallbackURLs
list.
The allowed OAuth scopes. Possible values provided by OAuth are phone
,\n email
, openid
, and profile
. Possible values\n provided by Amazon Web Services are aws.cognito.signin.user.admin
. Custom\n scopes created in Resource Servers are also supported.
The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes\n govern access control to user pool self-service API operations, user data from the\n userInfo
endpoint, and third-party APIs. Possible values provided by\n OAuth are phone
, email
, openid
, and\n profile
. Possible values provided by Amazon Web Services are\n aws.cognito.signin.user.admin
. Custom scopes created in Resource\n Servers are also supported.
The user pool analytics configuration for collecting metrics and sending them to your\n Amazon Pinpoint campaign.
\nIn Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending\n events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is\n available, user pools support sending events to Amazon Pinpoint projects within that same\n Region.
\nThe user pool analytics configuration for collecting metrics and sending them to your\n Amazon Pinpoint campaign.
\nIn Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to\n analytics or might be configurable with campaigns in the US East (N. Virginia) Region.\n For more information, see Using Amazon Pinpoint analytics.
" } }, "PreventUserExistenceErrors": { @@ -6873,7 +6873,7 @@ "UserPoolClient": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientType", "traits": { - "smithy.api#documentation": "The user pool client that was just created.
" + "smithy.api#documentation": "The details of the new app client.
" } } }, @@ -6911,7 +6911,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new domain for a user pool. The domain hosts user pool domain services like\n managed login, the hosted UI (classic), and the user pool authorization server.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nA user pool domain hosts managed login, an authorization server and web server for\n authentication in your application. This operation creates a new user pool prefix or\n custom domain and sets the managed login branding version. Set the branding version to\n 1
for hosted UI (classic) or 2
for managed login. When you\n choose a custom domain, you must provide an SSL certificate in the US East (N. Virginia)\n Amazon Web Services Region in your request.
Your prefix domain might take up to one minute to take effect. Your custom domain is\n online within five minutes, but it can take up to one hour to distribute your SSL\n certificate.
\nFor more information about adding a custom domain to your user pool, see Configuring a user pool domain.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth
.
The domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For prefix domains, this is the prefix alone, such as\n myprefix
. A prefix value of myprefix
for a user pool in\n the us-east-1 Region results in a domain of\n myprefix.auth.us-east-1.amazoncognito.com
.
The version of managed login branding that you want to apply to your domain. A value\n of 1
indicates hosted UI (classic) branding and a version of 2
\n indicates managed login branding.
Managed login requires that your user pool be configured for any feature plan other than Lite
.
The version of managed login branding that you want to apply to your domain. A value\n of 1
indicates hosted UI (classic) and a version of 2
\n indicates managed login.
Managed login requires that your user pool be configured for any feature plan other than Lite
.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.
\nProvide this parameter only if you want to use a custom domain for your user pool.\n Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain\n instead.
\nFor more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
" + "smithy.api#documentation": "The configuration for a custom domain. Configures your domain with an Certificate Manager\n certificate in the us-east-1
Region.
Provide this parameter only if you want to use a custom domain for your user pool.\n Otherwise, you can exclude this parameter and use a prefix domain instead.
\nFor more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
" } } }, @@ -6954,7 +6954,7 @@ "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { - "smithy.api#documentation": "The version of managed login branding applied your domain. A value of 1
\n indicates hosted UI (classic) branding and a version of 2
indicates managed\n login branding.
The version of managed login branding applied your domain. A value of 1
\n indicates hosted UI (classic) and a version of 2
indicates managed\n login.
A string used to name the user pool.
", + "smithy.api#documentation": "A friendlhy name for your user pool.
", "smithy.api#required": {} } }, "Policies": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { - "smithy.api#documentation": "The policies associated with the new user pool.
" + "smithy.api#documentation": "The password policy and sign-in policy in the user pool. The password policy sets\n options like password complexity requirements and password history. The sign-in policy\n sets the options available to applications in choice-based authentication.
" } }, "DeletionProtection": { @@ -6999,19 +6999,19 @@ "AutoVerifiedAttributes": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { - "smithy.api#documentation": "The attributes to be auto-verified. Possible values: email, phone_number.
" + "smithy.api#documentation": "The attributes that you want your user pool to automatically verify. Possible values:\n email, phone_number. For more information see Verifying contact information at sign-up.
" } }, "AliasAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", "traits": { - "smithy.api#documentation": "Attributes supported as an alias for this user pool. Possible values: phone_number, email, or\n preferred_username.
" + "smithy.api#documentation": "Attributes supported as an alias for this user pool. Possible values: phone_number, email, or\n preferred_username. For more information about\n alias attributes, see Customizing sign-in attributes.
" } }, "UsernameAttributes": { "target": "com.amazonaws.cognitoidentityprovider#UsernameAttributesListType", "traits": { - "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when\n they sign up.
" + "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when\n they sign up. For more information, see Customizing sign-in attributes.
" } }, "SmsVerificationMessage": { @@ -7047,7 +7047,7 @@ "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "Specifies MFA configuration details.
" + "smithy.api#documentation": "Sets multi-factor authentication (MFA) to be on, off, or optional. When\n ON
, all users must set up MFA before they can sign in. When\n OPTIONAL
, your application must make a client-side determination of\n whether a user wants to register an MFA device. For user pools with adaptive\n authentication with threat protection, choose OPTIONAL
.
The device-remembering configuration for a user pool. A null value indicates that you\n have deactivated device remembering in your user pool.
\nWhen you provide a value for any DeviceConfiguration
field, you\n activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. Device remembering or device\n tracking is a \"Remember me on this device\" option for user pools that perform\n authentication with the device key of a trusted device in the back end, instead of a\n user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that\n you have deactivated device remembering in your user pool.
\nWhen you provide a value for any DeviceConfiguration
field, you\n activate the Amazon Cognito device-remembering feature. For more infor
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages\n with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management\n (IAM) role in your Amazon Web Services account.
" + "smithy.api#documentation": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages\n with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management\n (IAM) role in your Amazon Web Services account. For more information see SMS message settings.
" } }, "UserPoolTags": { @@ -7083,13 +7083,13 @@ "AdminCreateUserConfig": { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", "traits": { - "smithy.api#documentation": "The configuration for AdminCreateUser
requests.
The configuration for AdminCreateUser requests. Includes the template for the\n invitation message for new users, the duration of temporary passwords, and permitting\n self-service sign-up.
" } }, "Schema": { "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", "traits": { - "smithy.api#documentation": "An array of schema attributes for the new user pool. These attributes can be standard\n or custom attributes.
" + "smithy.api#documentation": "An array of attributes for the new user pool. You can add custom attributes and modify\n the properties of default attributes. The specifications in this parameter set the\n required attributes in your user pool. For more information, see Working with user attributes.
" } }, "UserPoolAddOns": { @@ -7101,7 +7101,7 @@ "UsernameConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { - "smithy.api#documentation": "Case sensitivity on the username input for the selected sign-in option. When case\n sensitivity is set to False
(case insensitive), users can sign in with any\n combination of capital and lowercase letters. For example, username
,\n USERNAME
, or UserName
, or for email,\n email@example.com
or EMaiL@eXamplE.Com
. For most use\n cases, set case sensitivity to False
(case insensitive) as a best practice.\n When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in\n case as the same user, and prevents a case variation from being assigned to the same\n attribute for a different user.
This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
" + "smithy.api#documentation": "Sets the case sensitivity option for sign-in usernames. When\n CaseSensitive
is false
(case insensitive), users can sign\n in with any combination of capital and lowercase letters. For example,\n username
, USERNAME
, or UserName
, or for\n email, email@example.com
or EMaiL@eXamplE.Com
. For most use\n cases, set case sensitivity to false
as a best practice. When usernames and\n email addresses are case insensitive, Amazon Cognito treats any variation in case as the same\n user, and prevents a case variation from being assigned to the same attribute for a\n different user.
When CaseSensitive
is true
(case sensitive), Amazon Cognito\n interprets USERNAME
and UserName
as distinct users.
This configuration is immutable after you set it.
" } }, "AccountRecoverySetting": { @@ -7128,7 +7128,7 @@ "UserPool": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolType", "traits": { - "smithy.api#documentation": "A container for the user pool details.
" + "smithy.api#documentation": "The details of the created user pool.
" } } }, @@ -7286,7 +7286,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a group.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Deletes a group from the specified user pool. When you delete a group, that group no\n longer contributes to users' cognito:preferred_group
or\n cognito:groups
claims, and no longer influence access-control decision\n that are based on group membership. For more information about user pool groups, see\n Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe name of the group.
", + "smithy.api#documentation": "The name of the group that you want to delete.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete the group.
", "smithy.api#required": {} } } @@ -7343,7 +7343,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an IdP for a user pool.
" + "smithy.api#documentation": "Deletes a user pool identity provider (IdP). After you delete an IdP, users can no\n longer sign in to your user pool through that IdP. For more information about user pool\n IdPs, see Third-party IdP sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete the identity provider.
", "smithy.api#required": {} } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "The IdP name.
", + "smithy.api#documentation": "The name of the IdP that you want to delete.
", "smithy.api#required": {} } } @@ -7397,7 +7397,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a managed login branding style. When you delete a style, you delete the\n branding association for an app client and restore it to default settings.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nDeletes a managed login branding style. When you delete a style, you delete the\n branding association for an app client. When an app client doesn't have a style\n assigned, your managed login pages for that app client are nonfunctional until you\n create a new style or switch the domain branding version.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nDeletes a resource server.
" + "smithy.api#documentation": "Deletes a resource server. After you delete a resource server, users can no longer\n generate access tokens with scopes that are associate with that resource server.
\nResource servers are associated with custom scopes and machine-to-machine (M2M)\n authorization. For more information, see Access control with resource servers.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool that hosts the resource server.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete the resource server.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { - "smithy.api#documentation": "The identifier for the resource server.
", + "smithy.api#documentation": "The identifier of the resource server that you want to delete.
", "smithy.api#required": {} } } @@ -7512,7 +7512,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Allows a user to delete their own user profile.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nSelf-deletes a user profile. A deleted user profile can no longer be used to sign in\n and can't be restored.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nDeletes the attributes for a user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nSelf-deletes attributes for a user. For example, your application can submit a request\n to this operation when a user wants to remove their birthdate
attribute\n value.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nAn array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prependattach the custom:
prefix to the\n front of the attribute name.
An array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name, for example custom:department
.
Deletes the specified Amazon Cognito user pool.
" + "smithy.api#documentation": "Deletes a user pool. After you delete a user pool, users can no longer sign in to any\n associated applications.
\n " } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClient": { @@ -7651,7 +7651,7 @@ } ], "traits": { - "smithy.api#documentation": "Allows the developer to delete the user pool client.
" + "smithy.api#documentation": "Deletes a user pool app client. After you delete an app client, users can no longer\n sign in to the associated application.
" } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientRequest": { @@ -7660,14 +7660,14 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool where you want to delete the client.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete the client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "The app client ID of the app associated with the user pool.
", + "smithy.api#documentation": "The ID of the user pool app client that you want to delete.
", "smithy.api#required": {} } } @@ -7700,7 +7700,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a domain for a user pool.
" + "smithy.api#documentation": "Given a user pool ID and domain identifier, deletes a user pool domain. After you\n delete a user pool domain, your managed login pages and authorization server are no\n longer available.
" } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomainRequest": { @@ -7709,14 +7709,14 @@ "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth
.
The domain that you want to delete. For custom domains, this is the fully-qualified\n domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is\n the prefix alone, such as auth
.
The user pool ID.
", + "smithy.api#documentation": "The ID of the user pool where you want to delete the domain.
", "smithy.api#required": {} } } @@ -7738,7 +7738,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool you want to delete.
", + "smithy.api#documentation": "The ID of the user pool that you want to delete.
", "smithy.api#required": {} } } @@ -7791,7 +7791,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Deletes a registered passkey, or webauthN, device for the currently signed-in\n user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Deletes a registered passkey, or webauthN, authenticator for the currently signed-in\n user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the user whose passkey you want to\n delete.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose passkey credential you want\n to delete.
", "smithy.api#required": {} } }, "CredentialId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The unique identifier of the passkey that you want to delete. Look up registered\n devices with ListWebAuthnCredentials.
", + "smithy.api#documentation": "The unique identifier of the passkey that you want to delete. Look up registered\n devices with ListWebAuthnCredentials.
", "smithy.api#required": {} } } @@ -7890,7 +7890,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a specific IdP.
" + "smithy.api#documentation": "Given a user pool ID and identity provider (IdP) name, returns details about the\n IdP.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeIdentityProviderRequest": { @@ -7899,14 +7899,14 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID.
", + "smithy.api#documentation": "The ID of the user pool that has the IdP that you want to describe..
", "smithy.api#required": {} } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "The IdP name.
", + "smithy.api#documentation": "The name of the IdP that you want to describe.
", "smithy.api#required": {} } } @@ -7921,7 +7921,7 @@ "IdentityProvider": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderType", "traits": { - "smithy.api#documentation": "The identity provider details.
", + "smithy.api#documentation": "The details of the requested IdP.
", "smithy.api#required": {} } } @@ -7956,7 +7956,7 @@ } ], "traits": { - "smithy.api#documentation": "When given the ID of a managed login branding style, returns detailed information\n about the style.
" + "smithy.api#documentation": "Given the ID of a managed login branding style, returns detailed information about the\n style.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClient": { @@ -7985,7 +7985,7 @@ } ], "traits": { - "smithy.api#documentation": "When given the ID of a user pool app client, returns detailed information about the\n style assigned to the app client.
" + "smithy.api#documentation": "Given the ID of a user pool app client, returns detailed information about the style\n assigned to the app client.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientRequest": { @@ -8100,7 +8100,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a resource server.
" + "smithy.api#documentation": "Describes a resource server. For more information about resource servers, see Access control with resource servers.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeResourceServerRequest": { @@ -8109,7 +8109,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that hosts the resource server.
", + "smithy.api#documentation": "The ID of the user pool that hosts the resource server.
", "smithy.api#required": {} } }, @@ -8131,7 +8131,7 @@ "ResourceServer": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerType", "traits": { - "smithy.api#documentation": "The resource server.
", + "smithy.api#documentation": "The details of the requested resource server.
", "smithy.api#required": {} } } @@ -8169,7 +8169,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the risk configuration.
" + "smithy.api#documentation": "Given an app client or user pool ID where threat protection is configured, describes\n the risk configuration. This operation returns details about adaptive authentication,\n compromised credentials, and IP-address allow- and denylists. For more information about\n threat protection, see Threat protection.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeRiskConfigurationRequest": { @@ -8178,14 +8178,14 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID.
", + "smithy.api#documentation": "The ID of the user pool with the risk configuration that you want to inspect. You can\n apply default risk configuration at the user pool level and further customize it from\n user pool defaults at the app-client level. Specify ClientId
to inspect\n client-level configuration, or UserPoolId
to inspect pool-level\n configuration.
The app client ID.
" + "smithy.api#documentation": "The ID of the app client with the risk configuration that you want to inspect. You can\n apply default risk configuration at the user pool level and further customize it from\n user pool defaults at the app-client level. Specify ClientId
to inspect\n client-level configuration, or UserPoolId
to inspect pool-level\n configuration.
The risk configuration.
", + "smithy.api#documentation": "The details of the requested risk configuration.
", "smithy.api#required": {} } } @@ -8234,7 +8234,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the user import job.
" + "smithy.api#documentation": "Describes a user import job. For more information about user CSV import, see Importing users from a CSV file.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeUserImportJobRequest": { @@ -8243,14 +8243,14 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported into.
", + "smithy.api#documentation": "The ID of the user pool that's associated with the import job.
", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { - "smithy.api#documentation": "The job ID for the user import job.
", + "smithy.api#documentation": "The Id of the user import job that you want to describe.
", "smithy.api#required": {} } } @@ -8266,7 +8266,7 @@ "UserImportJob": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobType", "traits": { - "smithy.api#documentation": "The job object that represents the user import job.
" + "smithy.api#documentation": "The details of the user import job.
" } } }, @@ -8304,7 +8304,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the configuration information and metadata of the specified user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven a user pool ID, returns configuration information. This operation is useful when\n you want to inspect an existing user pool and programmatically replicate the\n configuration to another user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nClient method for returning the configuration information and metadata of the\n specified user pool app client.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven an app client ID, returns configuration information. This operation is useful\n when you want to inspect an existing app client and programmatically replicate the\n configuration to another app client. For more information about app clients, see App clients.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool you want to describe.
", + "smithy.api#documentation": "The ID of the user pool that contains the app client you want to describe.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "The app client ID of the app associated with the user pool.
", + "smithy.api#documentation": "The ID of the app client that you want to describe.
", "smithy.api#required": {} } } @@ -8365,7 +8365,7 @@ "UserPoolClient": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientType", "traits": { - "smithy.api#documentation": "The user pool client from a server response to describe the user pool client.
" + "smithy.api#documentation": "The details of the request app client.
" } } }, @@ -8397,7 +8397,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a domain.
" + "smithy.api#documentation": "Given a user pool domain name, returns information about the domain\n configuration.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth
.
The domain that you want to describe. For custom domains, this is the fully-qualified\n domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is\n the prefix alone, such as auth
.
A domain description object containing information about the domain.
" + "smithy.api#documentation": "The details of the requested user pool domain.
" } } }, @@ -8435,7 +8435,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool you want to describe.
", + "smithy.api#documentation": "The ID of the user pool you want to describe.
", "smithy.api#required": {} } } @@ -8451,7 +8451,7 @@ "UserPool": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolType", "traits": { - "smithy.api#documentation": "The container of metadata returned by the server to describe the pool.
" + "smithy.api#documentation": "The details of the requested user pool.
" } } }, @@ -8783,13 +8783,13 @@ "Message": { "target": "com.amazonaws.cognitoidentityprovider#EmailMfaMessageType", "traits": { - "smithy.api#documentation": "The template for the email message that your user pool sends to users with an MFA\n code. The message must contain the {####}
placeholder. In the message,\n Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter,\n Amazon Cognito sends messages in the default format.
The template for the email message that your user pool sends to users with a code for\n MFA and sign-in with an email OTP. The message must contain the {####}
\n placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you\n don't provide this parameter, Amazon Cognito sends messages in the default format.
The subject of the email message that your user pool sends to users with an MFA\n code.
" + "smithy.api#documentation": "The subject of the email message that your user pool sends to users with a code for\n MFA and email OTP sign-in.
" } } }, @@ -9420,13 +9420,13 @@ "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { - "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash
, see Computing secret hash values.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Username": { @@ -9445,7 +9445,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: pre sign-up,\n custom message, and user migration. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your ForgotPassword request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: pre sign-up,\n custom message, and user migration. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your ForgotPassword request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The user pool ID for the user pool that the users are to be imported into.
", + "smithy.api#documentation": "The ID of the user pool that the users are to be imported into.
", "smithy.api#required": {} } } @@ -9526,7 +9526,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are to be imported into.
" + "smithy.api#documentation": "The ID of the user pool that the users are to be imported into.
" } }, "CSVHeader": { @@ -9667,7 +9667,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } } @@ -9903,7 +9903,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } }, @@ -10063,7 +10063,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes\n the function that is assigned to the custom message trigger. When\n Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata
attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your\n GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for\n your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes\n the function that is assigned to the custom message trigger. When\n Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata
attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your\n GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for\n your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call\n this operation when your user signs out of your app. This results in the following\n behavior.
\nAmazon Cognito no longer accepts token-authorized user operations\n that you authorize with a signed-out user's access tokens. For more information,\n see Using the Amazon Cognito user pools API and user pool\n endpoints.
\nAmazon Cognito returns an Access Token has been revoked
error when your\n app attempts to authorize a user pools API request with a revoked access token\n that contains the scope aws.cognito.signin.user.admin
.
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with\n ServerSideTokenCheck
enabled for its user pool IdP\n configuration in CognitoIdentityProvider.
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh\n requests.
\nOther requests might be valid until your user's token expires.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nInvalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call\n this operation when your user signs out of your app. This results in the following\n behavior.
\nAmazon Cognito no longer accepts token-authorized user operations\n that you authorize with a signed-out user's access tokens. For more information,\n see Using the Amazon Cognito user pools API and user pool\n endpoints.
\nAmazon Cognito returns an Access Token has been revoked
error when your\n app attempts to authorize a user pools API request with a revoked access token\n that contains the scope aws.cognito.signin.user.admin
.
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with\n ServerSideTokenCheck
enabled for its user pool IdP\n configuration in CognitoIdentityProvider.
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh\n requests.
\nOther requests might be valid until your user's token expires. This operation\n doesn't clear the managed login session cookie. To clear the session for\n a user who signed in with managed login or the classic hosted UI, direct their browser\n session to the logout endpoint.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe authentication flow that you want to initiate. The AuthParameters
\n that you must submit are linked to the flow that you submit. For example:
\n USER_AUTH
: Request a preferred authentication type or review\n available authentication types. From the offered authentication types, select\n one in a challenge response and then authenticate with that method in an\n additional challenge response.
\n REFRESH_TOKEN_AUTH
: Receive new ID and access tokens when you\n pass a REFRESH_TOKEN
parameter with a valid refresh token as the\n value.
\n USER_SRP_AUTH
: Receive secure remote password (SRP) variables for\n the next challenge, PASSWORD_VERIFIER
, when you pass\n USERNAME
and SRP_A
parameters.
\n USER_PASSWORD_AUTH
: Receive new tokens or the next challenge, for\n example SOFTWARE_TOKEN_MFA
, when you pass USERNAME
and\n PASSWORD
parameters.
Valid values include the following:
\nThe entry point for sign-in with passwords, one-time passwords, biometric\n devices, and security keys.
\nUsername-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.
\nProvide a valid refresh token and receive new ID and access tokens. For\n more information, see Using the refresh token.
\nCustom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.
\nUsername-password authentication with the password sent directly in the\n request. For more information, see Admin authentication flow.
\n\n ADMIN_USER_PASSWORD_AUTH
is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth.\n ADMIN_NO_SRP_AUTH
is a legacy server-side username-password flow and\n isn't valid for InitiateAuth.
The authentication flow that you want to initiate. Each AuthFlow
has\n linked AuthParameters
that you must submit. The following are some example\n flows and their parameters.
\n USER_AUTH
: Request a preferred authentication type or review\n available authentication types. From the offered authentication types, select\n one in a challenge response and then authenticate with that method in an\n additional challenge response.
\n REFRESH_TOKEN_AUTH
: Receive new ID and access tokens when you\n pass a REFRESH_TOKEN
parameter with a valid refresh token as the\n value.
\n USER_SRP_AUTH
: Receive secure remote password (SRP) variables for\n the next challenge, PASSWORD_VERIFIER
, when you pass\n USERNAME
and SRP_A
parameters.
\n USER_PASSWORD_AUTH
: Receive new tokens or the next challenge, for\n example SOFTWARE_TOKEN_MFA
, when you pass USERNAME
and\n PASSWORD
parameters.
\n All flows\n
\nThe entry point for sign-in with passwords, one-time passwords, and\n WebAuthN authenticators.
\nUsername-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.
\nProvide a valid refresh token and receive new ID and access tokens. For\n more information, see Using the refresh token.
\nCustom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.
\nUsername-password authentication with the password sent directly in the\n request. For more information, see Admin authentication flow.
\n\n ADMIN_USER_PASSWORD_AUTH
is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth.\n ADMIN_NO_SRP_AUTH
is a legacy server-side username-password flow and\n isn't valid for InitiateAuth.
A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are\n specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your InitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the\n following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nCustom email sender
\nCustom SMS sender
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are\n specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your InitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the\n following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nCustom email sender
\nCustom SMS sender
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Session": { @@ -11220,7 +11220,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } }, @@ -11409,7 +11409,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } }, @@ -11544,7 +11544,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported into.
", + "smithy.api#documentation": "The ID of the user pool that the users are being imported into.
", "smithy.api#required": {} } }, @@ -11629,7 +11629,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool where you want to list user pool clients.
", + "smithy.api#documentation": "The ID of the user pool where you want to list user pool clients.
", "smithy.api#required": {} } }, @@ -11907,7 +11907,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } }, @@ -11961,7 +11961,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool on which the search should be performed.
", + "smithy.api#documentation": "The ID of the user pool on which the search should be performed.
", "smithy.api#required": {} } }, @@ -12281,7 +12281,7 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When true, applies the default branding style options. This option reverts to a\n \"blank\" style that you can modify later in the branding designer.
" + "smithy.api#documentation": "When true, applies the default branding style options. This option reverts to default\n style options that are managed by Amazon Cognito. You can modify them later in the branding\n designer.
\nWhen you specify true
for this option, you must also omit values for\n Settings
and Assets
in the request.
A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash
, see Computing secret hash values.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Username": { @@ -13072,7 +13072,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is\n assigned to the custom message trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your\n function code in Lambda, you can process the clientMetadata
value to enhance\n your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is\n assigned to the custom message trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your\n function code in Lambda, you can process the clientMetadata
value to enhance\n your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: post\n authentication, pre token generation,\n define auth challenge, create auth\n challenge, and verify auth challenge. When Amazon Cognito\n invokes any of these functions, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata
attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge\n request. In your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: post\n authentication, pre token generation,\n define auth challenge, create auth\n challenge, and verify auth challenge. When Amazon Cognito\n invokes any of these functions, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata
attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge\n request. In your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } }, @@ -14071,7 +14071,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Set the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nSet the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.
\nThis operation doesn't reset an existing TOTP MFA for a user. To register a new\n TOTP factor for a user, make an AssociateSoftwareToken request. For more information,\n see TOTP software token MFA.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin
.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash
, see Computing secret hash values.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
" + "smithy.api#documentation": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the\n following triggers: pre sign-up, custom\n message, and post confirmation. When Amazon Cognito invokes\n any of these functions, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata
attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your SignUp request. In your\n function code in Lambda, you can process the clientMetadata
value to enhance\n your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the\n following triggers: pre sign-up, custom\n message, and post confirmation. When Amazon Cognito invokes\n any of these functions, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata
attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your SignUp request. In your\n function code in Lambda, you can process the clientMetadata
value to enhance\n your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The user pool ID for the user pool that the users are being imported into.
", + "smithy.api#documentation": "The ID of the user pool that the users are being imported into.
", "smithy.api#required": {} } }, @@ -14824,7 +14824,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported into.
", + "smithy.api#documentation": "The ID of the user pool that the users are being imported into.
", "smithy.api#required": {} } }, @@ -15488,7 +15488,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } }, @@ -15648,7 +15648,7 @@ } ], "traits": { - "smithy.api#documentation": "Configures the branding settings for a user pool style. This operation is the\n programmatic option for the configuration of a style in the branding designer.
\nProvides values for UI customization in a Settings
JSON object and image\n files in an Assets
array.
This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.
\nFor more information, see API and SDK operations for managed login branding.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nConfigures the branding settings for a user pool style. This operation is the\n programmatic option for the configuration of a style in the branding designer.
\nProvides values for UI customization in a Settings
JSON object and image\n files in an Assets
array.
This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.
\nAs a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this\n operation. To get all settings, set ReturnMergedResources
to\n true
. For more information, see API and SDK operations for managed login branding\n
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool.
", + "smithy.api#documentation": "The ID of the user pool.
", "smithy.api#required": {} } }, @@ -15876,7 +15876,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action initiates.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When\n you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned\n to the custom message trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n clientMetadata
attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your UpdateUserAttributes request. In your function code\n in Lambda, you can process the clientMetadata
value to enhance your workflow\n for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action initiates.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When\n you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned\n to the custom message trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n clientMetadata
attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your UpdateUserAttributes request. In your function code\n in Lambda, you can process the clientMetadata
value to enhance your workflow\n for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata
parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata
value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata
parameter serves no purpose.
Validate the ClientMetadata
value.
Encrypt the ClientMetadata
value. Don't send sensitive\n information in this parameter.
The user pool ID for the user pool where you want to update the user pool\n client.
", + "smithy.api#documentation": "The ID of the user pool where you want to update the user pool client.
", "smithy.api#required": {} } }, @@ -16060,7 +16060,7 @@ "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO
, Facebook
,\n Google
, SignInWithApple
, and LoginWithAmazon
.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP
or MyOIDCIdP
.
This setting applies to providers that you can access with the hosted\n UI and OAuth 2.0 authorization server. The removal of COGNITO
\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.
A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO
, Facebook
,\n Google
, SignInWithApple
, and LoginWithAmazon
.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP
or MyOIDCIdP
.
This setting applies to providers that you can access with managed \n login. The removal of COGNITO
\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user\n pool.
\nYou can use this operation to provide the Amazon Resource Name (ARN) of a new\n certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
\nA custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and\n sign-in pages for your application. When you set up a custom domain, you provide a\n certificate that you manage with Certificate Manager (ACM). When necessary, you can use this\n operation to change the certificate that you applied to your custom domain.
\nUsually, this is unnecessary following routine certificate renewal with ACM. When\n you renew your existing certificate in ACM, the ARN for your certificate remains the\n same, and your custom domain uses the new certificate automatically.
\nHowever, if you replace your existing certificate with a new one, ACM gives the new\n certificate a new ARN. To apply the new certificate to your custom domain, you must\n provide this ARN to Amazon Cognito.
\nWhen you add your new certificate in ACM, you must choose US East (N. Virginia) as\n the Amazon Web Services Region.
\nAfter you submit your request, Amazon Cognito requires up to 1 hour to distribute your new\n certificate to your custom domain.
\nFor more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nA user pool domain hosts managed login, an authorization server and web server for\n authentication in your application. This operation updates the branding version for user\n pool domains between 1
for hosted UI (classic) and 2
for\n managed login. It also updates the SSL certificate for user pool custom domains.
Changes to the domain branding version take up to one minute to take effect for a\n prefix domain and up to five minutes for a custom domain.
\nThis operation doesn't change the name of your user pool domain. To change your\n domain, delete it with DeleteUserPoolDomain
and create a new domain with\n CreateUserPoolDomain
.
You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM\n certificates automatically renew and you user pool can continue to use the same ARN. But\n if you generate a new certificate for your custom domain name, replace the original\n configuration with the new ARN in this request.
\nACM certificates for custom domains must be in the US East (N. Virginia)\n Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute\n your new certificate to your custom domain.
\nFor more information about adding a custom domain to your user pool, see Configuring a user pool domain.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe user pool ID for the user pool you want to update.
", + "smithy.api#documentation": "The ID of the user pool you want to update.
", "smithy.api#required": {} } }, @@ -16822,7 +16822,7 @@ "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO
, Facebook
,\n Google
, SignInWithApple
, and LoginWithAmazon
.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP
or MyOIDCIdP
.
This setting applies to providers that you can access with the hosted\n UI and OAuth 2.0 authorization server. The removal of COGNITO
\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.
A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO
, Facebook
,\n Google
, SignInWithApple
, and LoginWithAmazon
.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP
or MyOIDCIdP
.
This setting applies to providers that you can access with managed \n login. The removal of COGNITO
\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.
Sets or displays your user-pool treatment for MFA with a passkey. You can override\n other MFA options and require passkey MFA, or you can set it as preferred. When passkey\n MFA is preferred, the hosted UI encourages users to register a passkey at\n sign-in.
" + "smithy.api#documentation": "When required
, users can only register and sign in users with passkeys\n that are capable of user\n verification. When preferred
, your user pool doesn't\n require the use of authenticators with user verification but encourages it.
For example, AWS::Organizations::Policy::SERVICE_CONTROL_POLICY
* or
* AWS::CloudFormation::Type::HOOK
have the format with four segments.
Although the format is similar, the values for the Type
field do not match any Amazon Web Services CloudFormation values, and we do not use CloudFormation to implement these controls.
Although the format is similar, the values for the Type
field do not match any Amazon Web Services CloudFormation values.
An object that describes the implementation type for a control.
\nOur ImplementationDetails
\n Type
format has three required segments:
\n SERVICE-PROVIDER::SERVICE-NAME::RESOURCE-NAME
\n
For example, AWS::Config::ConfigRule
\n or\n AWS::SecurityHub::SecurityControl
resources have the format with three required segments.
Our ImplementationDetails
\n Type
format has an optional fourth segment, which is present for applicable \n implementation types. The format is as follows:
\n SERVICE-PROVIDER::SERVICE-NAME::RESOURCE-NAME::RESOURCE-TYPE-DESCRIPTION
\n
For example, AWS::Organizations::Policy::SERVICE_CONTROL_POLICY
\n or\n AWS::CloudFormation::Type::HOOK
have the format with four segments.
Although the format is similar, the values for the Type
field do not match any Amazon Web Services CloudFormation values, and we do not use CloudFormation to implement these controls.
An object that describes the implementation type for a control.
\nOur ImplementationDetails
\n Type
format has three required segments:
\n SERVICE-PROVIDER::SERVICE-NAME::RESOURCE-NAME
\n
For example, AWS::Config::ConfigRule
\n or\n AWS::SecurityHub::SecurityControl
resources have the format with three required segments.
Our ImplementationDetails
\n Type
format has an optional fourth segment, which is present for applicable \n implementation types. The format is as follows:
\n SERVICE-PROVIDER::SERVICE-NAME::RESOURCE-NAME::RESOURCE-TYPE-DESCRIPTION
\n
For example, AWS::Organizations::Policy::SERVICE_CONTROL_POLICY
\n or\n AWS::CloudFormation::Type::HOOK
have the format with four segments.
Although the format is similar, the values for the Type
field do not match any Amazon Web Services CloudFormation values.
Allows access to system profile logs for Lake Formation-enabled jobs. Default is false.
+ * @public + */ + accessSystemProfileLogs?: boolean | undefined; } /** diff --git a/clients/client-emr-serverless/src/protocols/Aws_restJson1.ts b/clients/client-emr-serverless/src/protocols/Aws_restJson1.ts index 86a150f2d5a0..e94d8bb9b1a2 100644 --- a/clients/client-emr-serverless/src/protocols/Aws_restJson1.ts +++ b/clients/client-emr-serverless/src/protocols/Aws_restJson1.ts @@ -193,6 +193,7 @@ export const se_GetDashboardForJobRunCommand = async ( b.p("jobRunId", () => input.jobRunId!, "{jobRunId}", false); const query: any = map({ [_a]: [() => input.attempt !== void 0, () => input[_a]!.toString()], + [_aSPL]: [() => input.accessSystemProfileLogs !== void 0, () => input[_aSPL]!.toString()], }); let body: any; b.m("GET").h(headers).q(query).b(body); @@ -1273,6 +1274,7 @@ const collectBodyString = (streamBody: any, context: __SerdeContext): PromiseAn optimal parameter that indicates the amount of attempts for the job. If not specified,\n this value defaults to the attempt of the latest job.
", "smithy.api#httpQuery": "attempt" } + }, + "accessSystemProfileLogs": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Allows access to system profile logs for Lake Formation-enabled jobs. Default is false.
", + "smithy.api#httpQuery": "accessSystemProfileLogs" + } } } }, @@ -1944,7 +1951,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "^([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$" + "smithy.api#pattern": "^([0-9]{12})\\.dkr\\.ecr\\.([a-z0-9-]+).([a-z0-9._-]+)\\/((?:[a-z0-9]+(?:[-._][a-z0-9]+)*/)*[a-z0-9]+(?:[-._][a-z0-9]+)*)(?::([a-zA-Z0-9_]+[a-zA-Z0-9-._]*)|@(sha256:[0-9a-f]{64}))$" } }, "com.amazonaws.emrserverless#InitScriptPath": { From 5c0fbe3ea37d1625ba8382ab0ee426536f236ba7 Mon Sep 17 00:00:00 2001 From: awstoolsList active customer-agreements applicable to calling identity.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ArtifactClient, ListCustomerAgreementsCommand } from "@aws-sdk/client-artifact"; // ES Modules import + * // const { ArtifactClient, ListCustomerAgreementsCommand } = require("@aws-sdk/client-artifact"); // CommonJS import + * const client = new ArtifactClient(config); + * const input = { // ListCustomerAgreementsRequest + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new ListCustomerAgreementsCommand(input); + * const response = await client.send(command); + * // { // ListCustomerAgreementsResponse + * // customerAgreements: [ // CustomerAgreementList // required + * // { // CustomerAgreementSummary + * // name: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // id: "STRING_VALUE", + * // agreementArn: "STRING_VALUE", + * // awsAccountId: "STRING_VALUE", + * // organizationArn: "STRING_VALUE", + * // effectiveStart: new Date("TIMESTAMP"), + * // effectiveEnd: new Date("TIMESTAMP"), + * // state: "ACTIVE" || "CUSTOMER_TERMINATED" || "AWS_TERMINATED", + * // description: "STRING_VALUE", + * // acceptanceTerms: [ // AgreementTerms + * // "STRING_VALUE", + * // ], + * // terminateTerms: [ + * // "STRING_VALUE", + * // ], + * // type: "CUSTOM" || "DEFAULT" || "MODIFIED", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListCustomerAgreementsCommandInput - {@link ListCustomerAgreementsCommandInput} + * @returns {@link ListCustomerAgreementsCommandOutput} + * @see {@link ListCustomerAgreementsCommandInput} for command's `input` shape. + * @see {@link ListCustomerAgreementsCommandOutput} for command's `response` shape. + * @see {@link ArtifactClientResolvedConfig | config} for ArtifactClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *User does not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *An unknown server exception has occurred.
+ * + * @throws {@link ThrottlingException} (client fault) + *Request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *Request fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link ArtifactServiceException} + *Base exception class for all service exceptions from Artifact service.
+ * + * @public + */ +export class ListCustomerAgreementsCommand extends $Command + .classBuilder< + ListCustomerAgreementsCommandInput, + ListCustomerAgreementsCommandOutput, + ArtifactClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ArtifactClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Artifact", "ListCustomerAgreements", {}) + .n("ArtifactClient", "ListCustomerAgreementsCommand") + .f(void 0, void 0) + .ser(se_ListCustomerAgreementsCommand) + .de(de_ListCustomerAgreementsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListCustomerAgreementsRequest; + output: ListCustomerAgreementsResponse; + }; + sdk: { + input: ListCustomerAgreementsCommandInput; + output: ListCustomerAgreementsCommandOutput; + }; + }; +} diff --git a/clients/client-artifact/src/commands/ListReportsCommand.ts b/clients/client-artifact/src/commands/ListReportsCommand.ts index 2c6a48073f3d..0b86abc444ce 100644 --- a/clients/client-artifact/src/commands/ListReportsCommand.ts +++ b/clients/client-artifact/src/commands/ListReportsCommand.ts @@ -46,10 +46,10 @@ export interface ListReportsCommandOutput extends ListReportsResponse, __Metadat * // { // ReportSummary * // id: "STRING_VALUE", * // name: "STRING_VALUE", - * // state: "STRING_VALUE", + * // state: "PUBLISHED" || "UNPUBLISHED", * // arn: "STRING_VALUE", * // version: Number("long"), - * // uploadState: "STRING_VALUE", + * // uploadState: "PROCESSING" || "COMPLETE" || "FAILED" || "FAULT", * // description: "STRING_VALUE", * // periodStart: new Date("TIMESTAMP"), * // periodEnd: new Date("TIMESTAMP"), @@ -58,7 +58,7 @@ export interface ListReportsCommandOutput extends ListReportsResponse, __Metadat * // companyName: "STRING_VALUE", * // productName: "STRING_VALUE", * // statusMessage: "STRING_VALUE", - * // acceptanceType: "STRING_VALUE", + * // acceptanceType: "PASSTHROUGH" || "EXPLICIT", * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-artifact/src/commands/PutAccountSettingsCommand.ts b/clients/client-artifact/src/commands/PutAccountSettingsCommand.ts index d2b502ff38a9..d059b06153f2 100644 --- a/clients/client-artifact/src/commands/PutAccountSettingsCommand.ts +++ b/clients/client-artifact/src/commands/PutAccountSettingsCommand.ts @@ -36,13 +36,13 @@ export interface PutAccountSettingsCommandOutput extends PutAccountSettingsRespo * // const { ArtifactClient, PutAccountSettingsCommand } = require("@aws-sdk/client-artifact"); // CommonJS import * const client = new ArtifactClient(config); * const input = { // PutAccountSettingsRequest - * notificationSubscriptionStatus: "STRING_VALUE", + * notificationSubscriptionStatus: "SUBSCRIBED" || "NOT_SUBSCRIBED", * }; * const command = new PutAccountSettingsCommand(input); * const response = await client.send(command); * // { // PutAccountSettingsResponse * // accountSettings: { // AccountSettings - * // notificationSubscriptionStatus: "STRING_VALUE", + * // notificationSubscriptionStatus: "SUBSCRIBED" || "NOT_SUBSCRIBED", * // }, * // }; * diff --git a/clients/client-artifact/src/commands/index.ts b/clients/client-artifact/src/commands/index.ts index 20b7ea43f2ba..4a46872c9969 100644 --- a/clients/client-artifact/src/commands/index.ts +++ b/clients/client-artifact/src/commands/index.ts @@ -3,5 +3,6 @@ export * from "./GetAccountSettingsCommand"; export * from "./GetReportCommand"; export * from "./GetReportMetadataCommand"; export * from "./GetTermForReportCommand"; +export * from "./ListCustomerAgreementsCommand"; export * from "./ListReportsCommand"; export * from "./PutAccountSettingsCommand"; diff --git a/clients/client-artifact/src/models/models_0.ts b/clients/client-artifact/src/models/models_0.ts index c72171b0c875..034fbb2bfe84 100644 --- a/clients/client-artifact/src/models/models_0.ts +++ b/clients/client-artifact/src/models/models_0.ts @@ -9,14 +9,13 @@ import { ArtifactServiceException as __BaseException } from "./ArtifactServiceEx */ export const AcceptanceType = { /** - * Require explicit click-through acceptance of - * the Term associated with this Report. + * Require explicit click-through acceptance of the + * Term associated with this Report. */ EXPLICIT: "EXPLICIT", /** - * Do not require explicit click-through - * acceptance of the Term associated with - * this Report. + * Do not require explicit click-through acceptance + * of the Term associated with this Report */ PASSTHROUGH: "PASSTHROUGH", } as const; @@ -51,13 +50,7 @@ export class AccessDeniedException extends __BaseException { * @enum */ export const NotificationSubscriptionStatus = { - /** - * The account is not subscribed for notification. - */ NOT_SUBSCRIBED: "NOT_SUBSCRIBED", - /** - * The account is subscribed for notification. - */ SUBSCRIBED: "SUBSCRIBED", } as const; @@ -374,6 +367,154 @@ export interface PutAccountSettingsResponse { accountSettings?: AccountSettings | undefined; } +/** + * @public + * @enum + */ +export const AgreementType = { + CUSTOM: "CUSTOM", + DEFAULT: "DEFAULT", + MODIFIED: "MODIFIED", +} as const; + +/** + * @public + */ +export type AgreementType = (typeof AgreementType)[keyof typeof AgreementType]; + +/** + * @public + */ +export interface ListCustomerAgreementsRequest { + /** + *Maximum number of resources to return in the paginated response.
+ * @public + */ + maxResults?: number | undefined; + + /** + *Pagination token to request the next page of resources.
+ * @public + */ + nextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const CustomerAgreementState = { + ACTIVE: "ACTIVE", + AWS_TERMINATED: "AWS_TERMINATED", + CUSTOMER_TERMINATED: "CUSTOMER_TERMINATED", +} as const; + +/** + * @public + */ +export type CustomerAgreementState = (typeof CustomerAgreementState)[keyof typeof CustomerAgreementState]; + +/** + *Summary for customer-agreement resource.
+ * @public + */ +export interface CustomerAgreementSummary { + /** + *Name of the customer-agreement resource.
+ * @public + */ + name?: string | undefined; + + /** + *ARN of the customer-agreement resource.
+ * @public + */ + arn?: string | undefined; + + /** + *Identifier of the customer-agreement resource.
+ * @public + */ + id?: string | undefined; + + /** + *ARN of the agreement resource the customer-agreement resource represents.
+ * @public + */ + agreementArn?: string | undefined; + + /** + *AWS account Id that owns the resource.
+ * @public + */ + awsAccountId?: string | undefined; + + /** + *ARN of the organization that owns the resource.
+ * @public + */ + organizationArn?: string | undefined; + + /** + *Timestamp indicating when the agreement became effective.
+ * @public + */ + effectiveStart?: Date | undefined; + + /** + *Timestamp indicating when the agreement was terminated.
+ * @public + */ + effectiveEnd?: Date | undefined; + + /** + *State of the resource.
+ * @public + */ + state?: CustomerAgreementState | undefined; + + /** + *Description of the resource.
+ * @public + */ + description?: string | undefined; + + /** + *Terms required to accept the agreement resource.
+ * @public + */ + acceptanceTerms?: string[] | undefined; + + /** + *Terms required to terminate the customer-agreement resource.
+ * @public + */ + terminateTerms?: string[] | undefined; + + /** + *Type of the customer-agreement resource.
+ * @public + */ + type?: AgreementType | undefined; +} + +/** + * @public + */ +export interface ListCustomerAgreementsResponse { + /** + *List of customer-agreement resources.
+ * @public + */ + customerAgreements: CustomerAgreementSummary[] | undefined; + + /** + *Pagination token to request the next page of resources.
+ * @public + */ + nextToken?: string | undefined; +} + /** * @public */ @@ -430,13 +571,7 @@ export interface GetReportMetadataRequest { * @enum */ export const PublishedState = { - /** - * The resource is published for consumption. - */ PUBLISHED: "PUBLISHED", - /** - * The resource is not published for consumption. - */ UNPUBLISHED: "UNPUBLISHED", } as const; diff --git a/clients/client-artifact/src/pagination/ListCustomerAgreementsPaginator.ts b/clients/client-artifact/src/pagination/ListCustomerAgreementsPaginator.ts new file mode 100644 index 000000000000..4b2c5b43b377 --- /dev/null +++ b/clients/client-artifact/src/pagination/ListCustomerAgreementsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { ArtifactClient } from "../ArtifactClient"; +import { + ListCustomerAgreementsCommand, + ListCustomerAgreementsCommandInput, + ListCustomerAgreementsCommandOutput, +} from "../commands/ListCustomerAgreementsCommand"; +import { ArtifactPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListCustomerAgreements: ( + config: ArtifactPaginationConfiguration, + input: ListCustomerAgreementsCommandInput, + ...rest: any[] +) => PaginatorName of the customer-agreement resource.
" + } + }, + "arn": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "ARN of the customer-agreement resource.
" + } + }, + "id": { + "target": "com.amazonaws.artifact#CustomerAgreementIdAttribute", + "traits": { + "smithy.api#documentation": "Identifier of the customer-agreement resource.
" + } + }, + "agreementArn": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "ARN of the agreement resource the customer-agreement resource represents.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "AWS account Id that owns the resource.
" + } + }, + "organizationArn": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "ARN of the organization that owns the resource.
" + } + }, + "effectiveStart": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating when the agreement became effective.
" + } + }, + "effectiveEnd": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating when the agreement was terminated.
" + } + }, + "state": { + "target": "com.amazonaws.artifact#CustomerAgreementState", + "traits": { + "smithy.api#documentation": "State of the resource.
" + } + }, + "description": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "Description of the resource.
" + } + }, + "acceptanceTerms": { + "target": "com.amazonaws.artifact#AgreementTerms", + "traits": { + "smithy.api#documentation": "Terms required to accept the agreement resource.
" + } + }, + "terminateTerms": { + "target": "com.amazonaws.artifact#AgreementTerms", + "traits": { + "smithy.api#documentation": "Terms required to terminate the customer-agreement resource.
" + } + }, + "type": { + "target": "com.amazonaws.artifact#AgreementType", + "traits": { + "smithy.api#documentation": "Type of the customer-agreement resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary for customer-agreement resource.
" + } + }, "com.amazonaws.artifact#GetAccountSettings": { "type": "operation", "input": { @@ -890,8 +1058,8 @@ "title": "Invoke GetReport operation on the latest version of a specific report", "documentation": "The GetReport operation is invoked on a reportId and on a optional version.\n Callers must provide a termToken, which is provided by the GetTermForReport\n operation. If callers do not provide a version, it will default to the\n report's latest version", "input": { - "reportId": "report-1hVFddebtfDNJAUf", - "termToken": "term-token-gPFEGk7CF4wS901w7ppYclt7" + "reportId": "report-abcdef0123456789", + "termToken": "term-token-abcdefghijklm01234567890" }, "output": { "documentPresignedUrl": "List active customer-agreements applicable to calling identity.
", + "smithy.api#examples": [ + { + "title": "Invoke ListCustomerAgreements operation", + "documentation": "The ListCustomerAgreements operation returns a collection of customer-agreement resources in the ACTIVE state for the calling credential.", + "input": {}, + "output": { + "customerAgreements": [ + { + "name": "Name of agreement", + "arn": "arn:aws:artifact::111111111111:customer-agreement/customer-agreement-abcdef0123456789", + "id": "customer-agreement-abcdef0123456789", + "agreementArn": "arn:aws:artifact:::agreement/agreement-abcdef0123456789", + "awsAccountId": "111111111111", + "description": "Description of agreement", + "effectiveStart": "2022-04-01T20:32:04Z", + "type": "DEFAULT", + "state": "ACTIVE", + "acceptanceTerms": ["terms acknowledged when agreement was accepted"], + "terminateTerms": ["terms that must be acknowledged to terminate this agreement"] + } + ], + "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v1/customer-agreement/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "customerAgreements" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.artifact#ListCustomerAgreementsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.artifact#MaxResultsAttribute", + "traits": { + "smithy.api#documentation": "Maximum number of resources to return in the paginated response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.artifact#NextTokenAttribute", + "traits": { + "smithy.api#documentation": "Pagination token to request the next page of resources.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.artifact#ListCustomerAgreementsResponse": { + "type": "structure", + "members": { + "customerAgreements": { + "target": "com.amazonaws.artifact#CustomerAgreementList", + "traits": { + "smithy.api#documentation": "List of customer-agreement resources.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.artifact#NextTokenAttribute", + "traits": { + "smithy.api#documentation": "Pagination token to request the next page of resources.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.artifact#ListReports": { "type": "operation", "input": { @@ -1220,11 +1494,11 @@ "output": { "reports": [ { - "arn": "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb", + "arn": "arn:aws:artifact:us-east-1::report/report-abcdef0123456789", "category": "Artifact Category", "companyName": "AWS", "description": "Description of report", - "id": "report-bqhUJF3FrQZsMJpb", + "id": "report-abcdef0123456789", "name": "Name of report", "periodEnd": "2022-04-01T20:32:04Z", "periodStart": "2022-04-01T20:32:04Z", @@ -1323,37 +1597,37 @@ } }, "com.amazonaws.artifact#NotificationSubscriptionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBSCRIBED", - "name": "SUBSCRIBED", - "documentation": "The account is subscribed for notification." - }, - { - "value": "NOT_SUBSCRIBED", - "name": "NOT_SUBSCRIBED", - "documentation": "The account is not subscribed for notification." + "type": "enum", + "members": { + "SUBSCRIBED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIBED" } - ] + }, + "NOT_SUBSCRIBED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_SUBSCRIBED" + } + } } }, "com.amazonaws.artifact#PublishedState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PUBLISHED", - "name": "PUBLISHED", - "documentation": "The resource is published for consumption." - }, - { - "value": "UNPUBLISHED", - "name": "UNPUBLISHED", - "documentation": "The resource is not published for consumption." + "type": "enum", + "members": { + "PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHED" } - ] + }, + "UNPUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNPUBLISHED" + } + } } }, "com.amazonaws.artifact#PutAccountSettings": { @@ -1850,26 +2124,32 @@ } }, "com.amazonaws.artifact#UploadState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "COMPLETE", - "name": "COMPLETE" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "FAULT", - "name": "FAULT" + "type": "enum", + "members": { + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" } - ] + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "FAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAULT" + } + } } }, "com.amazonaws.artifact#ValidationException": { From a69d90ce4b42392c27f9e020667e9f72652ea942 Mon Sep 17 00:00:00 2001 From: awstoolsAmazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
## Installing diff --git a/clients/client-timestream-influxdb/src/TimestreamInfluxDB.ts b/clients/client-timestream-influxdb/src/TimestreamInfluxDB.ts index 8bc97c177ab7..1bf0deeb9d87 100644 --- a/clients/client-timestream-influxdb/src/TimestreamInfluxDB.ts +++ b/clients/client-timestream-influxdb/src/TimestreamInfluxDB.ts @@ -240,7 +240,7 @@ export interface TimestreamInfluxDB { } /** - *Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+ *Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
* @public */ export class TimestreamInfluxDB extends TimestreamInfluxDBClient implements TimestreamInfluxDB {} diff --git a/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts b/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts index ce4cb19d912d..41b6fd1dcb14 100644 --- a/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts +++ b/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts @@ -291,7 +291,7 @@ export type TimestreamInfluxDBClientResolvedConfigType = __SmithyResolvedConfigu export interface TimestreamInfluxDBClientResolvedConfig extends TimestreamInfluxDBClientResolvedConfigType {} /** - *Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+ *Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
* @public */ export class TimestreamInfluxDBClient extends __Client< diff --git a/clients/client-timestream-influxdb/src/commands/CreateDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/CreateDbInstanceCommand.ts index 7c4da26e9f78..7bfb2aab7059 100644 --- a/clients/client-timestream-influxdb/src/commands/CreateDbInstanceCommand.ts +++ b/clients/client-timestream-influxdb/src/commands/CreateDbInstanceCommand.ts @@ -71,6 +71,7 @@ export interface CreateDbInstanceCommandOutput extends CreateDbInstanceOutput, _ * "The requested resource was not found or does not exist.
* + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds the service quota.
+ * * @throws {@link TimestreamInfluxDBServiceException} *Base exception class for all service exceptions from TimestreamInfluxDB service.
* diff --git a/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts index e30e26e71e04..818167885836 100644 --- a/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts +++ b/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts @@ -61,6 +61,7 @@ export interface UpdateDbInstanceCommandOutput extends UpdateDbInstanceOutput, _ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE", * // endpoint: "STRING_VALUE", * // port: Number("int"), + * // networkType: "IPV4" || "DUAL", * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge", * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3", * // allocatedStorage: Number("int"), diff --git a/clients/client-timestream-influxdb/src/index.ts b/clients/client-timestream-influxdb/src/index.ts index 6984d884fc6a..0732fc805d21 100644 --- a/clients/client-timestream-influxdb/src/index.ts +++ b/clients/client-timestream-influxdb/src/index.ts @@ -1,7 +1,7 @@ // smithy-typescript generated code /* eslint-disable */ /** - *Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+ *Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
* * @packageDocumentation */ diff --git a/clients/client-timestream-influxdb/src/models/models_0.ts b/clients/client-timestream-influxdb/src/models/models_0.ts index cab97f3ee049..abab9a576f92 100644 --- a/clients/client-timestream-influxdb/src/models/models_0.ts +++ b/clients/client-timestream-influxdb/src/models/models_0.ts @@ -136,6 +136,20 @@ export interface LogDeliveryConfiguration { s3Configuration: S3Configuration | undefined; } +/** + * @public + * @enum + */ +export const NetworkType = { + DUAL: "DUAL", + IPV4: "IPV4", +} as const; + +/** + * @public + */ +export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType]; + /** * @public */ @@ -153,7 +167,7 @@ export interface CreateDbInstanceInput { username?: string | undefined; /** - *The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.
+ *The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Web Services SecretManager in your account.
* @public */ password: string | undefined; @@ -250,6 +264,12 @@ export interface CreateDbInstanceInput { * @public */ port?: number | undefined; + + /** + *Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
+ * @public + */ + networkType?: NetworkType | undefined; } /** @@ -313,6 +333,12 @@ export interface CreateDbInstanceOutput { */ port?: number | undefined; + /** + *Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
+ * @public + */ + networkType?: NetworkType | undefined; + /** *The Timestream for InfluxDB instance type that InfluxDB runs on.
* @public @@ -380,7 +406,7 @@ export interface CreateDbInstanceOutput { logDeliveryConfiguration?: LogDeliveryConfiguration | undefined; /** - *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
* @public */ influxAuthParametersSecretArn?: string | undefined; @@ -581,6 +607,12 @@ export interface DeleteDbInstanceOutput { */ port?: number | undefined; + /** + *Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
+ * @public + */ + networkType?: NetworkType | undefined; + /** *The Timestream for InfluxDB instance type that InfluxDB runs on.
* @public @@ -648,7 +680,7 @@ export interface DeleteDbInstanceOutput { logDeliveryConfiguration?: LogDeliveryConfiguration | undefined; /** - *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
* @public */ influxAuthParametersSecretArn?: string | undefined; @@ -705,6 +737,12 @@ export interface GetDbInstanceOutput { */ port?: number | undefined; + /** + *Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
+ * @public + */ + networkType?: NetworkType | undefined; + /** *The Timestream for InfluxDB instance type that InfluxDB runs on.
* @public @@ -772,7 +810,7 @@ export interface GetDbInstanceOutput { logDeliveryConfiguration?: LogDeliveryConfiguration | undefined; /** - *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
* @public */ influxAuthParametersSecretArn?: string | undefined; @@ -807,7 +845,7 @@ export interface DbInstanceSummary { id: string | undefined; /** - *This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
+ *This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.
* @public */ name: string | undefined; @@ -836,6 +874,12 @@ export interface DbInstanceSummary { */ port?: number | undefined; + /** + *Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
+ * @public + */ + networkType?: NetworkType | undefined; + /** *The Timestream for InfluxDB instance type to run InfluxDB on.
* @public @@ -935,7 +979,7 @@ export interface UpdateDbInstanceOutput { id: string | undefined; /** - *This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
+ *This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.
* @public */ name: string | undefined; @@ -964,6 +1008,12 @@ export interface UpdateDbInstanceOutput { */ port?: number | undefined; + /** + *Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
+ * @public + */ + networkType?: NetworkType | undefined; + /** *The Timestream for InfluxDB instance type that InfluxDB runs on.
* @public @@ -1031,7 +1081,7 @@ export interface UpdateDbInstanceOutput { logDeliveryConfiguration?: LogDeliveryConfiguration | undefined; /** - *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
* @public */ influxAuthParametersSecretArn?: string | undefined; diff --git a/codegen/sdk-codegen/aws-models/timestream-influxdb.json b/codegen/sdk-codegen/aws-models/timestream-influxdb.json index b865075b4088..5966ea1ef6a7 100644 --- a/codegen/sdk-codegen/aws-models/timestream-influxdb.json +++ b/codegen/sdk-codegen/aws-models/timestream-influxdb.json @@ -80,7 +80,7 @@ "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" ] }, - "smithy.api#documentation": "Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
", + "smithy.api#documentation": "Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
", "smithy.api#title": "Timestream InfluxDB", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -855,7 +855,7 @@ "password": { "target": "com.amazonaws.timestreaminfluxdb#Password", "traits": { - "smithy.api#documentation": "The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.
", + "smithy.api#documentation": "The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Web Services SecretManager in your account.
", "smithy.api#required": {} } }, @@ -941,6 +941,12 @@ "smithy.api#default": 8086, "smithy.api#documentation": "The port number on which InfluxDB accepts connections.
\nValid Values: 1024-65535
\nDefault: 8086
\nConstraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" } + }, + "networkType": { + "target": "com.amazonaws.timestreaminfluxdb#NetworkType", + "traits": { + "smithy.api#documentation": "Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" + } } }, "traits": { @@ -994,6 +1000,12 @@ "smithy.api#documentation": "The port number on which InfluxDB accepts connections. The default value is 8086.
" } }, + "networkType": { + "target": "com.amazonaws.timestreaminfluxdb#NetworkType", + "traits": { + "smithy.api#documentation": "Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1064,7 +1076,7 @@ "influxAuthParametersSecretArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" } } }, @@ -1260,7 +1272,7 @@ "name": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", "traits": { - "smithy.api#documentation": "This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
", + "smithy.api#documentation": "This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.
", "smithy.api#required": {} } }, @@ -1289,6 +1301,12 @@ "smithy.api#documentation": "The port number on which InfluxDB accepts connections.
" } }, + "networkType": { + "target": "com.amazonaws.timestreaminfluxdb#NetworkType", + "traits": { + "smithy.api#documentation": "Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1586,6 +1604,12 @@ "smithy.api#documentation": "The port number on which InfluxDB accepts connections.
" } }, + "networkType": { + "target": "com.amazonaws.timestreaminfluxdb#NetworkType", + "traits": { + "smithy.api#documentation": "Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1656,7 +1680,7 @@ "influxAuthParametersSecretArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" } } }, @@ -1824,6 +1848,12 @@ "smithy.api#documentation": "The port number on which InfluxDB accepts connections.
" } }, + "networkType": { + "target": "com.amazonaws.timestreaminfluxdb#NetworkType", + "traits": { + "smithy.api#documentation": "Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1894,7 +1924,7 @@ "influxAuthParametersSecretArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" } } }, @@ -2552,6 +2582,23 @@ } } }, + "com.amazonaws.timestreaminfluxdb#NetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "DUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUAL" + } + } + } + }, "com.amazonaws.timestreaminfluxdb#NextToken": { "type": "string", "traits": { @@ -2796,6 +2843,9 @@ "errors": [ { "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ServiceQuotaExceededException" } ], "traits": { @@ -3045,7 +3095,7 @@ "name": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", "traits": { - "smithy.api#documentation": "This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
", + "smithy.api#documentation": "This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.
", "smithy.api#required": {} } }, @@ -3074,6 +3124,12 @@ "smithy.api#documentation": "The port number on which InfluxDB accepts connections.
" } }, + "networkType": { + "target": "com.amazonaws.timestreaminfluxdb#NetworkType", + "traits": { + "smithy.api#documentation": "Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -3144,7 +3200,7 @@ "influxAuthParametersSecretArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" } } }, From 69319022cb1108296eb81d0dfde9511f5cda7b09 Mon Sep 17 00:00:00 2001 From: awstoolsCreates a multi-region endpoint (global-endpoint).
+ *The primary region is going to be the AWS-Region where the operation is executed. + * The secondary region has to be provided in request's parameters. + * From the data flow standpoint there is no difference between primary + * and secondary regions - sending traffic will be split equally between the two. + * The primary region is the region where the resource has been created and where it can be managed. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateMultiRegionEndpointCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateMultiRegionEndpointCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const input = { // CreateMultiRegionEndpointRequest + * EndpointName: "STRING_VALUE", // required + * Details: { // Details + * RoutesDetails: [ // RoutesDetails // required + * { // RouteDetails + * Region: "STRING_VALUE", // required + * }, + * ], + * }, + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateMultiRegionEndpointCommand(input); + * const response = await client.send(command); + * // { // CreateMultiRegionEndpointResponse + * // Status: "CREATING" || "READY" || "FAILED" || "DELETING", + * // EndpointId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateMultiRegionEndpointCommandInput - {@link CreateMultiRegionEndpointCommandInput} + * @returns {@link CreateMultiRegionEndpointCommandOutput} + * @see {@link CreateMultiRegionEndpointCommandInput} for command's `input` shape. + * @see {@link CreateMultiRegionEndpointCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape. + * + * @throws {@link AlreadyExistsException} (client fault) + *The resource specified in your request already exists.
+ * + * @throws {@link BadRequestException} (client fault) + *The input you provided is invalid.
+ * + * @throws {@link LimitExceededException} (client fault) + *There are too many instances of the specified resource type.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Too many requests have been made to the operation.
+ * + * @throws {@link SESv2ServiceException} + *Base exception class for all service exceptions from SESv2 service.
+ * + * @public + */ +export class CreateMultiRegionEndpointCommand extends $Command + .classBuilder< + CreateMultiRegionEndpointCommandInput, + CreateMultiRegionEndpointCommandOutput, + SESv2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SESv2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SimpleEmailService_v2", "CreateMultiRegionEndpoint", {}) + .n("SESv2Client", "CreateMultiRegionEndpointCommand") + .f(void 0, void 0) + .ser(se_CreateMultiRegionEndpointCommand) + .de(de_CreateMultiRegionEndpointCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateMultiRegionEndpointRequest; + output: CreateMultiRegionEndpointResponse; + }; + sdk: { + input: CreateMultiRegionEndpointCommandInput; + output: CreateMultiRegionEndpointCommandOutput; + }; + }; +} diff --git a/clients/client-sesv2/src/commands/DeleteMultiRegionEndpointCommand.ts b/clients/client-sesv2/src/commands/DeleteMultiRegionEndpointCommand.ts new file mode 100644 index 000000000000..dec8acb90c25 --- /dev/null +++ b/clients/client-sesv2/src/commands/DeleteMultiRegionEndpointCommand.ts @@ -0,0 +1,106 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteMultiRegionEndpointRequest, DeleteMultiRegionEndpointResponse } from "../models/models_0"; +import { de_DeleteMultiRegionEndpointCommand, se_DeleteMultiRegionEndpointCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteMultiRegionEndpointCommand}. + */ +export interface DeleteMultiRegionEndpointCommandInput extends DeleteMultiRegionEndpointRequest {} +/** + * @public + * + * The output of {@link DeleteMultiRegionEndpointCommand}. + */ +export interface DeleteMultiRegionEndpointCommandOutput extends DeleteMultiRegionEndpointResponse, __MetadataBearer {} + +/** + *Deletes a multi-region endpoint (global-endpoint).
+ *Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region + * where operation is executed can be deleted.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteMultiRegionEndpointCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteMultiRegionEndpointCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const input = { // DeleteMultiRegionEndpointRequest + * EndpointName: "STRING_VALUE", // required + * }; + * const command = new DeleteMultiRegionEndpointCommand(input); + * const response = await client.send(command); + * // { // DeleteMultiRegionEndpointResponse + * // Status: "CREATING" || "READY" || "FAILED" || "DELETING", + * // }; + * + * ``` + * + * @param DeleteMultiRegionEndpointCommandInput - {@link DeleteMultiRegionEndpointCommandInput} + * @returns {@link DeleteMultiRegionEndpointCommandOutput} + * @see {@link DeleteMultiRegionEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteMultiRegionEndpointCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *The input you provided is invalid.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *The resource is being modified by another operation or thread.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource you attempted to access doesn't exist.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Too many requests have been made to the operation.
+ * + * @throws {@link SESv2ServiceException} + *Base exception class for all service exceptions from SESv2 service.
+ * + * @public + */ +export class DeleteMultiRegionEndpointCommand extends $Command + .classBuilder< + DeleteMultiRegionEndpointCommandInput, + DeleteMultiRegionEndpointCommandOutput, + SESv2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SESv2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SimpleEmailService_v2", "DeleteMultiRegionEndpoint", {}) + .n("SESv2Client", "DeleteMultiRegionEndpointCommand") + .f(void 0, void 0) + .ser(se_DeleteMultiRegionEndpointCommand) + .de(de_DeleteMultiRegionEndpointCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteMultiRegionEndpointRequest; + output: DeleteMultiRegionEndpointResponse; + }; + sdk: { + input: DeleteMultiRegionEndpointCommandInput; + output: DeleteMultiRegionEndpointCommandOutput; + }; + }; +} diff --git a/clients/client-sesv2/src/commands/GetMultiRegionEndpointCommand.ts b/clients/client-sesv2/src/commands/GetMultiRegionEndpointCommand.ts new file mode 100644 index 000000000000..ce0443c50ca4 --- /dev/null +++ b/clients/client-sesv2/src/commands/GetMultiRegionEndpointCommand.ts @@ -0,0 +1,112 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetMultiRegionEndpointRequest, GetMultiRegionEndpointResponse } from "../models/models_0"; +import { de_GetMultiRegionEndpointCommand, se_GetMultiRegionEndpointCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetMultiRegionEndpointCommand}. + */ +export interface GetMultiRegionEndpointCommandInput extends GetMultiRegionEndpointRequest {} +/** + * @public + * + * The output of {@link GetMultiRegionEndpointCommand}. + */ +export interface GetMultiRegionEndpointCommandOutput extends GetMultiRegionEndpointResponse, __MetadataBearer {} + +/** + *Displays the multi-region endpoint (global-endpoint) configuration.
+ *Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region + * where operation is executed can be displayed.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetMultiRegionEndpointCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetMultiRegionEndpointCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const input = { // GetMultiRegionEndpointRequest + * EndpointName: "STRING_VALUE", // required + * }; + * const command = new GetMultiRegionEndpointCommand(input); + * const response = await client.send(command); + * // { // GetMultiRegionEndpointResponse + * // EndpointName: "STRING_VALUE", + * // EndpointId: "STRING_VALUE", + * // Routes: [ // Routes + * // { // Route + * // Region: "STRING_VALUE", // required + * // }, + * // ], + * // Status: "CREATING" || "READY" || "FAILED" || "DELETING", + * // CreatedTimestamp: new Date("TIMESTAMP"), + * // LastUpdatedTimestamp: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param GetMultiRegionEndpointCommandInput - {@link GetMultiRegionEndpointCommandInput} + * @returns {@link GetMultiRegionEndpointCommandOutput} + * @see {@link GetMultiRegionEndpointCommandInput} for command's `input` shape. + * @see {@link GetMultiRegionEndpointCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *The input you provided is invalid.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource you attempted to access doesn't exist.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Too many requests have been made to the operation.
+ * + * @throws {@link SESv2ServiceException} + *Base exception class for all service exceptions from SESv2 service.
+ * + * @public + */ +export class GetMultiRegionEndpointCommand extends $Command + .classBuilder< + GetMultiRegionEndpointCommandInput, + GetMultiRegionEndpointCommandOutput, + SESv2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SESv2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SimpleEmailService_v2", "GetMultiRegionEndpoint", {}) + .n("SESv2Client", "GetMultiRegionEndpointCommand") + .f(void 0, void 0) + .ser(se_GetMultiRegionEndpointCommand) + .de(de_GetMultiRegionEndpointCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetMultiRegionEndpointRequest; + output: GetMultiRegionEndpointResponse; + }; + sdk: { + input: GetMultiRegionEndpointCommandInput; + output: GetMultiRegionEndpointCommandOutput; + }; + }; +} diff --git a/clients/client-sesv2/src/commands/ListMultiRegionEndpointsCommand.ts b/clients/client-sesv2/src/commands/ListMultiRegionEndpointsCommand.ts new file mode 100644 index 000000000000..76a4500e7786 --- /dev/null +++ b/clients/client-sesv2/src/commands/ListMultiRegionEndpointsCommand.ts @@ -0,0 +1,113 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListMultiRegionEndpointsRequest, ListMultiRegionEndpointsResponse } from "../models/models_0"; +import { de_ListMultiRegionEndpointsCommand, se_ListMultiRegionEndpointsCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListMultiRegionEndpointsCommand}. + */ +export interface ListMultiRegionEndpointsCommandInput extends ListMultiRegionEndpointsRequest {} +/** + * @public + * + * The output of {@link ListMultiRegionEndpointsCommand}. + */ +export interface ListMultiRegionEndpointsCommandOutput extends ListMultiRegionEndpointsResponse, __MetadataBearer {} + +/** + *List the multi-region endpoints (global-endpoints).
+ *Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region + * where operation is executed will be listed.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListMultiRegionEndpointsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListMultiRegionEndpointsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const input = { // ListMultiRegionEndpointsRequest + * NextToken: "STRING_VALUE", + * PageSize: Number("int"), + * }; + * const command = new ListMultiRegionEndpointsCommand(input); + * const response = await client.send(command); + * // { // ListMultiRegionEndpointsResponse + * // MultiRegionEndpoints: [ // MultiRegionEndpoints + * // { // MultiRegionEndpoint + * // EndpointName: "STRING_VALUE", + * // Status: "CREATING" || "READY" || "FAILED" || "DELETING", + * // EndpointId: "STRING_VALUE", + * // Regions: [ // Regions + * // "STRING_VALUE", + * // ], + * // CreatedTimestamp: new Date("TIMESTAMP"), + * // LastUpdatedTimestamp: new Date("TIMESTAMP"), + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListMultiRegionEndpointsCommandInput - {@link ListMultiRegionEndpointsCommandInput} + * @returns {@link ListMultiRegionEndpointsCommandOutput} + * @see {@link ListMultiRegionEndpointsCommandInput} for command's `input` shape. + * @see {@link ListMultiRegionEndpointsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *The input you provided is invalid.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Too many requests have been made to the operation.
+ * + * @throws {@link SESv2ServiceException} + *Base exception class for all service exceptions from SESv2 service.
+ * + * @public + */ +export class ListMultiRegionEndpointsCommand extends $Command + .classBuilder< + ListMultiRegionEndpointsCommandInput, + ListMultiRegionEndpointsCommandOutput, + SESv2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: SESv2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("SimpleEmailService_v2", "ListMultiRegionEndpoints", {}) + .n("SESv2Client", "ListMultiRegionEndpointsCommand") + .f(void 0, void 0) + .ser(se_ListMultiRegionEndpointsCommand) + .de(de_ListMultiRegionEndpointsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListMultiRegionEndpointsRequest; + output: ListMultiRegionEndpointsResponse; + }; + sdk: { + input: ListMultiRegionEndpointsCommandInput; + output: ListMultiRegionEndpointsCommandOutput; + }; + }; +} diff --git a/clients/client-sesv2/src/commands/PutDedicatedIpInPoolCommand.ts b/clients/client-sesv2/src/commands/PutDedicatedIpInPoolCommand.ts index 354ec2827228..4f24fc095ffb 100644 --- a/clients/client-sesv2/src/commands/PutDedicatedIpInPoolCommand.ts +++ b/clients/client-sesv2/src/commands/PutDedicatedIpInPoolCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { PutDedicatedIpInPoolRequest, PutDedicatedIpInPoolResponse } from "../models/models_0"; +import { PutDedicatedIpInPoolRequest, PutDedicatedIpInPoolResponse } from "../models/models_1"; import { de_PutDedicatedIpInPoolCommand, se_PutDedicatedIpInPoolCommand } from "../protocols/Aws_restJson1"; import { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client"; diff --git a/clients/client-sesv2/src/commands/PutDedicatedIpPoolScalingAttributesCommand.ts b/clients/client-sesv2/src/commands/PutDedicatedIpPoolScalingAttributesCommand.ts index f967bbfaf72a..d00fa0231c0d 100644 --- a/clients/client-sesv2/src/commands/PutDedicatedIpPoolScalingAttributesCommand.ts +++ b/clients/client-sesv2/src/commands/PutDedicatedIpPoolScalingAttributesCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { PutDedicatedIpPoolScalingAttributesRequest, PutDedicatedIpPoolScalingAttributesResponse, -} from "../models/models_0"; +} from "../models/models_1"; import { de_PutDedicatedIpPoolScalingAttributesCommand, se_PutDedicatedIpPoolScalingAttributesCommand, diff --git a/clients/client-sesv2/src/commands/PutDedicatedIpWarmupAttributesCommand.ts b/clients/client-sesv2/src/commands/PutDedicatedIpWarmupAttributesCommand.ts index e6c80bdb8a47..147de3d809fc 100644 --- a/clients/client-sesv2/src/commands/PutDedicatedIpWarmupAttributesCommand.ts +++ b/clients/client-sesv2/src/commands/PutDedicatedIpWarmupAttributesCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { PutDedicatedIpWarmupAttributesRequest, PutDedicatedIpWarmupAttributesResponse } from "../models/models_0"; +import { PutDedicatedIpWarmupAttributesRequest, PutDedicatedIpWarmupAttributesResponse } from "../models/models_1"; import { de_PutDedicatedIpWarmupAttributesCommand, se_PutDedicatedIpWarmupAttributesCommand, diff --git a/clients/client-sesv2/src/commands/PutDeliverabilityDashboardOptionCommand.ts b/clients/client-sesv2/src/commands/PutDeliverabilityDashboardOptionCommand.ts index 460b2ef8a864..205807b3fead 100644 --- a/clients/client-sesv2/src/commands/PutDeliverabilityDashboardOptionCommand.ts +++ b/clients/client-sesv2/src/commands/PutDeliverabilityDashboardOptionCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { PutDeliverabilityDashboardOptionRequest, PutDeliverabilityDashboardOptionResponse } from "../models/models_0"; +import { PutDeliverabilityDashboardOptionRequest, PutDeliverabilityDashboardOptionResponse } from "../models/models_1"; import { de_PutDeliverabilityDashboardOptionCommand, se_PutDeliverabilityDashboardOptionCommand, diff --git a/clients/client-sesv2/src/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts b/clients/client-sesv2/src/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts index 2e02661200cb..ea76e4886e3a 100644 --- a/clients/client-sesv2/src/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts +++ b/clients/client-sesv2/src/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts @@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { PutEmailIdentityConfigurationSetAttributesRequest, PutEmailIdentityConfigurationSetAttributesResponse, -} from "../models/models_0"; +} from "../models/models_1"; import { de_PutEmailIdentityConfigurationSetAttributesCommand, se_PutEmailIdentityConfigurationSetAttributesCommand, diff --git a/clients/client-sesv2/src/commands/PutEmailIdentityDkimAttributesCommand.ts b/clients/client-sesv2/src/commands/PutEmailIdentityDkimAttributesCommand.ts index 2c8adc802002..f6e7a907c544 100644 --- a/clients/client-sesv2/src/commands/PutEmailIdentityDkimAttributesCommand.ts +++ b/clients/client-sesv2/src/commands/PutEmailIdentityDkimAttributesCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { PutEmailIdentityDkimAttributesRequest, PutEmailIdentityDkimAttributesResponse } from "../models/models_0"; +import { PutEmailIdentityDkimAttributesRequest, PutEmailIdentityDkimAttributesResponse } from "../models/models_1"; import { de_PutEmailIdentityDkimAttributesCommand, se_PutEmailIdentityDkimAttributesCommand, diff --git a/clients/client-sesv2/src/commands/PutEmailIdentityDkimSigningAttributesCommand.ts b/clients/client-sesv2/src/commands/PutEmailIdentityDkimSigningAttributesCommand.ts index a1fdda94559a..f08735a417fb 100644 --- a/clients/client-sesv2/src/commands/PutEmailIdentityDkimSigningAttributesCommand.ts +++ b/clients/client-sesv2/src/commands/PutEmailIdentityDkimSigningAttributesCommand.ts @@ -8,8 +8,8 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { PutEmailIdentityDkimSigningAttributesRequest, PutEmailIdentityDkimSigningAttributesRequestFilterSensitiveLog, -} from "../models/models_0"; -import { PutEmailIdentityDkimSigningAttributesResponse } from "../models/models_1"; + PutEmailIdentityDkimSigningAttributesResponse, +} from "../models/models_1"; import { de_PutEmailIdentityDkimSigningAttributesCommand, se_PutEmailIdentityDkimSigningAttributesCommand, diff --git a/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts b/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts index ab923e0ee6a9..d6dc25cdaaf4 100644 --- a/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts +++ b/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts @@ -100,6 +100,7 @@ export interface SendBulkEmailCommandOutput extends SendBulkEmailResponse, __Met * }, * ], * ConfigurationSetName: "STRING_VALUE", + * EndpointId: "STRING_VALUE", * }; * const command = new SendBulkEmailCommand(input); * const response = await client.send(command); @@ -160,7 +161,10 @@ export class SendBulkEmailCommand extends $Command ServiceInputTypes, ServiceOutputTypes >() - .ep(commonParams) + .ep({ + ...commonParams, + EndpointId: { type: "contextParams", name: "EndpointId" }, + }) .m(function (this: any, Command: any, cs: any, config: SESv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), diff --git a/clients/client-sesv2/src/commands/SendEmailCommand.ts b/clients/client-sesv2/src/commands/SendEmailCommand.ts index 29495864f89e..dfa8148fb4b7 100644 --- a/clients/client-sesv2/src/commands/SendEmailCommand.ts +++ b/clients/client-sesv2/src/commands/SendEmailCommand.ts @@ -127,6 +127,7 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea * }, * ], * ConfigurationSetName: "STRING_VALUE", + * EndpointId: "STRING_VALUE", * ListManagementOptions: { // ListManagementOptions * ContactListName: "STRING_VALUE", // required * TopicName: "STRING_VALUE", @@ -185,7 +186,10 @@ export class SendEmailCommand extends $Command ServiceInputTypes, ServiceOutputTypes >() - .ep(commonParams) + .ep({ + ...commonParams, + EndpointId: { type: "contextParams", name: "EndpointId" }, + }) .m(function (this: any, Command: any, cs: any, config: SESv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), diff --git a/clients/client-sesv2/src/commands/index.ts b/clients/client-sesv2/src/commands/index.ts index 2babd6204c49..ca4d9d7163fb 100644 --- a/clients/client-sesv2/src/commands/index.ts +++ b/clients/client-sesv2/src/commands/index.ts @@ -13,6 +13,7 @@ export * from "./CreateEmailIdentityPolicyCommand"; export * from "./CreateEmailTemplateCommand"; export * from "./CreateExportJobCommand"; export * from "./CreateImportJobCommand"; +export * from "./CreateMultiRegionEndpointCommand"; export * from "./DeleteConfigurationSetCommand"; export * from "./DeleteConfigurationSetEventDestinationCommand"; export * from "./DeleteContactCommand"; @@ -22,6 +23,7 @@ export * from "./DeleteDedicatedIpPoolCommand"; export * from "./DeleteEmailIdentityCommand"; export * from "./DeleteEmailIdentityPolicyCommand"; export * from "./DeleteEmailTemplateCommand"; +export * from "./DeleteMultiRegionEndpointCommand"; export * from "./DeleteSuppressedDestinationCommand"; export * from "./GetAccountCommand"; export * from "./GetBlacklistReportsCommand"; @@ -43,6 +45,7 @@ export * from "./GetEmailTemplateCommand"; export * from "./GetExportJobCommand"; export * from "./GetImportJobCommand"; export * from "./GetMessageInsightsCommand"; +export * from "./GetMultiRegionEndpointCommand"; export * from "./GetSuppressedDestinationCommand"; export * from "./ListConfigurationSetsCommand"; export * from "./ListContactListsCommand"; @@ -55,6 +58,7 @@ export * from "./ListEmailIdentitiesCommand"; export * from "./ListEmailTemplatesCommand"; export * from "./ListExportJobsCommand"; export * from "./ListImportJobsCommand"; +export * from "./ListMultiRegionEndpointsCommand"; export * from "./ListRecommendationsCommand"; export * from "./ListSuppressedDestinationsCommand"; export * from "./ListTagsForResourceCommand"; diff --git a/clients/client-sesv2/src/endpoint/EndpointParameters.ts b/clients/client-sesv2/src/endpoint/EndpointParameters.ts index 38a892ba1da7..166fe45fd1a5 100644 --- a/clients/client-sesv2/src/endpoint/EndpointParameters.ts +++ b/clients/client-sesv2/src/endpoint/EndpointParameters.ts @@ -38,4 +38,5 @@ export interface EndpointParameters extends __EndpointParameters { UseDualStack?: boolean; UseFIPS?: boolean; Endpoint?: string; + EndpointId?: string; } diff --git a/clients/client-sesv2/src/endpoint/endpointResolver.ts b/clients/client-sesv2/src/endpoint/endpointResolver.ts index ccee107f30d6..30df04e5bbbc 100644 --- a/clients/client-sesv2/src/endpoint/endpointResolver.ts +++ b/clients/client-sesv2/src/endpoint/endpointResolver.ts @@ -8,7 +8,7 @@ import { ruleSet } from "./ruleset"; const cache = new EndpointCache({ size: 50, - params: ["Endpoint", "Region", "UseDualStack", "UseFIPS"], + params: ["Endpoint", "EndpointId", "Region", "UseDualStack", "UseFIPS"], }); export const defaultEndpointResolver = ( diff --git a/clients/client-sesv2/src/endpoint/ruleset.ts b/clients/client-sesv2/src/endpoint/ruleset.ts index 916ca51ca42b..cd01af84e8af 100644 --- a/clients/client-sesv2/src/endpoint/ruleset.ts +++ b/clients/client-sesv2/src/endpoint/ruleset.ts @@ -6,27 +6,35 @@ import { RuleSetObject } from "@smithy/types"; or see "smithy.rules#endpointRuleSet" in codegen/sdk-codegen/aws-models/sesv2.json */ -const s="required", -t="fn", -u="argv", -v="ref"; -const a=true, -b="isSet", -c="booleanEquals", -d="error", +const z="required", +A="type", +B="fn", +C="argv", +D="ref"; +const a=false, +b=true, +c="isSet", +d="booleanEquals", e="endpoint", f="tree", -g="PartitionResult", -h={[s]:false,"type":"String"}, -i={[s]:true,"default":false,"type":"Boolean"}, -j={[v]:"Endpoint"}, -k={[t]:c,[u]:[{[v]:"UseFIPS"},true]}, -l={[t]:c,[u]:[{[v]:"UseDualStack"},true]}, -m={}, -n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]}, -o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]}, -p=[k], -q=[l], -r=[{[v]:"Region"}]; -const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f},{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{endpoint:{url:"https://email-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{endpoint:{url:"https://email-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{endpoint:{url:"https://email.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://email.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]}; +g="error", +h={[z]:false,[A]:"String"}, +i={[z]:true,"default":false,[A]:"Boolean"}, +j={[D]:"EndpointId"}, +k={[B]:c,[C]:[{[D]:"Region"}]}, +l={[B]:"aws.partition",[C]:[{[D]:"Region"}],"assign":"PartitionResult"}, +m={[D]:"UseFIPS"}, +n={[D]:"Endpoint"}, +o={"authSchemes":[{"name":"sigv4a","signingName":"ses","signingRegionSet":["*"]}]}, +p={}, +q={[B]:d,[C]:[{[D]:"UseDualStack"},true]}, +r={[B]:d,[C]:[true,{[B]:"getAttr",[C]:[{[D]:"PartitionResult"},"supportsDualStack"]}]}, +s={[g]:"DualStack is enabled but this partition does not support DualStack",[A]:g}, +t={[B]:d,[C]:[m,true]}, +u={[B]:"getAttr",[C]:[{[D]:"PartitionResult"},"supportsFIPS"]}, +v=[{[B]:c,[C]:[n]}], +w=[q], +x=[r], +y=[t]; +const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h,EndpointId:h},rules:[{conditions:[{[B]:c,[C]:[j]},k,l],rules:[{conditions:[{[B]:"isValidHostLabel",[C]:[j,b]}],rules:[{conditions:[{[B]:d,[C]:[m,a]}],rules:[{conditions:v,endpoint:{url:n,properties:o,headers:p},[A]:e},{conditions:w,rules:[{conditions:x,rules:[{endpoint:{url:"https://{EndpointId}.endpoints.email.{PartitionResult#dualStackDnsSuffix}",properties:o,headers:p},[A]:e}],[A]:f},s],[A]:f},{endpoint:{url:"https://{EndpointId}.endpoints.email.{PartitionResult#dnsSuffix}",properties:o,headers:p},[A]:e}],[A]:f},{error:"Invalid Configuration: FIPS is not supported with multi-region endpoints",[A]:g}],[A]:f},{error:"EndpointId must be a valid host label",[A]:g}],[A]:f},{conditions:v,rules:[{conditions:y,error:"Invalid Configuration: FIPS and custom endpoint are not supported",[A]:g},{conditions:w,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",[A]:g},{endpoint:{url:n,properties:p,headers:p},[A]:e}],[A]:f},{conditions:[k],rules:[{conditions:[l],rules:[{conditions:[t,q],rules:[{conditions:[{[B]:d,[C]:[b,u]},r],rules:[{endpoint:{url:"https://email-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:p,headers:p},[A]:e}],[A]:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",[A]:g}],[A]:f},{conditions:y,rules:[{conditions:[{[B]:d,[C]:[u,b]}],rules:[{endpoint:{url:"https://email-fips.{Region}.{PartitionResult#dnsSuffix}",properties:p,headers:p},[A]:e}],[A]:f},{error:"FIPS is enabled but this partition does not support FIPS",[A]:g}],[A]:f},{conditions:w,rules:[{conditions:x,rules:[{endpoint:{url:"https://email.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:p,headers:p},[A]:e}],[A]:f},s],[A]:f},{endpoint:{url:"https://email.{Region}.{PartitionResult#dnsSuffix}",properties:p,headers:p},[A]:e}],[A]:f}],[A]:f},{error:"Invalid Configuration: Missing Region",[A]:g}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-sesv2/src/models/models_0.ts b/clients/client-sesv2/src/models/models_0.ts index bee58be5c0fb..6a8090e6194e 100644 --- a/clients/client-sesv2/src/models/models_0.ts +++ b/clients/client-sesv2/src/models/models_0.ts @@ -3560,6 +3560,107 @@ export interface CreateImportJobResponse { JobId?: string | undefined; } +/** + *An object that contains route configuration. Includes secondary region name.
+ * @public + */ +export interface RouteDetails { + /** + *The name of an AWS-Region to be a secondary region for the multi-region endpoint (global-endpoint).
+ * @public + */ + Region: string | undefined; +} + +/** + *An object that contains configuration details of multi-region endpoint (global-endpoint).
+ * @public + */ +export interface Details { + /** + *A list of route configuration details. Must contain exactly one route configuration.
+ * @public + */ + RoutesDetails: RouteDetails[] | undefined; +} + +/** + *Represents a request to create a multi-region endpoint (global-endpoint).
+ * @public + */ +export interface CreateMultiRegionEndpointRequest { + /** + *The name of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointName: string | undefined; + + /** + *Contains details of a multi-region endpoint (global-endpoint) being created.
+ * @public + */ + Details: Details | undefined; + + /** + *An array of objects that define the tags (keys and values) to associate with the multi-region endpoint (global-endpoint).
+ * @public + */ + Tags?: Tag[] | undefined; +} + +/** + * @public + * @enum + */ +export const Status = { + CREATING: "CREATING", + DELETING: "DELETING", + FAILED: "FAILED", + READY: "READY", +} as const; + +/** + * @public + */ +export type Status = (typeof Status)[keyof typeof Status]; + +/** + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * @public + */ +export interface CreateMultiRegionEndpointResponse { + /** + *A status of the multi-region endpoint (global-endpoint) right after the create request.
+ *
+ * CREATING
– The resource is being provisioned.
+ * READY
– The resource is ready to use.
+ * FAILED
– The resource failed to be provisioned.
+ * DELETING
– The resource is being deleted as requested.
The ID of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointId?: string | undefined; +} + /** *Contains information about a custom verification email template.
* @public @@ -4009,6 +4110,49 @@ export interface DeleteEmailTemplateRequest { */ export interface DeleteEmailTemplateResponse {} +/** + *Represents a request to delete a multi-region endpoint (global-endpoint).
+ * @public + */ +export interface DeleteMultiRegionEndpointRequest { + /** + *The name of the multi-region endpoint (global-endpoint) to be deleted.
+ * @public + */ + EndpointName: string | undefined; +} + +/** + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * @public + */ +export interface DeleteMultiRegionEndpointResponse { + /** + *A status of the multi-region endpoint (global-endpoint) right after the delete request.
+ *
+ * CREATING
– The resource is being provisioned.
+ * READY
– The resource is ready to use.
+ * FAILED
– The resource failed to be provisioned.
+ * DELETING
– The resource is being deleted as requested.
A request to remove an email address from the suppression list for your * account.
@@ -6123,6 +6267,91 @@ export interface GetMessageInsightsResponse { Insights?: EmailInsights[] | undefined; } +/** + *Represents a request to display the multi-region endpoint (global-endpoint).
+ * @public + */ +export interface GetMultiRegionEndpointRequest { + /** + *The name of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointName: string | undefined; +} + +/** + *An object which contains an AWS-Region and routing status.
+ * @public + */ +export interface Route { + /** + *The name of an AWS-Region.
+ * @public + */ + Region: string | undefined; +} + +/** + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * @public + */ +export interface GetMultiRegionEndpointResponse { + /** + *The name of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointName?: string | undefined; + + /** + *The ID of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointId?: string | undefined; + + /** + *Contains routes information for the multi-region endpoint (global-endpoint).
+ * @public + */ + Routes?: Route[] | undefined; + + /** + *The status of the multi-region endpoint (global-endpoint).
+ *
+ * CREATING
– The resource is being provisioned.
+ * READY
– The resource is ready to use.
+ * FAILED
– The resource failed to be provisioned.
+ * DELETING
– The resource is being deleted as requested.
The time stamp of when the multi-region endpoint (global-endpoint) was created.
+ * @public + */ + CreatedTimestamp?: Date | undefined; + + /** + *The time stamp of when the multi-region endpoint (global-endpoint) was last updated.
+ * @public + */ + LastUpdatedTimestamp?: Date | undefined; +} + /** *A request to retrieve information about an email address that's on the suppression * list for your account.
@@ -6967,6 +7196,111 @@ export interface ListManagementOptions { TopicName?: string | undefined; } +/** + *Represents a request to list all the multi-region endpoints (global-endpoints) + * whose primary region is the AWS-Region where operation is executed. + *
+ * @public + */ +export interface ListMultiRegionEndpointsRequest { + /** + *A token returned from a previous call to ListMultiRegionEndpoints
to indicate
+ * the position in the list of multi-region endpoints (global-endpoints).
The number of results to show in a single call to ListMultiRegionEndpoints
.
+ * If the number of results is larger than the number you specified in this parameter,
+ * the response includes a NextToken
element
+ * that you can use to retrieve the next page of results.
+ *
An object that contains multi-region endpoint (global-endpoint) properties.
+ * @public + */ +export interface MultiRegionEndpoint { + /** + *The name of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointName?: string | undefined; + + /** + *The status of the multi-region endpoint (global-endpoint).
+ *
+ * CREATING
– The resource is being provisioned.
+ * READY
– The resource is ready to use.
+ * FAILED
– The resource failed to be provisioned.
+ * DELETING
– The resource is being deleted as requested.
The ID of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointId?: string | undefined; + + /** + *Primary and secondary regions between which multi-region endpoint splits sending traffic.
+ * @public + */ + Regions?: string[] | undefined; + + /** + *The time stamp of when the multi-region endpoint (global-endpoint) was created.
+ * @public + */ + CreatedTimestamp?: Date | undefined; + + /** + *The time stamp of when the multi-region endpoint (global-endpoint) was last updated.
+ * @public + */ + LastUpdatedTimestamp?: Date | undefined; +} + +/** + *The following elements are returned by the service.
+ * @public + */ +export interface ListMultiRegionEndpointsResponse { + /** + *An array that contains key multi-region endpoint (global-endpoint) properties.
+ * @public + */ + MultiRegionEndpoints?: MultiRegionEndpoint[] | undefined; + + /** + *A token indicating that there are additional multi-region endpoints (global-endpoints) available to be listed.
+ * Pass this token to a subsequent ListMultiRegionEndpoints
call to retrieve the
+ * next page.
A request to move a dedicated IP address to a dedicated IP pool.
- * @public - */ -export interface PutDedicatedIpInPoolRequest { - /** - *The IP address that you want to move to the dedicated IP pool. The value you specify - * has to be a dedicated IP address that's associated with your Amazon Web Services account.
- * @public - */ - Ip: string | undefined; - - /** - *The name of the IP pool that you want to add the dedicated IP address to. You have to - * specify an IP pool that already exists.
- * @public - */ - DestinationPoolName: string | undefined; -} - -/** - *An HTTP 200 response if the request succeeds, or an error message if the request - * fails.
- * @public - */ -export interface PutDedicatedIpInPoolResponse {} - -/** - *A request to convert a dedicated IP pool to a different scaling mode.
- * @public - */ -export interface PutDedicatedIpPoolScalingAttributesRequest { - /** - *The name of the dedicated IP pool.
- * @public - */ - PoolName: string | undefined; - - /** - *The scaling mode to apply to the dedicated IP pool.
- *Changing the scaling mode from MANAGED
to STANDARD
is not supported.
An HTTP 200 response if the request succeeds, or an error message if the request - * fails.
- * @public - */ -export interface PutDedicatedIpPoolScalingAttributesResponse {} - -/** - *A request to change the warm-up attributes for a dedicated IP address. This operation - * is useful when you want to resume the warm-up process for an existing IP address.
- * @public - */ -export interface PutDedicatedIpWarmupAttributesRequest { - /** - *The dedicated IP address that you want to update the warm-up attributes for.
- * @public - */ - Ip: string | undefined; - - /** - *The warm-up percentage that you want to associate with the dedicated IP - * address.
- * @public - */ - WarmupPercentage: number | undefined; -} - -/** - *An HTTP 200 response if the request succeeds, or an error message if the request - * fails.
- * @public - */ -export interface PutDedicatedIpWarmupAttributesResponse {} - -/** - *Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain - * access to reputation, deliverability, and other metrics for the domains that you use to - * send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.
- *When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition - * to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more - * information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- * @public - */ -export interface PutDeliverabilityDashboardOptionRequest { - /** - *Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this
- * value to true
.
An array of objects, one for each verified domain that you use to send email and - * enabled the Deliverability dashboard for.
- * @public - */ - SubscribedDomains?: DomainDeliverabilityTrackingOption[] | undefined; -} - -/** - *A response that indicates whether the Deliverability dashboard is enabled.
- * @public - */ -export interface PutDeliverabilityDashboardOptionResponse {} - -/** - *A request to associate a configuration set with an email identity.
- * @public - */ -export interface PutEmailIdentityConfigurationSetAttributesRequest { - /** - *The email address or domain to associate with a configuration set.
- * @public - */ - EmailIdentity: string | undefined; - - /** - *The configuration set to associate with an email identity.
- * @public - */ - ConfigurationSetName?: string | undefined; -} - -/** - *If the action is successful, the service sends back an HTTP 200 response with an empty - * HTTP body.
- * @public - */ -export interface PutEmailIdentityConfigurationSetAttributesResponse {} - -/** - *A request to enable or disable DKIM signing of email that you send from an email - * identity.
- * @public - */ -export interface PutEmailIdentityDkimAttributesRequest { - /** - *The email identity.
- * @public - */ - EmailIdentity: string | undefined; - - /** - *Sets the DKIM signing configuration for the identity.
- *When you set this value true
, then the messages that are sent from the
- * identity are signed using DKIM. If you set this value to false
, your
- * messages are sent without DKIM signing.
An HTTP 200 response if the request succeeds, or an error message if the request - * fails.
- * @public - */ -export interface PutEmailIdentityDkimAttributesResponse {} - -/** - *A request to change the DKIM attributes for an email identity.
- * @public - */ -export interface PutEmailIdentityDkimSigningAttributesRequest { - /** - *The email identity.
- * @public - */ - EmailIdentity: string | undefined; - - /** - *The method to use to configure DKIM for the identity. There are the following possible - * values:
- *
- * AWS_SES
– Configure DKIM for the identity by using Easy
- * DKIM.
- * EXTERNAL
– Configure DKIM for the identity by using Bring
- * Your Own DKIM (BYODKIM).
An object that contains information about the private key and selector that you want - * to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the - * identity, or, configures the key length to be used for Easy DKIM.
- * @public - */ - SigningAttributes?: DkimSigningAttributes | undefined; -} - /** * @internal */ @@ -7926,13 +8054,3 @@ export const PutAccountDetailsRequestFilterSensitiveLog = (obj: PutAccountDetail ...(obj.UseCaseDescription && { UseCaseDescription: SENSITIVE_STRING }), ...(obj.AdditionalContactEmailAddresses && { AdditionalContactEmailAddresses: SENSITIVE_STRING }), }); - -/** - * @internal - */ -export const PutEmailIdentityDkimSigningAttributesRequestFilterSensitiveLog = ( - obj: PutEmailIdentityDkimSigningAttributesRequest -): any => ({ - ...obj, - ...(obj.SigningAttributes && { SigningAttributes: DkimSigningAttributesFilterSensitiveLog(obj.SigningAttributes) }), -}); diff --git a/clients/client-sesv2/src/models/models_1.ts b/clients/client-sesv2/src/models/models_1.ts index 6bd0d572b1d4..a7e15741bb1f 100644 --- a/clients/client-sesv2/src/models/models_1.ts +++ b/clients/client-sesv2/src/models/models_1.ts @@ -5,18 +5,229 @@ import { BulkEmailEntry, BulkEmailEntryResult, Destination, + DkimSigningAttributes, + DkimSigningAttributesFilterSensitiveLog, + DkimSigningAttributesOrigin, DkimStatus, + DomainDeliverabilityTrackingOption, EmailContent, EmailTemplateContent, EventDestinationDefinition, ListManagementOptions, MessageTag, + ScalingMode, SuppressionListReason, Tag, Topic, TopicPreference, } from "./models_0"; +/** + *A request to move a dedicated IP address to a dedicated IP pool.
+ * @public + */ +export interface PutDedicatedIpInPoolRequest { + /** + *The IP address that you want to move to the dedicated IP pool. The value you specify + * has to be a dedicated IP address that's associated with your Amazon Web Services account.
+ * @public + */ + Ip: string | undefined; + + /** + *The name of the IP pool that you want to add the dedicated IP address to. You have to + * specify an IP pool that already exists.
+ * @public + */ + DestinationPoolName: string | undefined; +} + +/** + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * @public + */ +export interface PutDedicatedIpInPoolResponse {} + +/** + *A request to convert a dedicated IP pool to a different scaling mode.
+ * @public + */ +export interface PutDedicatedIpPoolScalingAttributesRequest { + /** + *The name of the dedicated IP pool.
+ * @public + */ + PoolName: string | undefined; + + /** + *The scaling mode to apply to the dedicated IP pool.
+ *Changing the scaling mode from MANAGED
to STANDARD
is not supported.
An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * @public + */ +export interface PutDedicatedIpPoolScalingAttributesResponse {} + +/** + *A request to change the warm-up attributes for a dedicated IP address. This operation + * is useful when you want to resume the warm-up process for an existing IP address.
+ * @public + */ +export interface PutDedicatedIpWarmupAttributesRequest { + /** + *The dedicated IP address that you want to update the warm-up attributes for.
+ * @public + */ + Ip: string | undefined; + + /** + *The warm-up percentage that you want to associate with the dedicated IP + * address.
+ * @public + */ + WarmupPercentage: number | undefined; +} + +/** + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * @public + */ +export interface PutDedicatedIpWarmupAttributesResponse {} + +/** + *Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain + * access to reputation, deliverability, and other metrics for the domains that you use to + * send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.
+ *When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition + * to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more + * information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
+ * @public + */ +export interface PutDeliverabilityDashboardOptionRequest { + /** + *Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this
+ * value to true
.
An array of objects, one for each verified domain that you use to send email and + * enabled the Deliverability dashboard for.
+ * @public + */ + SubscribedDomains?: DomainDeliverabilityTrackingOption[] | undefined; +} + +/** + *A response that indicates whether the Deliverability dashboard is enabled.
+ * @public + */ +export interface PutDeliverabilityDashboardOptionResponse {} + +/** + *A request to associate a configuration set with an email identity.
+ * @public + */ +export interface PutEmailIdentityConfigurationSetAttributesRequest { + /** + *The email address or domain to associate with a configuration set.
+ * @public + */ + EmailIdentity: string | undefined; + + /** + *The configuration set to associate with an email identity.
+ * @public + */ + ConfigurationSetName?: string | undefined; +} + +/** + *If the action is successful, the service sends back an HTTP 200 response with an empty + * HTTP body.
+ * @public + */ +export interface PutEmailIdentityConfigurationSetAttributesResponse {} + +/** + *A request to enable or disable DKIM signing of email that you send from an email + * identity.
+ * @public + */ +export interface PutEmailIdentityDkimAttributesRequest { + /** + *The email identity.
+ * @public + */ + EmailIdentity: string | undefined; + + /** + *Sets the DKIM signing configuration for the identity.
+ *When you set this value true
, then the messages that are sent from the
+ * identity are signed using DKIM. If you set this value to false
, your
+ * messages are sent without DKIM signing.
An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * @public + */ +export interface PutEmailIdentityDkimAttributesResponse {} + +/** + *A request to change the DKIM attributes for an email identity.
+ * @public + */ +export interface PutEmailIdentityDkimSigningAttributesRequest { + /** + *The email identity.
+ * @public + */ + EmailIdentity: string | undefined; + + /** + *The method to use to configure DKIM for the identity. There are the following possible + * values:
+ *
+ * AWS_SES
– Configure DKIM for the identity by using Easy
+ * DKIM.
+ * EXTERNAL
– Configure DKIM for the identity by using Bring
+ * Your Own DKIM (BYODKIM).
An object that contains information about the private key and selector that you want + * to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the + * identity, or, configures the key length to be used for Easy DKIM.
+ * @public + */ + SigningAttributes?: DkimSigningAttributes | undefined; +} + /** *If the action is successful, the service sends back an HTTP 200 response.
*The following data is returned in JSON format by the service.
@@ -280,6 +491,12 @@ export interface SendBulkEmailRequest { * @public */ ConfigurationSetName?: string | undefined; + + /** + *The ID of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointId?: string | undefined; } /** @@ -425,6 +642,12 @@ export interface SendEmailRequest { */ ConfigurationSetName?: string | undefined; + /** + *The ID of the multi-region endpoint (global-endpoint).
+ * @public + */ + EndpointId?: string | undefined; + /** *An object used to specify a list or topic to which an email belongs, which will be * used when a contact chooses to unsubscribe.
@@ -762,3 +985,13 @@ export interface UpdateEmailTemplateRequest { * @public */ export interface UpdateEmailTemplateResponse {} + +/** + * @internal + */ +export const PutEmailIdentityDkimSigningAttributesRequestFilterSensitiveLog = ( + obj: PutEmailIdentityDkimSigningAttributesRequest +): any => ({ + ...obj, + ...(obj.SigningAttributes && { SigningAttributes: DkimSigningAttributesFilterSensitiveLog(obj.SigningAttributes) }), +}); diff --git a/clients/client-sesv2/src/pagination/ListMultiRegionEndpointsPaginator.ts b/clients/client-sesv2/src/pagination/ListMultiRegionEndpointsPaginator.ts new file mode 100644 index 000000000000..142b5078b324 --- /dev/null +++ b/clients/client-sesv2/src/pagination/ListMultiRegionEndpointsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListMultiRegionEndpointsCommand, + ListMultiRegionEndpointsCommandInput, + ListMultiRegionEndpointsCommandOutput, +} from "../commands/ListMultiRegionEndpointsCommand"; +import { SESv2Client } from "../SESv2Client"; +import { SESv2PaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListMultiRegionEndpoints: ( + config: SESv2PaginationConfiguration, + input: ListMultiRegionEndpointsCommandInput, + ...rest: any[] +) => PaginatorCreates a multi-region endpoint (global-endpoint).
\nThe primary region is going to be the AWS-Region where the operation is executed.\n The secondary region has to be provided in request's parameters.\n From the data flow standpoint there is no difference between primary\n and secondary regions - sending traffic will be split equally between the two.\n The primary region is the region where the resource has been created and where it can be managed.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/multi-region-endpoints", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#CreateMultiRegionEndpointRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sesv2#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the multi-region endpoint (global-endpoint).
", + "smithy.api#required": {} + } + }, + "Details": { + "target": "com.amazonaws.sesv2#Details", + "traits": { + "smithy.api#documentation": "Contains details of a multi-region endpoint (global-endpoint) being created.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sesv2#TagList", + "traits": { + "smithy.api#documentation": "An array of objects that define the tags (keys and values) to associate with the multi-region endpoint (global-endpoint).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a request to create a multi-region endpoint (global-endpoint).
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#CreateMultiRegionEndpointResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sesv2#Status", + "traits": { + "smithy.api#documentation": "A status of the multi-region endpoint (global-endpoint) right after the create request.
\n\n CREATING
– The resource is being provisioned.
\n READY
– The resource is ready to use.
\n FAILED
– The resource failed to be provisioned.
\n DELETING
– The resource is being deleted as requested.
The ID of the multi-region endpoint (global-endpoint).
" + } + } + }, + "traits": { + "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#CustomRedirectDomain": { "type": "string", "traits": { @@ -2607,6 +2688,69 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#DeleteMultiRegionEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#DeleteMultiRegionEndpointRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#DeleteMultiRegionEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a multi-region endpoint (global-endpoint).
\nOnly multi-region endpoints (global-endpoints) whose primary region is the AWS-Region\n where operation is executed can be deleted.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/email/multi-region-endpoints/{EndpointName}", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#DeleteMultiRegionEndpointRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sesv2#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the multi-region endpoint (global-endpoint) to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a request to delete a multi-region endpoint (global-endpoint).
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#DeleteMultiRegionEndpointResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sesv2#Status", + "traits": { + "smithy.api#documentation": "A status of the multi-region endpoint (global-endpoint) right after the delete request.
\n\n CREATING
– The resource is being provisioned.
\n READY
– The resource is ready to use.
\n FAILED
– The resource failed to be provisioned.
\n DELETING
– The resource is being deleted as requested.
An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#DeleteSuppressedDestination": { "type": "operation", "input": { @@ -2861,6 +3005,21 @@ "smithy.api#documentation": "An object that describes the recipients for an email.
\nAmazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n local part of a destination email address (the part of the\n email address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492.
\nA list of route configuration details. Must contain exactly one route configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains configuration details of multi-region endpoint (global-endpoint).
" + } + }, "com.amazonaws.sesv2#DiagnosticCode": { "type": "string" }, @@ -3595,6 +3754,23 @@ "com.amazonaws.sesv2#EnabledWrapper": { "type": "boolean" }, + "com.amazonaws.sesv2#EndpointId": { + "type": "string", + "traits": { + "smithy.api#documentation": "The ID of the multi-region endpoint (global-endpoint).
" + } + }, + "com.amazonaws.sesv2#EndpointName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the multi-region endpoint (global-endpoint).
", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w\\-_]+$" + } + }, "com.amazonaws.sesv2#EngagementEventType": { "type": "enum", "members": { @@ -5751,6 +5927,96 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#GetMultiRegionEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#GetMultiRegionEndpointRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#GetMultiRegionEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Displays the multi-region endpoint (global-endpoint) configuration.
\nOnly multi-region endpoints (global-endpoints) whose primary region is the AWS-Region\n where operation is executed can be displayed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/multi-region-endpoints/{EndpointName}", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#GetMultiRegionEndpointRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sesv2#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the multi-region endpoint (global-endpoint).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a request to display the multi-region endpoint (global-endpoint).
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#GetMultiRegionEndpointResponse": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sesv2#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the multi-region endpoint (global-endpoint).
" + } + }, + "EndpointId": { + "target": "com.amazonaws.sesv2#EndpointId", + "traits": { + "smithy.api#documentation": "The ID of the multi-region endpoint (global-endpoint).
" + } + }, + "Routes": { + "target": "com.amazonaws.sesv2#Routes", + "traits": { + "smithy.api#documentation": "Contains routes information for the multi-region endpoint (global-endpoint).
" + } + }, + "Status": { + "target": "com.amazonaws.sesv2#Status", + "traits": { + "smithy.api#documentation": "The status of the multi-region endpoint (global-endpoint).
\n\n CREATING
– The resource is being provisioned.
\n READY
– The resource is ready to use.
\n FAILED
– The resource failed to be provisioned.
\n DELETING
– The resource is being deleted as requested.
The time stamp of when the multi-region endpoint (global-endpoint) was created.
" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The time stamp of when the multi-region endpoint (global-endpoint) was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#GetSuppressedDestination": { "type": "operation", "input": { @@ -7223,73 +7489,148 @@ "smithy.api#documentation": "An object used to specify a list or topic to which an email belongs, which will be\n used when a contact chooses to unsubscribe.
" } }, - "com.amazonaws.sesv2#ListOfContactLists": { - "type": "list", - "member": { - "target": "com.amazonaws.sesv2#ContactList" - } - }, - "com.amazonaws.sesv2#ListOfContacts": { - "type": "list", - "member": { - "target": "com.amazonaws.sesv2#Contact" - } - }, - "com.amazonaws.sesv2#ListOfDedicatedIpPools": { - "type": "list", - "member": { - "target": "com.amazonaws.sesv2#PoolName" - }, - "traits": { - "smithy.api#documentation": "A list of dedicated IP pools that are associated with your Amazon Web Services account.
" - } - }, - "com.amazonaws.sesv2#ListRecommendationFilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.sesv2#ListRecommendations": { + "com.amazonaws.sesv2#ListMultiRegionEndpoints": { "type": "operation", "input": { - "target": "com.amazonaws.sesv2#ListRecommendationsRequest" + "target": "com.amazonaws.sesv2#ListMultiRegionEndpointsRequest" }, "output": { - "target": "com.amazonaws.sesv2#ListRecommendationsResponse" + "target": "com.amazonaws.sesv2#ListMultiRegionEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.sesv2#BadRequestException" }, - { - "target": "com.amazonaws.sesv2#NotFoundException" - }, { "target": "com.amazonaws.sesv2#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "List the multi-region endpoints (global-endpoints).
\nOnly multi-region endpoints (global-endpoints) whose primary region is the AWS-Region\n where operation is executed will be listed.
", "smithy.api#http": { - "method": "POST", - "uri": "/v2/email/vdm/recommendations", + "method": "GET", + "uri": "/v2/email/multi-region-endpoints", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "MultiRegionEndpoints", "pageSize": "PageSize" } } }, - "com.amazonaws.sesv2#ListRecommendationsFilter": { - "type": "map", - "key": { - "target": "com.amazonaws.sesv2#ListRecommendationsFilterKey" + "com.amazonaws.sesv2#ListMultiRegionEndpointsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sesv2#NextTokenV2", + "traits": { + "smithy.api#documentation": "A token returned from a previous call to ListMultiRegionEndpoints
to indicate\n the position in the list of multi-region endpoints (global-endpoints).
The number of results to show in a single call to ListMultiRegionEndpoints
.\n If the number of results is larger than the number you specified in this parameter,\n the response includes a NextToken
element\n that you can use to retrieve the next page of results.\n
Represents a request to list all the multi-region endpoints (global-endpoints)\n whose primary region is the AWS-Region where operation is executed.\n
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#ListMultiRegionEndpointsResponse": { + "type": "structure", + "members": { + "MultiRegionEndpoints": { + "target": "com.amazonaws.sesv2#MultiRegionEndpoints", + "traits": { + "smithy.api#documentation": "An array that contains key multi-region endpoint (global-endpoint) properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextTokenV2", + "traits": { + "smithy.api#documentation": "A token indicating that there are additional multi-region endpoints (global-endpoints) available to be listed.\n Pass this token to a subsequent ListMultiRegionEndpoints
call to retrieve the\n next page.
The following elements are returned by the service.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#ListOfContactLists": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#ContactList" + } + }, + "com.amazonaws.sesv2#ListOfContacts": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#Contact" + } + }, + "com.amazonaws.sesv2#ListOfDedicatedIpPools": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#PoolName" + }, + "traits": { + "smithy.api#documentation": "A list of dedicated IP pools that are associated with your Amazon Web Services account.
" + } + }, + "com.amazonaws.sesv2#ListRecommendationFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.sesv2#ListRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#ListRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#ListRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
\nYou can execute this operation no more than once per second.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/vdm/recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.sesv2#ListRecommendationsFilter": { + "type": "map", + "key": { + "target": "com.amazonaws.sesv2#ListRecommendationsFilterKey" }, "value": { "target": "com.amazonaws.sesv2#ListRecommendationFilterValue" @@ -8147,9 +8488,69 @@ "smithy.api#documentation": "An object that contains details about the data source for the metrics export.
" } }, + "com.amazonaws.sesv2#MultiRegionEndpoint": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sesv2#EndpointName", + "traits": { + "smithy.api#documentation": "The name of the multi-region endpoint (global-endpoint).
" + } + }, + "Status": { + "target": "com.amazonaws.sesv2#Status", + "traits": { + "smithy.api#documentation": "The status of the multi-region endpoint (global-endpoint).
\n\n CREATING
– The resource is being provisioned.
\n READY
– The resource is ready to use.
\n FAILED
– The resource failed to be provisioned.
\n DELETING
– The resource is being deleted as requested.
The ID of the multi-region endpoint (global-endpoint).
" + } + }, + "Regions": { + "target": "com.amazonaws.sesv2#Regions", + "traits": { + "smithy.api#documentation": "Primary and secondary regions between which multi-region endpoint splits sending traffic.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The time stamp of when the multi-region endpoint (global-endpoint) was created.
" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The time stamp of when the multi-region endpoint (global-endpoint) was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains multi-region endpoint (global-endpoint) properties.
" + } + }, + "com.amazonaws.sesv2#MultiRegionEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#MultiRegionEndpoint" + } + }, "com.amazonaws.sesv2#NextToken": { "type": "string" }, + "com.amazonaws.sesv2#NextTokenV2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + }, + "smithy.api#pattern": "^^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" + } + }, "com.amazonaws.sesv2#NotFoundException": { "type": "structure", "members": { @@ -8192,6 +8593,15 @@ "smithy.api#documentation": "An object that contains information about email that was sent from the selected\n domain.
" } }, + "com.amazonaws.sesv2#PageSizeV2": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.sesv2#Percentage": { "type": "double", "traits": { @@ -9772,6 +10182,18 @@ "target": "com.amazonaws.sesv2#Recommendation" } }, + "com.amazonaws.sesv2#Region": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of an AWS-Region.
" + } + }, + "com.amazonaws.sesv2#Regions": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#Region" + } + }, "com.amazonaws.sesv2#RenderedEmailTemplate": { "type": "string", "traits": { @@ -9888,6 +10310,54 @@ } } }, + "com.amazonaws.sesv2#Route": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.sesv2#Region", + "traits": { + "smithy.api#documentation": "The name of an AWS-Region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object which contains an AWS-Region and routing status.
" + } + }, + "com.amazonaws.sesv2#RouteDetails": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.sesv2#Region", + "traits": { + "smithy.api#documentation": "The name of an AWS-Region to be a secondary region for the multi-region endpoint (global-endpoint).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains route configuration. Includes secondary region name.
" + } + }, + "com.amazonaws.sesv2#Routes": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#Route" + }, + "traits": { + "smithy.api#documentation": "A list of routes between which the traffic will be split when sending through the multi-region endpoint (global-endpoint).
" + } + }, + "com.amazonaws.sesv2#RoutesDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#RouteDetails" + }, + "traits": { + "smithy.api#documentation": "A list of route configuration details. Must contain exactly one route configuration.
" + } + }, "com.amazonaws.sesv2#S3Url": { "type": "string", "traits": { @@ -10050,6 +10520,15 @@ "traits": { "smithy.api#documentation": "The name of the configuration set to use when sending the email.
" } + }, + "EndpointId": { + "target": "com.amazonaws.sesv2#EndpointId", + "traits": { + "smithy.api#documentation": "The ID of the multi-region endpoint (global-endpoint).
", + "smithy.rules#contextParam": { + "name": "EndpointId" + } + } } }, "traits": { @@ -10258,6 +10737,15 @@ "smithy.api#documentation": "The name of the configuration set to use when sending the email.
" } }, + "EndpointId": { + "target": "com.amazonaws.sesv2#EndpointId", + "traits": { + "smithy.api#documentation": "The ID of the multi-region endpoint (global-endpoint).
", + "smithy.rules#contextParam": { + "name": "EndpointId" + } + } + }, "ListManagementOptions": { "target": "com.amazonaws.sesv2#ListManagementOptions", "traits": { @@ -10406,6 +10894,9 @@ { "target": "com.amazonaws.sesv2#CreateImportJob" }, + { + "target": "com.amazonaws.sesv2#CreateMultiRegionEndpoint" + }, { "target": "com.amazonaws.sesv2#DeleteConfigurationSet" }, @@ -10433,6 +10924,9 @@ { "target": "com.amazonaws.sesv2#DeleteEmailTemplate" }, + { + "target": "com.amazonaws.sesv2#DeleteMultiRegionEndpoint" + }, { "target": "com.amazonaws.sesv2#DeleteSuppressedDestination" }, @@ -10496,6 +10990,9 @@ { "target": "com.amazonaws.sesv2#GetMessageInsights" }, + { + "target": "com.amazonaws.sesv2#GetMultiRegionEndpoint" + }, { "target": "com.amazonaws.sesv2#GetSuppressedDestination" }, @@ -10532,6 +11029,9 @@ { "target": "com.amazonaws.sesv2#ListImportJobs" }, + { + "target": "com.amazonaws.sesv2#ListMultiRegionEndpoints" + }, { "target": "com.amazonaws.sesv2#ListRecommendations" }, @@ -10683,9 +11183,193 @@ "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" + }, + "EndpointId": { + "required": false, + "documentation": "Operation parameter for EndpointId", + "type": "String" } }, "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "EndpointId" + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "EndpointId" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "ses", + "signingRegionSet": ["*"] + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{EndpointId}.endpoints.email.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "ses", + "signingRegionSet": ["*"] + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{EndpointId}.endpoints.email.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "ses", + "signingRegionSet": ["*"] + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: FIPS is not supported with multi-region endpoints", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "EndpointId must be a valid host label", + "type": "error" + } + ], + "type": "tree" + }, { "conditions": [ { @@ -11565,6 +12249,157 @@ "expect": { "error": "Invalid Configuration: Missing Region" } + }, + { + "documentation": "Valid EndpointId with dualstack and FIPS disabled. i.e, IPv4 Only stack with no FIPS", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "ses", + "name": "sigv4a", + "signingRegionSet": ["*"] + } + ] + }, + "url": "https://abc123.456def.endpoints.email.amazonaws.com" + } + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "Valid EndpointId with dualstack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "ses", + "name": "sigv4a", + "signingRegionSet": ["*"] + } + ] + }, + "url": "https://abc123.456def.endpoints.email.api.aws" + } + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "Valid EndpointId with FIPS set, dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS is not supported with multi-region endpoints" + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "Valid EndpointId with both dualstack and FIPS enabled", + "expect": { + "error": "Invalid Configuration: FIPS is not supported with multi-region endpoints" + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "Regular regional request, without EndpointId", + "expect": { + "endpoint": { + "url": "https://email.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "Invalid EndpointId (Invalid chars / format)", + "expect": { + "error": "EndpointId must be a valid host label" + }, + "params": { + "EndpointId": "badactor.com?foo=bar", + "UseDualStack": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "Invalid EndpointId (Empty)", + "expect": { + "error": "EndpointId must be a valid host label" + }, + "params": { + "EndpointId": "", + "UseDualStack": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "Valid EndpointId with custom sdk endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingName": "ses", + "name": "sigv4a", + "signingRegionSet": ["*"] + } + ] + }, + "url": "https://example.com" + } + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Valid EndpointId with custom sdk endpoint with FIPS enabled", + "expect": { + "error": "Invalid Configuration: FIPS is not supported with multi-region endpoints" + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Valid EndpointId with DualStack enabled and partition does not support DualStack", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "EndpointId": "abc123.456def", + "UseDualStack": true, + "Region": "us-isob-east-1" + } } ], "version": "1.0" @@ -11586,6 +12421,38 @@ "smithy.api#documentation": "An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notifications when certain email events occur.
" } }, + "com.amazonaws.sesv2#Status": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of the multi-region endpoint (global-endpoint).
\n\n CREATING
– The resource is being provisioned.
\n READY
– The resource is ready to use.
\n FAILED
– The resource failed to be provisioned.
\n DELETING
– The resource is being deleted as requested.
- * High: ["7", "8", "9"]
+ * High: ["7", "8"]
+ *
+ * Critical: ["9", "10"]
*
For more information, see Severity - * levels for GuardDuty findings.
+ *For more information, see Findings severity levels + * in the Amazon GuardDuty User Guide.
* *type
@@ -4159,12 +4164,12 @@ export interface TriggerDetails { } /** - *Contains information about a malware scan.
+ *Contains information about malware scans associated with GuardDuty Malware Protection for EC2.
* @public */ export interface Scan { /** - *The unique ID of the detector that the request is associated with.
+ *The unique ID of the detector that is associated with the request.
*To find the detectorId
in the current Region, see the
* Settings page in the GuardDuty console, or run the ListDetectors API.
Represents the reason for FAILED scan status.
+ *Represents the reason for FAILED
scan status.
Contains information about malware scans.
+ *Contains information about malware scans associated with GuardDuty Malware Protection for EC2.
* @public */ Scans: Scan[] | undefined; @@ -4452,7 +4457,7 @@ export type OrgFeatureAdditionalConfiguration = export interface OrganizationAdditionalConfigurationResult { /** *The name of the additional configuration that is configured for the member accounts within - * the organization.
+ * the organization. These values are applicable to only Runtime Monitoring protection plan. * @public */ Name?: OrgFeatureAdditionalConfiguration | undefined; diff --git a/clients/client-guardduty/src/models/models_1.ts b/clients/client-guardduty/src/models/models_1.ts index 062b173f6cf0..d7d6589ea218 100644 --- a/clients/client-guardduty/src/models/models_1.ts +++ b/clients/client-guardduty/src/models/models_1.ts @@ -2547,12 +2547,13 @@ export interface OrganizationDataSourceConfigurations { /** *A list of additional configurations which will be configured for the organization.
+ *Additional configuration applies to only GuardDuty Runtime Monitoring protection plan.
* @public */ export interface OrganizationAdditionalConfiguration { /** *The name of the additional configuration that will be configured for the - * organization.
+ * organization. These values are applicable to only Runtime Monitoring protection plan. * @public */ Name?: OrgFeatureAdditionalConfiguration | undefined; @@ -2652,7 +2653,9 @@ export interface UpdateOrganizationConfigurationRequest { /** * @deprecated * - *Represents whether or not to automatically enable member accounts in the organization.
+ *Represents whether to automatically enable member accounts in the organization. This + * applies to only new member accounts, not the existing member accounts. When a new account joins the organization, + * the chosen features will be enabled for them by default.
*Even though this is still supported, we recommend using
* AutoEnableOrganizationMembers
to achieve the similar results. You must provide a
* value for either autoEnableOrganizationMembers
or autoEnable
.
Represents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]
\n
\n Medium: [\"4\", \"5\", \"6\"]
\n
\n High: [\"7\", \"8\", \"9\"]
\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV6
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV6
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6
\nservice.action.kubernetesApiCallAction.namespace
\nservice.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.kubernetesApiCallAction.statusCode
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV6
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nRepresents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]
\n
\n Medium: [\"4\", \"5\", \"6\"]
\n
\n High: [\"7\", \"8\"]
\n
\n Critical: [\"9\", \"10\"]
\n
For more information, see Findings severity levels\n in the Amazon GuardDuty User Guide.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV6
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV6
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6
\nservice.action.kubernetesApiCallAction.namespace
\nservice.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.kubernetesApiCallAction.statusCode
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV6
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nContains information about malware scans.
", + "smithy.api#documentation": "Contains information about malware scans associated with GuardDuty Malware Protection for EC2.
", "smithy.api#jsonName": "scans", "smithy.api#required": {} } @@ -11969,7 +11969,7 @@ "Name": { "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", "traits": { - "smithy.api#documentation": "The name of the additional configuration that will be configured for the\n organization.
", + "smithy.api#documentation": "The name of the additional configuration that will be configured for the\n organization. These values are applicable to only Runtime Monitoring protection plan.
", "smithy.api#jsonName": "name" } }, @@ -11982,7 +11982,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of additional configurations which will be configured for the organization.
" + "smithy.api#documentation": "A list of additional configurations which will be configured for the organization.
\nAdditional configuration applies to only GuardDuty Runtime Monitoring protection plan.
" } }, "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult": { @@ -11991,7 +11991,7 @@ "Name": { "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", "traits": { - "smithy.api#documentation": "The name of the additional configuration that is configured for the member accounts within\n the organization.
", + "smithy.api#documentation": "The name of the additional configuration that is configured for the member accounts within\n the organization. These values are applicable to only Runtime Monitoring protection plan.
", "smithy.api#jsonName": "name" } }, @@ -14015,7 +14015,7 @@ "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
\nTo find the detectorId
in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
The unique ID of the detector that is associated with the request.
\nTo find the detectorId
in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.
Represents the reason for FAILED scan status.
", + "smithy.api#documentation": "Represents the reason for FAILED
scan status.
Contains information about a malware scan.
" + "smithy.api#documentation": "Contains information about malware scans associated with GuardDuty Malware Protection for EC2.
" } }, "com.amazonaws.guardduty#ScanCondition": { @@ -16396,7 +16396,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use AutoEnableOrganizationMembers instead" }, - "smithy.api#documentation": "Represents whether or not to automatically enable member accounts in the organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers
to achieve the similar results. You must provide a \n value for either autoEnableOrganizationMembers
or autoEnable
.
Represents whether to automatically enable member accounts in the organization. This\n applies to only new member accounts, not the existing member accounts. When a new account joins the organization,\n the chosen features will be enabled for them by default.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers
to achieve the similar results. You must provide a \n value for either autoEnableOrganizationMembers
or autoEnable
.
DMS was denied access to the endpoint. Check that the + * role is correctly configured.
+ * * @throws {@link InvalidResourceStateFault} (client fault) *The resource is in a state that prevents it from being used for database migration.
* diff --git a/clients/client-database-migration-service/src/commands/DeleteReplicationInstanceCommand.ts b/clients/client-database-migration-service/src/commands/DeleteReplicationInstanceCommand.ts index 2538cd2dff25..530168e177f2 100644 --- a/clients/client-database-migration-service/src/commands/DeleteReplicationInstanceCommand.ts +++ b/clients/client-database-migration-service/src/commands/DeleteReplicationInstanceCommand.ts @@ -110,6 +110,11 @@ export interface DeleteReplicationInstanceCommandOutput extends DeleteReplicatio * // FreeUntil: new Date("TIMESTAMP"), * // DnsNameServers: "STRING_VALUE", * // NetworkType: "STRING_VALUE", + * // KerberosAuthenticationSettings: { // KerberosAuthenticationSettings + * // KeyCacheSecretId: "STRING_VALUE", + * // KeyCacheSecretIamArn: "STRING_VALUE", + * // Krb5FileContents: "STRING_VALUE", + * // }, * // }, * // }; * diff --git a/clients/client-database-migration-service/src/commands/DeleteReplicationSubnetGroupCommand.ts b/clients/client-database-migration-service/src/commands/DeleteReplicationSubnetGroupCommand.ts index 619ce8870eb8..2a4790378ece 100644 --- a/clients/client-database-migration-service/src/commands/DeleteReplicationSubnetGroupCommand.ts +++ b/clients/client-database-migration-service/src/commands/DeleteReplicationSubnetGroupCommand.ts @@ -59,6 +59,10 @@ export interface DeleteReplicationSubnetGroupCommandOutput * @see {@link DeleteReplicationSubnetGroupCommandOutput} for command's `response` shape. * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. * + * @throws {@link AccessDeniedFault} (client fault) + *DMS was denied access to the endpoint. Check that the + * role is correctly configured.
+ * * @throws {@link InvalidResourceStateFault} (client fault) *The resource is in a state that prevents it from being used for database migration.
* diff --git a/clients/client-database-migration-service/src/commands/DescribeEndpointsCommand.ts b/clients/client-database-migration-service/src/commands/DescribeEndpointsCommand.ts index a723d07bdc14..06e169806ed5 100644 --- a/clients/client-database-migration-service/src/commands/DescribeEndpointsCommand.ts +++ b/clients/client-database-migration-service/src/commands/DescribeEndpointsCommand.ts @@ -157,6 +157,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons * // IncludeControlDetails: true || false, * // IncludeNullAndEmpty: true || false, * // NoHexPrefix: true || false, + * // UseLargeIntegerValue: true || false, * // }, * // KafkaSettings: { // KafkaSettings * // Broker: "STRING_VALUE", @@ -179,6 +180,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons * // NoHexPrefix: true || false, * // SaslMechanism: "scram-sha-512" || "plain", * // SslEndpointIdentificationAlgorithm: "none" || "https", + * // UseLargeIntegerValue: true || false, * // }, * // ElasticsearchSettings: { // ElasticsearchSettings * // ServiceAccessRoleArn: "STRING_VALUE", // required @@ -254,6 +256,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons * // MapLongVarcharAs: "wstring" || "clob" || "nclob", * // DatabaseMode: "default" || "babelfish", * // BabelfishDatabaseName: "STRING_VALUE", + * // DisableUnicodeSourceFilter: true || false, * // }, * // MySQLSettings: { // MySQLSettings * // AfterConnectScript: "STRING_VALUE", @@ -318,6 +321,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons * // TrimSpaceInChar: true || false, * // ConvertTimestampWithZoneToUTC: true || false, * // OpenTransactionWindow: Number("int"), + * // AuthenticationMethod: "password" || "kerberos", * // }, * // SybaseSettings: { // SybaseSettings * // DatabaseName: "STRING_VALUE", @@ -346,6 +350,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons * // TrimSpaceInChar: true || false, * // TlogAccessMode: "BackupOnly" || "PreferBackup" || "PreferTlog" || "TlogOnly", * // ForceLobLookup: true || false, + * // AuthenticationMethod: "password" || "kerberos", * // }, * // IBMDb2Settings: { // IBMDb2Settings * // DatabaseName: "STRING_VALUE", diff --git a/clients/client-database-migration-service/src/commands/DescribeReplicationInstancesCommand.ts b/clients/client-database-migration-service/src/commands/DescribeReplicationInstancesCommand.ts index efed0cf8e999..95ec19b788ba 100644 --- a/clients/client-database-migration-service/src/commands/DescribeReplicationInstancesCommand.ts +++ b/clients/client-database-migration-service/src/commands/DescribeReplicationInstancesCommand.ts @@ -122,6 +122,11 @@ export interface DescribeReplicationInstancesCommandOutput * // FreeUntil: new Date("TIMESTAMP"), * // DnsNameServers: "STRING_VALUE", * // NetworkType: "STRING_VALUE", + * // KerberosAuthenticationSettings: { // KerberosAuthenticationSettings + * // KeyCacheSecretId: "STRING_VALUE", + * // KeyCacheSecretIamArn: "STRING_VALUE", + * // Krb5FileContents: "STRING_VALUE", + * // }, * // }, * // ], * // }; diff --git a/clients/client-database-migration-service/src/commands/DescribeReplicationTaskAssessmentResultsCommand.ts b/clients/client-database-migration-service/src/commands/DescribeReplicationTaskAssessmentResultsCommand.ts index 0da45d43099a..191cdeed8b26 100644 --- a/clients/client-database-migration-service/src/commands/DescribeReplicationTaskAssessmentResultsCommand.ts +++ b/clients/client-database-migration-service/src/commands/DescribeReplicationTaskAssessmentResultsCommand.ts @@ -13,6 +13,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { DescribeReplicationTaskAssessmentResultsMessage, DescribeReplicationTaskAssessmentResultsResponse, + DescribeReplicationTaskAssessmentResultsResponseFilterSensitiveLog, } from "../models/models_0"; import { de_DescribeReplicationTaskAssessmentResultsCommand, @@ -109,7 +110,7 @@ export class DescribeReplicationTaskAssessmentResultsCommand extends $Command }) .s("AmazonDMSv20160101", "DescribeReplicationTaskAssessmentResults", {}) .n("DatabaseMigrationServiceClient", "DescribeReplicationTaskAssessmentResultsCommand") - .f(void 0, void 0) + .f(void 0, DescribeReplicationTaskAssessmentResultsResponseFilterSensitiveLog) .ser(se_DescribeReplicationTaskAssessmentResultsCommand) .de(de_DescribeReplicationTaskAssessmentResultsCommand) .build() { diff --git a/clients/client-database-migration-service/src/commands/DescribeSchemasCommand.ts b/clients/client-database-migration-service/src/commands/DescribeSchemasCommand.ts index ba68a8bd73ab..5404a42aea7e 100644 --- a/clients/client-database-migration-service/src/commands/DescribeSchemasCommand.ts +++ b/clients/client-database-migration-service/src/commands/DescribeSchemasCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../DatabaseMigrationServiceClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeSchemasMessage, DescribeSchemasResponse } from "../models/models_0"; +import { DescribeSchemasMessage, DescribeSchemasResponse } from "../models/models_1"; import { de_DescribeSchemasCommand, se_DescribeSchemasCommand } from "../protocols/Aws_json1_1"; /** diff --git a/clients/client-database-migration-service/src/commands/DescribeTableStatisticsCommand.ts b/clients/client-database-migration-service/src/commands/DescribeTableStatisticsCommand.ts index 3fb971d886ce..f896f3c44dd1 100644 --- a/clients/client-database-migration-service/src/commands/DescribeTableStatisticsCommand.ts +++ b/clients/client-database-migration-service/src/commands/DescribeTableStatisticsCommand.ts @@ -10,8 +10,7 @@ import { ServiceOutputTypes, } from "../DatabaseMigrationServiceClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeTableStatisticsMessage } from "../models/models_0"; -import { DescribeTableStatisticsResponse } from "../models/models_1"; +import { DescribeTableStatisticsMessage, DescribeTableStatisticsResponse } from "../models/models_1"; import { de_DescribeTableStatisticsCommand, se_DescribeTableStatisticsCommand } from "../protocols/Aws_json1_1"; /** @@ -99,6 +98,10 @@ export interface DescribeTableStatisticsCommandOutput extends DescribeTableStati * @see {@link DescribeTableStatisticsCommandOutput} for command's `response` shape. * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. * + * @throws {@link AccessDeniedFault} (client fault) + *DMS was denied access to the endpoint. Check that the + * role is correctly configured.
+ * * @throws {@link InvalidResourceStateFault} (client fault) *The resource is in a state that prevents it from being used for database migration.
* diff --git a/clients/client-database-migration-service/src/commands/ModifyEndpointCommand.ts b/clients/client-database-migration-service/src/commands/ModifyEndpointCommand.ts index 3bd97e3822a9..67494a1316f7 100644 --- a/clients/client-database-migration-service/src/commands/ModifyEndpointCommand.ts +++ b/clients/client-database-migration-service/src/commands/ModifyEndpointCommand.ts @@ -145,6 +145,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * IncludeControlDetails: true || false, * IncludeNullAndEmpty: true || false, * NoHexPrefix: true || false, + * UseLargeIntegerValue: true || false, * }, * KafkaSettings: { // KafkaSettings * Broker: "STRING_VALUE", @@ -167,6 +168,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * NoHexPrefix: true || false, * SaslMechanism: "scram-sha-512" || "plain", * SslEndpointIdentificationAlgorithm: "none" || "https", + * UseLargeIntegerValue: true || false, * }, * ElasticsearchSettings: { // ElasticsearchSettings * ServiceAccessRoleArn: "STRING_VALUE", // required @@ -242,6 +244,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * MapLongVarcharAs: "wstring" || "clob" || "nclob", * DatabaseMode: "default" || "babelfish", * BabelfishDatabaseName: "STRING_VALUE", + * DisableUnicodeSourceFilter: true || false, * }, * MySQLSettings: { // MySQLSettings * AfterConnectScript: "STRING_VALUE", @@ -306,6 +309,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * TrimSpaceInChar: true || false, * ConvertTimestampWithZoneToUTC: true || false, * OpenTransactionWindow: Number("int"), + * AuthenticationMethod: "password" || "kerberos", * }, * SybaseSettings: { // SybaseSettings * DatabaseName: "STRING_VALUE", @@ -334,6 +338,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * TrimSpaceInChar: true || false, * TlogAccessMode: "BackupOnly" || "PreferBackup" || "PreferTlog" || "TlogOnly", * ForceLobLookup: true || false, + * AuthenticationMethod: "password" || "kerberos", * }, * IBMDb2Settings: { // IBMDb2Settings * DatabaseName: "STRING_VALUE", @@ -500,6 +505,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * // IncludeControlDetails: true || false, * // IncludeNullAndEmpty: true || false, * // NoHexPrefix: true || false, + * // UseLargeIntegerValue: true || false, * // }, * // KafkaSettings: { // KafkaSettings * // Broker: "STRING_VALUE", @@ -522,6 +528,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * // NoHexPrefix: true || false, * // SaslMechanism: "scram-sha-512" || "plain", * // SslEndpointIdentificationAlgorithm: "none" || "https", + * // UseLargeIntegerValue: true || false, * // }, * // ElasticsearchSettings: { // ElasticsearchSettings * // ServiceAccessRoleArn: "STRING_VALUE", // required @@ -597,6 +604,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * // MapLongVarcharAs: "wstring" || "clob" || "nclob", * // DatabaseMode: "default" || "babelfish", * // BabelfishDatabaseName: "STRING_VALUE", + * // DisableUnicodeSourceFilter: true || false, * // }, * // MySQLSettings: { // MySQLSettings * // AfterConnectScript: "STRING_VALUE", @@ -661,6 +669,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * // TrimSpaceInChar: true || false, * // ConvertTimestampWithZoneToUTC: true || false, * // OpenTransactionWindow: Number("int"), + * // AuthenticationMethod: "password" || "kerberos", * // }, * // SybaseSettings: { // SybaseSettings * // DatabaseName: "STRING_VALUE", @@ -689,6 +698,7 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M * // TrimSpaceInChar: true || false, * // TlogAccessMode: "BackupOnly" || "PreferBackup" || "PreferTlog" || "TlogOnly", * // ForceLobLookup: true || false, + * // AuthenticationMethod: "password" || "kerberos", * // }, * // IBMDb2Settings: { // IBMDb2Settings * // DatabaseName: "STRING_VALUE", diff --git a/clients/client-database-migration-service/src/commands/ModifyEventSubscriptionCommand.ts b/clients/client-database-migration-service/src/commands/ModifyEventSubscriptionCommand.ts index b279deb05190..31fa6ca9711e 100644 --- a/clients/client-database-migration-service/src/commands/ModifyEventSubscriptionCommand.ts +++ b/clients/client-database-migration-service/src/commands/ModifyEventSubscriptionCommand.ts @@ -76,6 +76,10 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri * @see {@link ModifyEventSubscriptionCommandOutput} for command's `response` shape. * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape. * + * @throws {@link AccessDeniedFault} (client fault) + *DMS was denied access to the endpoint. Check that the + * role is correctly configured.
+ * * @throws {@link KMSAccessDeniedFault} (client fault) *The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.
* diff --git a/clients/client-database-migration-service/src/commands/ModifyReplicationInstanceCommand.ts b/clients/client-database-migration-service/src/commands/ModifyReplicationInstanceCommand.ts index a8aa6ed94956..7714d48b69dd 100644 --- a/clients/client-database-migration-service/src/commands/ModifyReplicationInstanceCommand.ts +++ b/clients/client-database-migration-service/src/commands/ModifyReplicationInstanceCommand.ts @@ -57,6 +57,11 @@ export interface ModifyReplicationInstanceCommandOutput extends ModifyReplicatio * AutoMinorVersionUpgrade: true || false, * ReplicationInstanceIdentifier: "STRING_VALUE", * NetworkType: "STRING_VALUE", + * KerberosAuthenticationSettings: { // KerberosAuthenticationSettings + * KeyCacheSecretId: "STRING_VALUE", + * KeyCacheSecretIamArn: "STRING_VALUE", + * Krb5FileContents: "STRING_VALUE", + * }, * }; * const command = new ModifyReplicationInstanceCommand(input); * const response = await client.send(command); @@ -121,6 +126,11 @@ export interface ModifyReplicationInstanceCommandOutput extends ModifyReplicatio * // FreeUntil: new Date("TIMESTAMP"), * // DnsNameServers: "STRING_VALUE", * // NetworkType: "STRING_VALUE", + * // KerberosAuthenticationSettings: { // KerberosAuthenticationSettings + * // KeyCacheSecretId: "STRING_VALUE", + * // KeyCacheSecretIamArn: "STRING_VALUE", + * // Krb5FileContents: "STRING_VALUE", + * // }, * // }, * // }; * diff --git a/clients/client-database-migration-service/src/commands/RebootReplicationInstanceCommand.ts b/clients/client-database-migration-service/src/commands/RebootReplicationInstanceCommand.ts index 2ebbfd12600a..2f3ee973bce5 100644 --- a/clients/client-database-migration-service/src/commands/RebootReplicationInstanceCommand.ts +++ b/clients/client-database-migration-service/src/commands/RebootReplicationInstanceCommand.ts @@ -108,6 +108,11 @@ export interface RebootReplicationInstanceCommandOutput extends RebootReplicatio * // FreeUntil: new Date("TIMESTAMP"), * // DnsNameServers: "STRING_VALUE", * // NetworkType: "STRING_VALUE", + * // KerberosAuthenticationSettings: { // KerberosAuthenticationSettings + * // KeyCacheSecretId: "STRING_VALUE", + * // KeyCacheSecretIamArn: "STRING_VALUE", + * // Krb5FileContents: "STRING_VALUE", + * // }, * // }, * // }; * diff --git a/clients/client-database-migration-service/src/models/models_0.ts b/clients/client-database-migration-service/src/models/models_0.ts index 1ad591803dfd..c8536df3b1ec 100644 --- a/clients/client-database-migration-service/src/models/models_0.ts +++ b/clients/client-database-migration-service/src/models/models_0.ts @@ -526,6 +526,10 @@ export interface ReplicationTaskAssessmentRun { *"starting"
– The assessment run is starting, but resources are not yet
* being provisioned for individual assessments.
*
+ * "warning"
– At least one individual assessment completed with a warning
status.
Specifies using the large integer value with Kafka.
+ * @public + */ + UseLargeIntegerValue?: boolean | undefined; } /** @@ -2471,8 +2481,29 @@ export interface KinesisSettings { * @public */ NoHexPrefix?: boolean | undefined; + + /** + *Specifies using the large integer value with Kinesis.
+ * @public + */ + UseLargeIntegerValue?: boolean | undefined; } +/** + * @public + * @enum + */ +export const SqlServerAuthenticationMethod = { + Kerberos: "kerberos", + Password: "password", +} as const; + +/** + * @public + */ +export type SqlServerAuthenticationMethod = + (typeof SqlServerAuthenticationMethod)[keyof typeof SqlServerAuthenticationMethod]; + /** * @public * @enum @@ -2666,6 +2697,12 @@ export interface MicrosoftSQLServerSettings { * @public */ ForceLobLookup?: boolean | undefined; + + /** + *Specifies using Kerberos authentication with Microsoft SQL Server.
+ * @public + */ + AuthenticationMethod?: SqlServerAuthenticationMethod | undefined; } /** @@ -3031,6 +3068,20 @@ export interface NeptuneSettings { IamAuthEnabled?: boolean | undefined; } +/** + * @public + * @enum + */ +export const OracleAuthenticationMethod = { + Kerberos: "kerberos", + Password: "password", +} as const; + +/** + * @public + */ +export type OracleAuthenticationMethod = (typeof OracleAuthenticationMethod)[keyof typeof OracleAuthenticationMethod]; + /** * @public * @enum @@ -3205,7 +3256,7 @@ export interface OracleSettings { DirectPathNoLog?: boolean | undefined; /** - *When this field is set to Y
, DMS only accesses the
+ *
When this field is set to True
, DMS only accesses the
* archived redo logs. If the archived redo logs are stored on
* Automatic Storage Management (ASM) only, the DMS user account needs to be
* granted ASM privileges.
Set this attribute to Y to capture change data using the Binary Reader utility. Set
- * UseLogminerReader
to N to set this attribute to Y. To use Binary Reader
+ *
Set this attribute to True to capture change data using the Binary Reader utility. Set
+ * UseLogminerReader
to False to set this attribute to True. To use Binary Reader
* with Amazon RDS for Oracle as the source, you set additional attributes. For more information
* about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for
* CDC.
Set this attribute to Y to have DMS use a direct path full load. + *
Set this attribute to True to have DMS use a direct path full load. * Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). * By using this OCI protocol, you can bulk-load Oracle target tables during a full load.
* @public @@ -3404,9 +3455,9 @@ export interface OracleSettings { UseDirectPathFullLoad?: boolean | undefined; /** - *Set this attribute to Y to capture change data using the Oracle LogMiner utility (the
- * default). Set this attribute to N if you want to access the redo logs as a binary file.
- * When you set UseLogminerReader
to N, also set UseBfile
to Y. For
+ *
Set this attribute to True to capture change data using the Oracle LogMiner utility (the
+ * default). Set this attribute to False if you want to access the redo logs as a binary file.
+ * When you set UseLogminerReader
to False, also set UseBfile
to True. For
* more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in
* the DMS User Guide.
You can * specify an integer value between 0 (the default) and 240 (the maximum).
*This parameter is only valid in DMS version 3.5.0 and later. DMS supports
- * a window of up to 9.5 hours including the value for OpenTransactionWindow
.
This parameter is only valid in DMS version 3.5.0 and later.
*Specifies using Kerberos authentication with Oracle.
+ * @public + */ + AuthenticationMethod?: OracleAuthenticationMethod | undefined; } /** @@ -3558,6 +3614,7 @@ export interface PostgreSQLSettings { *To capture DDL events, DMS creates various artifacts in * the PostgreSQL database when the task starts. You can later * remove these artifacts.
+ *The default value is true
.
If this value is set to N
, you don't have to create tables or
* triggers on the source database.
Specifies the maximum size (in KB) of any .csv file used to * transfer data to PostgreSQL.
+ *The default value is 32,768 KB (32 MB).
*Example: maxFileSize=512
*
The schema in which the operational DDL database artifacts * are created.
+ *The default value is public
.
Example: ddlArtifactsSchema=xyzddlschema;
*
When set to true
, this value causes a task to fail if the
* actual size of a LOB column is greater than the specified
* LobMaxSize
.
The default value is false
.
If task is set to Limited LOB mode and this option is set to * true, the task fails instead of truncating the LOB data.
* @public @@ -3612,18 +3672,21 @@ export interface PostgreSQLSettings { * it prevents idle logical replication slots from holding onto old WAL logs, which can result in * storage full situations on the source. This heartbeat keepsrestart_lsn
moving
* and prevents storage full scenarios.
+ * The default value is false
.
Sets the schema in which the heartbeat artifacts are created.
+ *The default value is public
.
Sets the WAL heartbeat frequency (in minutes).
+ *The default value is 5 minutes.
* @public */ HeartbeatFrequency?: number | undefined; @@ -3681,6 +3744,7 @@ export interface PostgreSQLSettings { /** *Specifies the plugin to use to create a replication slot.
+ *The default value is pglogical
.
When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as
* varchar(5)
. You must set this setting on both the source and target endpoints for it to take effect.
The default value is false
.
When true, DMS migrates JSONB values as CLOB.
+ *The default value is false
.
When true, DMS migrates LONG values as VARCHAR.
+ *Sets what datatype to map LONG values as.
+ *The default value is wstring
.
Disables the Unicode source filter with PostgreSQL, for values passed into the Selection rule filter on Source Endpoint column values. + * By default DMS performs source filter comparisons using a Unicode string which can cause look ups to ignore the indexes in the text columns and slow down migrations.
+ *Unicode support should only be disabled when using a selection rule filter is on a text column in the Source database that is indexed.
+ * @public + */ + DisableUnicodeSourceFilter?: boolean | undefined; } /** @@ -6690,6 +6765,30 @@ export class ReplicationSubnetGroupDoesNotCoverEnoughAZs extends __BaseException } } +/** + *Specifies using Kerberos authentication settings for use with DMS.
+ * @public + */ +export interface KerberosAuthenticationSettings { + /** + *Specifies the secret ID of the key cache for the replication instance.
+ * @public + */ + KeyCacheSecretId?: string | undefined; + + /** + *Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the replication instance.
+ * @public + */ + KeyCacheSecretIamArn?: string | undefined; + + /** + *Specifies the ID of the secret that stores the key cache file required for kerberos authentication of the replication instance.
+ * @public + */ + Krb5FileContents?: string | undefined; +} + /** * * @public @@ -6853,6 +6952,12 @@ export interface CreateReplicationInstanceMessage { * @public */ NetworkType?: string | undefined; + + /** + *Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when creating a replication instance.
+ * @public + */ + KerberosAuthenticationSettings?: KerberosAuthenticationSettings | undefined; } /** @@ -7280,6 +7385,12 @@ export interface ReplicationInstance { * @public */ NetworkType?: string | undefined; + + /** + *Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.
+ * @public + */ + KerberosAuthenticationSettings?: KerberosAuthenticationSettings | undefined; } /** @@ -7775,8 +7886,7 @@ export interface ReplicationTask { *
- * "Stop Reason NORMAL"
- *
"Stop Reason NORMAL"
– The task completed successfully with no additional information returned.
* @@ -7790,8 +7900,8 @@ export interface ReplicationTask { *
- * "Stop Reason FULL_LOAD_ONLY_FINISHED"
- *
"Stop Reason FULL_LOAD_ONLY_FINISHED"
– The task completed the full load phase.
+ * DMS applied cached changes if you set StopTaskCachedChangesApplied
to true
.
* @@ -8753,7 +8863,7 @@ export interface DescribeDataMigrationsResponse { export interface DescribeDataProvidersMessage { /** *
Filters applied to the data providers described in the form of key-value pairs.
- *Valid filter names: data-provider-identifier
+ *Valid filter names and values: data-provider-identifier, data provider arn or name
* @public */ Filters?: Filter[] | undefined; @@ -10449,6 +10559,7 @@ export interface DescribeFleetAdvisorSchemasResponse { export interface DescribeInstanceProfilesMessage { /** *Filters applied to the instance profiles described in the form of key-value pairs.
+ *Valid filter names and values: instance-profile-identifier, instance profile arn or name
* @public */ Filters?: Filter[] | undefined; @@ -10789,6 +10900,18 @@ export interface DescribeMetadataModelImportsResponse { export interface DescribeMigrationProjectsMessage { /** *Filters applied to the migration projects described in the form of key-value pairs.
+ *Valid filter names and values:
+ *instance-profile-identifier, instance profile arn or name
+ *data-provider-identifier, data provider arn or name
+ *migration-project-identifier, migration project arn or name
+ *The replication type.
+ *The type of replication to start.
* @public */ StartReplicationType?: string | undefined; @@ -12648,95 +12771,6 @@ export interface DescribeReplicationTasksResponse { ReplicationTasks?: ReplicationTask[] | undefined; } -/** - * - * @public - */ -export interface DescribeSchemasMessage { - /** - *The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- * @public - */ - EndpointArn: string | undefined; - - /** - * The maximum number of records to include in the response. If more records exist than
- * the specified MaxRecords
value, a pagination token called a marker is included
- * in the response so that the remaining results can be retrieved.
Default: 100
- *Constraints: Minimum 20, maximum 100.
- * @public - */ - MaxRecords?: number | undefined; - - /** - * An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords
.
The described schema.
- * @public - */ - Schemas?: string[] | undefined; -} - -/** - * - * @public - */ -export interface DescribeTableStatisticsMessage { - /** - *The Amazon Resource Name (ARN) of the replication task.
- * @public - */ - ReplicationTaskArn: string | undefined; - - /** - * The maximum number of records to include in the response. If more records exist than
- * the specified MaxRecords
value, a pagination token called a marker is included
- * in the response so that the remaining results can be retrieved.
Default: 100
- *Constraints: Minimum 20, maximum 500.
- * @public - */ - MaxRecords?: number | undefined; - - /** - * An optional pagination token provided by a previous request. If this parameter is
- * specified, the response includes only records beyond the marker, up to the value specified
- * by MaxRecords
.
Filters applied to table statistics.
- *Valid filter names: schema-name | table-name | table-state
- *A combination of filters creates an AND condition where each record matches all - * specified filters.
- * @public - */ - Filters?: Filter[] | undefined; -} - /** * @internal */ @@ -12955,3 +12989,25 @@ export const DescribeEndpointsResponseFilterSensitiveLog = (obj: DescribeEndpoin ...obj, ...(obj.Endpoints && { Endpoints: obj.Endpoints.map((item) => EndpointFilterSensitiveLog(item)) }), }); + +/** + * @internal + */ +export const ReplicationTaskAssessmentResultFilterSensitiveLog = (obj: ReplicationTaskAssessmentResult): any => ({ + ...obj, + ...(obj.S3ObjectUrl && { S3ObjectUrl: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const DescribeReplicationTaskAssessmentResultsResponseFilterSensitiveLog = ( + obj: DescribeReplicationTaskAssessmentResultsResponse +): any => ({ + ...obj, + ...(obj.ReplicationTaskAssessmentResults && { + ReplicationTaskAssessmentResults: obj.ReplicationTaskAssessmentResults.map((item) => + ReplicationTaskAssessmentResultFilterSensitiveLog(item) + ), + }), +}); diff --git a/clients/client-database-migration-service/src/models/models_1.ts b/clients/client-database-migration-service/src/models/models_1.ts index 0ae8cc0cd77c..05a8d9fa6b63 100644 --- a/clients/client-database-migration-service/src/models/models_1.ts +++ b/clients/client-database-migration-service/src/models/models_1.ts @@ -21,6 +21,7 @@ import { Endpoint, EndpointFilterSensitiveLog, EventSubscription, + Filter, GcpMySQLSettings, GcpMySQLSettingsFilterSensitiveLog, IBMDb2Settings, @@ -28,6 +29,7 @@ import { InstanceProfile, KafkaSettings, KafkaSettingsFilterSensitiveLog, + KerberosAuthenticationSettings, KinesisSettings, MicrosoftSQLServerSettings, MicrosoftSQLServerSettingsFilterSensitiveLog, @@ -65,6 +67,95 @@ import { TimestreamSettings, } from "./models_0"; +/** + * + * @public + */ +export interface DescribeSchemasMessage { + /** + *The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
+ * @public + */ + EndpointArn: string | undefined; + + /** + * The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a pagination token called a marker is included
+ * in the response so that the remaining results can be retrieved.
Default: 100
+ *Constraints: Minimum 20, maximum 100.
+ * @public + */ + MaxRecords?: number | undefined; + + /** + * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords
.
The described schema.
+ * @public + */ + Schemas?: string[] | undefined; +} + +/** + * + * @public + */ +export interface DescribeTableStatisticsMessage { + /** + *The Amazon Resource Name (ARN) of the replication task.
+ * @public + */ + ReplicationTaskArn: string | undefined; + + /** + * The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a pagination token called a marker is included
+ * in the response so that the remaining results can be retrieved.
Default: 100
+ *Constraints: Minimum 20, maximum 500.
+ * @public + */ + MaxRecords?: number | undefined; + + /** + * An optional pagination token provided by a previous request. If this parameter is
+ * specified, the response includes only records beyond the marker, up to the value specified
+ * by MaxRecords
.
Filters applied to table statistics.
+ *Valid filter names: schema-name | table-name | table-state
+ *A combination of filters creates an AND condition where each record matches all + * specified filters.
+ * @public + */ + Filters?: Filter[] | undefined; +} + /** * * @public @@ -1150,6 +1241,12 @@ export interface ModifyReplicationInstanceMessage { * @public */ NetworkType?: string | undefined; + + /** + *Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when modifying a replication instance.
+ * @public + */ + KerberosAuthenticationSettings?: KerberosAuthenticationSettings | undefined; } /** @@ -1889,6 +1986,16 @@ export interface StartReplicationMessage { /** *The replication type.
+ *When the replication type is full-load
or full-load-and-cdc
, the only valid value
+ * for the first run of the replication is start-replication
. This option will start the replication.
You can also use ReloadTables to reload specific tables that failed during replication instead + * of restarting the replication.
+ *The resume-processing
option isn't applicable for a full-load replication,
+ * because you can't resume partially loaded tables during the full load phase.
For a full-load-and-cdc
replication, DMS migrates table data, and then applies data changes
+ * that occur on the source. To load all the tables again, and start capturing source changes,
+ * use reload-target
. Otherwise use resume-processing
, to replicate the
+ * changes from the last stop position.
The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\"
.
For more information on the settings and capacities for the available replication instance classes, see \n \n Choosing the right DMS replication instance; and, \n Selecting the best size for a replication instance.\n
", "smithy.api#required": {} @@ -3778,6 +3778,12 @@ "traits": { "smithy.api#documentation": "The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" } + }, + "KerberosAuthenticationSettings": { + "target": "com.amazonaws.databasemigrationservice#KerberosAuthenticationSettings", + "traits": { + "smithy.api#documentation": "Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when creating a replication instance.
" + } } }, "traits": { @@ -5066,6 +5072,9 @@ "target": "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -5526,6 +5535,9 @@ "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -6300,7 +6312,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to the data providers described in the form of key-value pairs.
\nValid filter names: data-provider-identifier
" + "smithy.api#documentation": "Filters applied to the data providers described in the form of key-value pairs.
\nValid filter names and values: data-provider-identifier, data provider arn or name
" } }, "MaxRecords": { @@ -7407,7 +7419,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to the instance profiles described in the form of key-value pairs.
" + "smithy.api#documentation": "Filters applied to the instance profiles described in the form of key-value pairs.
\nValid filter names and values: instance-profile-identifier, instance profile arn or name
" } }, "MaxRecords": { @@ -8043,7 +8055,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to the migration projects described in the form of key-value pairs.
" + "smithy.api#documentation": "Filters applied to the migration projects described in the form of key-value pairs.
\nValid filter names and values:
\ninstance-profile-identifier, instance profile arn or name
\ndata-provider-identifier, data provider arn or name
\nmigration-project-identifier, migration project arn or name
\nSets hostname verification\n for the certificate. This setting is supported in DMS version 3.5.1 and later.
" } + }, + "UseLargeIntegerValue": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "Specifies using the large integer value with Kafka.
" + } } }, "traits": { @@ -11700,6 +11721,32 @@ } } }, + "com.amazonaws.databasemigrationservice#KerberosAuthenticationSettings": { + "type": "structure", + "members": { + "KeyCacheSecretId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies the secret ID of the key cache for the replication instance.
" + } + }, + "KeyCacheSecretIamArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the replication instance.
" + } + }, + "Krb5FileContents": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies the ID of the secret that stores the key cache file required for kerberos authentication of the replication instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies using Kerberos authentication settings for use with DMS.
" + } + }, "com.amazonaws.databasemigrationservice#KeyList": { "type": "list", "member": { @@ -11768,6 +11815,12 @@ "traits": { "smithy.api#documentation": "Set this optional parameter to true
to avoid adding a '0x' prefix\n to raw data in hexadecimal format. For example, by default, DMS adds a '0x'\n prefix to the LOB column type in hexadecimal format moving from an Oracle source to an\n Amazon Kinesis target. Use the NoHexPrefix
endpoint setting to enable\n migration of RAW data type columns without adding the '0x' prefix.
Specifies using the large integer value with Kinesis.
" + } } }, "traits": { @@ -12086,6 +12139,12 @@ "traits": { "smithy.api#documentation": "Forces LOB lookup on inline LOB.
" } + }, + "AuthenticationMethod": { + "target": "com.amazonaws.databasemigrationservice#SqlServerAuthenticationMethod", + "traits": { + "smithy.api#documentation": "Specifies using Kerberos authentication with Microsoft SQL Server.
" + } } }, "traits": { @@ -12801,6 +12860,9 @@ "target": "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, { "target": "com.amazonaws.databasemigrationservice#KMSAccessDeniedFault" }, @@ -13430,7 +13492,7 @@ } }, "ReplicationInstanceClass": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceClass", "traits": { "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\"
.
For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right DMS replication instance for your migration.\n
" } @@ -13483,6 +13545,12 @@ "traits": { "smithy.api#documentation": "The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" } + }, + "KerberosAuthenticationSettings": { + "target": "com.amazonaws.databasemigrationservice#KerberosAuthenticationSettings", + "traits": { + "smithy.api#documentation": "Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when modifying a replication instance.
" + } } }, "traits": { @@ -14126,6 +14194,23 @@ } } }, + "com.amazonaws.databasemigrationservice#OracleAuthenticationMethod": { + "type": "enum", + "members": { + "Password": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "Kerberos": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kerberos" + } + } + } + }, "com.amazonaws.databasemigrationservice#OracleDataProviderSettings": { "type": "structure", "members": { @@ -14284,7 +14369,7 @@ "ArchivedLogsOnly": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "When this field is set to Y
, DMS only accesses the\n archived redo logs. If the archived redo logs are stored on\n Automatic Storage Management (ASM) only, the DMS user account needs to be\n granted ASM privileges.
When this field is set to True
, DMS only accesses the\n archived redo logs. If the archived redo logs are stored on\n Automatic Storage Management (ASM) only, the DMS user account needs to be\n granted ASM privileges.
Set this attribute to Y to capture change data using the Binary Reader utility. Set\n UseLogminerReader
to N to set this attribute to Y. To use Binary Reader\n with Amazon RDS for Oracle as the source, you set additional attributes. For more information\n about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for\n CDC.
Set this attribute to True to capture change data using the Binary Reader utility. Set\n UseLogminerReader
to False to set this attribute to True. To use Binary Reader\n with Amazon RDS for Oracle as the source, you set additional attributes. For more information\n about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for\n CDC.
Set this attribute to Y to have DMS use a direct path full load. \n Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). \n By using this OCI protocol, you can bulk-load Oracle target tables during a full load.
" + "smithy.api#documentation": "Set this attribute to True to have DMS use a direct path full load. \n Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). \n By using this OCI protocol, you can bulk-load Oracle target tables during a full load.
" } }, "UseLogminerReader": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "Set this attribute to Y to capture change data using the Oracle LogMiner utility (the\n default). Set this attribute to N if you want to access the redo logs as a binary file.\n When you set UseLogminerReader
to N, also set UseBfile
to Y. For\n more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in\n the DMS User Guide.
Set this attribute to True to capture change data using the Oracle LogMiner utility (the\n default). Set this attribute to False if you want to access the redo logs as a binary file.\n When you set UseLogminerReader
to False, also set UseBfile
to True. For\n more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in\n the DMS User Guide.
The timeframe in minutes to check for open transactions for a CDC-only task.
\nYou can\n specify an integer value between 0 (the default) and 240 (the maximum).
\nThis parameter is only valid in DMS version 3.5.0 and later. DMS supports\n a window of up to 9.5 hours including the value for OpenTransactionWindow
.
The timeframe in minutes to check for open transactions for a CDC-only task.
\nYou can\n specify an integer value between 0 (the default) and 240 (the maximum).
\nThis parameter is only valid in DMS version 3.5.0 and later.
\nSpecifies using Kerberos authentication with Oracle.
" } } }, @@ -14470,7 +14561,7 @@ } }, "ReplicationInstanceClass": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceClass", "traits": { "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\"
.
For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right DMS replication instance for your migration.\n
" } @@ -14666,13 +14757,13 @@ "CaptureDdls": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "To capture DDL events, DMS creates various artifacts in\n the PostgreSQL database when the task starts. You can later\n remove these artifacts.
\nIf this value is set to N
, you don't have to create tables or\n triggers on the source database.
To capture DDL events, DMS creates various artifacts in\n the PostgreSQL database when the task starts. You can later\n remove these artifacts.
\nThe default value is true
.
If this value is set to N
, you don't have to create tables or\n triggers on the source database.
Specifies the maximum size (in KB) of any .csv file used to\n transfer data to PostgreSQL.
\nExample: maxFileSize=512
\n
Specifies the maximum size (in KB) of any .csv file used to\n transfer data to PostgreSQL.
\nThe default value is 32,768 KB (32 MB).
\nExample: maxFileSize=512
\n
The schema in which the operational DDL database artifacts\n are created.
\nExample: ddlArtifactsSchema=xyzddlschema;
\n
The schema in which the operational DDL database artifacts\n are created.
\nThe default value is public
.
Example: ddlArtifactsSchema=xyzddlschema;
\n
When set to true
, this value causes a task to fail if the\n actual size of a LOB column is greater than the specified\n LobMaxSize
.
If task is set to Limited LOB mode and this option is set to\n true, the task fails instead of truncating the LOB data.
" + "smithy.api#documentation": "When set to true
, this value causes a task to fail if the\n actual size of a LOB column is greater than the specified\n LobMaxSize
.
The default value is false
.
If task is set to Limited LOB mode and this option is set to\n true, the task fails instead of truncating the LOB data.
" } }, "HeartbeatEnable": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this,\n it prevents idle logical replication slots from holding onto old WAL logs, which can result in\n storage full situations on the source. This heartbeat keeps restart_lsn
moving\n and prevents storage full scenarios.
The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this,\n it prevents idle logical replication slots from holding onto old WAL logs, which can result in\n storage full situations on the source. This heartbeat keeps restart_lsn
moving\n and prevents storage full scenarios.
The default value is false
.
Sets the schema in which the heartbeat artifacts are created.
" + "smithy.api#documentation": "Sets the schema in which the heartbeat artifacts are created.
\nThe default value is public
.
Sets the WAL heartbeat frequency (in minutes).
" + "smithy.api#documentation": "Sets the WAL heartbeat frequency (in minutes).
\nThe default value is 5 minutes.
" } }, "Password": { @@ -14750,7 +14841,7 @@ "PluginName": { "target": "com.amazonaws.databasemigrationservice#PluginNameValue", "traits": { - "smithy.api#documentation": "Specifies the plugin to use to create a replication slot.
" + "smithy.api#documentation": "Specifies the plugin to use to create a replication slot.
\nThe default value is pglogical
.
When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as \n varchar(5)
. You must set this setting on both the source and target endpoints for it to take effect.
When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as \n varchar(5)
. You must set this setting on both the source and target endpoints for it to take effect.
The default value is false
.
When true, DMS migrates JSONB values as CLOB.
" + "smithy.api#documentation": "When true, DMS migrates JSONB values as CLOB.
\nThe default value is false
.
When true, DMS migrates LONG values as VARCHAR.
" + "smithy.api#documentation": "Sets what datatype to map LONG values as.
\nThe default value is wstring
.
The Babelfish for Aurora PostgreSQL database name for the endpoint.
" } + }, + "DisableUnicodeSourceFilter": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "Disables the Unicode source filter with PostgreSQL, for values passed into the Selection rule filter on Source Endpoint column values. \n By default DMS performs source filter comparisons using a Unicode string which can cause look ups to ignore the indexes in the text columns and slow down migrations.
\nUnicode support should only be disabled when using a selection rule filter is on a text column in the Source database that is indexed.
" + } } }, "traits": { @@ -15906,7 +16003,7 @@ "StartReplicationType": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The replication type.
" + "smithy.api#documentation": "The type of replication to start.
" } }, "CdcStartTime": { @@ -16072,7 +16169,7 @@ } }, "ReplicationInstanceClass": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceClass", "traits": { "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. It is a required parameter, although a default value is\n pre-selected in the DMS console.
\nFor more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right DMS replication instance for your migration.\n
" } @@ -16220,12 +16317,27 @@ "traits": { "smithy.api#documentation": "The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" } + }, + "KerberosAuthenticationSettings": { + "target": "com.amazonaws.databasemigrationservice#KerberosAuthenticationSettings", + "traits": { + "smithy.api#documentation": "Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.
" + } } }, "traits": { "smithy.api#documentation": "Provides information that defines a replication instance.
" } }, + "com.amazonaws.databasemigrationservice#ReplicationInstanceClass": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, "com.amazonaws.databasemigrationservice#ReplicationInstanceIpv6AddressList": { "type": "list", "member": { @@ -16299,7 +16411,7 @@ "type": "structure", "members": { "ReplicationInstanceClass": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceClass", "traits": { "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class.
\nFor more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right DMS replication instance for your migration.\n
" } @@ -16547,7 +16659,7 @@ "StopReason": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The reason the replication task was stopped. This response parameter can return one of\n the following values:
\n\n \"Stop Reason NORMAL\"
\n
\n \"Stop Reason RECOVERABLE_ERROR\"
\n
\n \"Stop Reason FATAL_ERROR\"
\n
\n \"Stop Reason FULL_LOAD_ONLY_FINISHED\"
\n
\n \"Stop Reason STOPPED_AFTER_FULL_LOAD\"
– Full load completed, with cached changes not applied
\n \"Stop Reason STOPPED_AFTER_CACHED_EVENTS\"
– Full load completed, with cached changes applied
\n \"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED\"
\n
\n \"Stop Reason STOPPED_AFTER_DDL_APPLY\"
– User-defined stop task after DDL applied
\n \"Stop Reason STOPPED_DUE_TO_LOW_MEMORY\"
\n
\n \"Stop Reason STOPPED_DUE_TO_LOW_DISK\"
\n
\n \"Stop Reason STOPPED_AT_SERVER_TIME\"
– User-defined server time for stopping task
\n \"Stop Reason STOPPED_AT_COMMIT_TIME\"
– User-defined commit time for stopping task
\n \"Stop Reason RECONFIGURATION_RESTART\"
\n
\n \"Stop Reason RECYCLE_TASK\"
\n
The reason the replication task was stopped. This response parameter can return one of\n the following values:
\n\n \"Stop Reason NORMAL\"
– The task completed successfully with no additional information returned.
\n \"Stop Reason RECOVERABLE_ERROR\"
\n
\n \"Stop Reason FATAL_ERROR\"
\n
\n \"Stop Reason FULL_LOAD_ONLY_FINISHED\"
– The task completed the full load phase.\n DMS applied cached changes if you set StopTaskCachedChangesApplied
to true
.
\n \"Stop Reason STOPPED_AFTER_FULL_LOAD\"
– Full load completed, with cached changes not applied
\n \"Stop Reason STOPPED_AFTER_CACHED_EVENTS\"
– Full load completed, with cached changes applied
\n \"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED\"
\n
\n \"Stop Reason STOPPED_AFTER_DDL_APPLY\"
– User-defined stop task after DDL applied
\n \"Stop Reason STOPPED_DUE_TO_LOW_MEMORY\"
\n
\n \"Stop Reason STOPPED_DUE_TO_LOW_DISK\"
\n
\n \"Stop Reason STOPPED_AT_SERVER_TIME\"
– User-defined server time for stopping task
\n \"Stop Reason STOPPED_AT_COMMIT_TIME\"
– User-defined commit time for stopping task
\n \"Stop Reason RECONFIGURATION_RESTART\"
\n
\n \"Stop Reason RECYCLE_TASK\"
\n
The URL of the S3 object containing the task assessment results.
\nThe response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn\n in the request.
" } @@ -16686,7 +16798,7 @@ "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Assessment run status.
\nThis status can have one of the following values:
\n\n \"cancelling\"
– The assessment run was canceled by the\n CancelReplicationTaskAssessmentRun
operation.
\n \"deleting\"
– The assessment run was deleted by the\n DeleteReplicationTaskAssessmentRun
operation.
\n \"failed\"
– At least one individual assessment completed with a\n failed
status.
\n \"error-provisioning\"
– An internal error occurred while\n resources were provisioned (during provisioning
status).
\n \"error-executing\"
– An internal error occurred while\n individual assessments ran (during running
status).
\n \"invalid state\"
– The assessment run is in an unknown state.
\n \"passed\"
– All individual assessments have completed, and none\n has a failed
status.
\n \"provisioning\"
– Resources required to run individual\n assessments are being provisioned.
\n \"running\"
– Individual assessments are being run.
\n \"starting\"
– The assessment run is starting, but resources are not yet\n being provisioned for individual assessments.
Assessment run status.
\nThis status can have one of the following values:
\n\n \"cancelling\"
– The assessment run was canceled by the\n CancelReplicationTaskAssessmentRun
operation.
\n \"deleting\"
– The assessment run was deleted by the\n DeleteReplicationTaskAssessmentRun
operation.
\n \"failed\"
– At least one individual assessment completed with a\n failed
status.
\n \"error-provisioning\"
– An internal error occurred while\n resources were provisioned (during provisioning
status).
\n \"error-executing\"
– An internal error occurred while\n individual assessments ran (during running
status).
\n \"invalid state\"
– The assessment run is in an unknown state.
\n \"passed\"
– All individual assessments have completed, and none\n has a failed
status.
\n \"provisioning\"
– Resources required to run individual\n assessments are being provisioned.
\n \"running\"
– Individual assessments are being run.
\n \"starting\"
– The assessment run is starting, but resources are not yet\n being provisioned for individual assessments.
\n \"warning\"
– At least one individual assessment completed with a warning
status.
The replication type.
", + "smithy.api#documentation": "The replication type.
\nWhen the replication type is full-load
or full-load-and-cdc
, the only valid value \n for the first run of the replication is start-replication
. This option will start the replication.
You can also use ReloadTables to reload specific tables that failed during replication instead \n of restarting the replication.
\nThe resume-processing
option isn't applicable for a full-load replication,\n because you can't resume partially loaded tables during the full load phase.
For a full-load-and-cdc
replication, DMS migrates table data, and then applies data changes \n that occur on the source. To load all the tables again, and start capturing source changes, \n use reload-target
. Otherwise use resume-processing
, to replicate the \n changes from the last stop position.
Creates a new trigger.
+ *Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-glue/src/commands/GetJobRunCommand.ts b/clients/client-glue/src/commands/GetJobRunCommand.ts index e7a65198c665..ba86e1f8b2cf 100644 --- a/clients/client-glue/src/commands/GetJobRunCommand.ts +++ b/clients/client-glue/src/commands/GetJobRunCommand.ts @@ -28,7 +28,7 @@ export interface GetJobRunCommandInput extends GetJobRunRequest {} export interface GetJobRunCommandOutput extends GetJobRunResponse, __MetadataBearer {} /** - *Retrieves the metadata for a given job run. Job run history is accessible for 90 days for your workflow and job run.
+ *Retrieves the metadata for a given job run. Job run history is accessible for 365 days for your workflow and job run.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-glue/src/commands/GetJobRunsCommand.ts b/clients/client-glue/src/commands/GetJobRunsCommand.ts index 5c8202bf41ec..1a22a4439e48 100644 --- a/clients/client-glue/src/commands/GetJobRunsCommand.ts +++ b/clients/client-glue/src/commands/GetJobRunsCommand.ts @@ -29,6 +29,8 @@ export interface GetJobRunsCommandOutput extends GetJobRunsResponse, __MetadataB /** *Retrieves metadata for all runs of a given job definition.
+ *
+ * GetJobRuns
returns the job runs in chronological order, with the newest jobs returned first.
Updates a trigger definition.
+ *Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-glue/src/models/models_0.ts b/clients/client-glue/src/models/models_0.ts index 073301bcb87f..728aa362fc4c 100644 --- a/clients/client-glue/src/models/models_0.ts +++ b/clients/client-glue/src/models/models_0.ts @@ -8823,22 +8823,22 @@ export interface JobRun { * G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. *For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
Specifies how Data Quality assets in your account should be encrypted.
+ * @public + */ +export interface DataQualityEncryption { + /** + *The encryption mode to use for encrypting Data Quality assets. These assets include data quality rulesets, results, statistics, anomaly detection models and observations.
+ *Valid values are SSEKMS
for encryption using a customer-managed KMS key, or DISABLED
.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
+ * @public + */ + KmsKeyArn?: string | undefined; +} + /** * @public * @enum @@ -3583,6 +3616,12 @@ export interface EncryptionConfiguration { * @public */ JobBookmarksEncryption?: JobBookmarksEncryption | undefined; + + /** + *The encryption configuration for Glue Data Quality assets.
+ * @public + */ + DataQualityEncryption?: DataQualityEncryption | undefined; } /** @@ -3716,19 +3755,19 @@ export interface CreateSessionRequest { * G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks. *For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
A collection of properties to be used as part of each execution of the workflow.
+ *Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
* @public */ DefaultRunProperties?: RecordThe settings for a column statistics task.
* @public @@ -8118,6 +8144,7 @@ export interface PutWorkflowRunPropertiesRequest { /** *The properties to put for the specified run.
+ *Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
* @public */ RunProperties: RecordSpecifies a field to sort by and a sort order.
- * @public - */ -export interface SortCriterion { - /** - *The name of the field on which to sort.
- * @public - */ - FieldName?: string | undefined; - - /** - *An ascending or descending sort.
- * @public - */ - Sort?: Sort | undefined; -} - /** * @internal */ diff --git a/clients/client-glue/src/models/models_3.ts b/clients/client-glue/src/models/models_3.ts index 6242bd1ffcbe..4edb7c636460 100644 --- a/clients/client-glue/src/models/models_3.ts +++ b/clients/client-glue/src/models/models_3.ts @@ -138,11 +138,42 @@ import { ResourceShareType, ResourceState, SchemaVersionNumber, - SortCriterion, ViewDefinition, ViewValidation, } from "./models_2"; +/** + * @public + * @enum + */ +export const Sort = { + ASCENDING: "ASC", + DESCENDING: "DESC", +} as const; + +/** + * @public + */ +export type Sort = (typeof Sort)[keyof typeof Sort]; + +/** + *Specifies a field to sort by and a sort order.
+ * @public + */ +export interface SortCriterion { + /** + *The name of the field on which to sort.
+ * @public + */ + FieldName?: string | undefined; + + /** + *An ascending or descending sort.
+ * @public + */ + Sort?: Sort | undefined; +} + /** * @public */ @@ -724,22 +755,22 @@ export interface StartJobRunRequest { * G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. *For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The workflow run properties for the new workflow run.
+ *Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
* @public */ RunProperties?: RecordA collection of properties to be used as part of each execution of the workflow.
+ *Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
* @public */ DefaultRunProperties?: RecordFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
Creates a new trigger.
" + "smithy.api#documentation": "Creates a new trigger.
\nJob arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
" } }, "com.amazonaws.glue#CreateTriggerRequest": { @@ -12184,7 +12184,7 @@ "DefaultRunProperties": { "target": "com.amazonaws.glue#WorkflowRunProperties", "traits": { - "smithy.api#documentation": "A collection of properties to be used as part of each execution of the workflow.
" + "smithy.api#documentation": "A collection of properties to be used as part of each execution of the workflow.
\nRun properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
" } }, "Tags": { @@ -12915,6 +12915,43 @@ } } }, + "com.amazonaws.glue#DataQualityEncryption": { + "type": "structure", + "members": { + "DataQualityEncryptionMode": { + "target": "com.amazonaws.glue#DataQualityEncryptionMode", + "traits": { + "smithy.api#documentation": "The encryption mode to use for encrypting Data Quality assets. These assets include data quality rulesets, results, statistics, anomaly detection models and observations.
\nValid values are SSEKMS
for encryption using a customer-managed KMS key, or DISABLED
.
The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how Data Quality assets in your account should be encrypted.
" + } + }, + "com.amazonaws.glue#DataQualityEncryptionMode": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "SSEKMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-KMS" + } + } + } + }, "com.amazonaws.glue#DataQualityEvaluationRunAdditionalRunOptions": { "type": "structure", "members": { @@ -17152,6 +17189,12 @@ "traits": { "smithy.api#documentation": "The encryption configuration for job bookmarks.
" } + }, + "DataQualityEncryption": { + "target": "com.amazonaws.glue#DataQualityEncryption", + "traits": { + "smithy.api#documentation": "The encryption configuration for Glue Data Quality assets.
" + } } }, "traits": { @@ -21378,7 +21421,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the metadata for a given job run. Job run history is accessible for 90 days for your workflow and job run.
" + "smithy.api#documentation": "Retrieves the metadata for a given job run. Job run history is accessible for 365 days for your workflow and job run.
" } }, "com.amazonaws.glue#GetJobRunRequest": { @@ -21447,7 +21490,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves metadata for all runs of a given job definition.
", + "smithy.api#documentation": "Retrieves metadata for all runs of a given job definition.
\n\n GetJobRuns
returns the job runs in chronological order, with the newest jobs returned first.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The properties to put for the specified run.
", + "smithy.api#documentation": "The properties to put for the specified run.
\nRun properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
", "smithy.api#required": {} } } @@ -38494,7 +38537,7 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
\nFor the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
The workflow run properties for the new workflow run.
" + "smithy.api#documentation": "The workflow run properties for the new workflow run.
\nRun properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
" } } }, @@ -44096,7 +44139,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a trigger definition.
" + "smithy.api#documentation": "Updates a trigger definition.
\nJob arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
" } }, "com.amazonaws.glue#UpdateTriggerRequest": { @@ -44328,7 +44371,7 @@ "DefaultRunProperties": { "target": "com.amazonaws.glue#WorkflowRunProperties", "traits": { - "smithy.api#documentation": "A collection of properties to be used as part of each execution of the workflow.
" + "smithy.api#documentation": "A collection of properties to be used as part of each execution of the workflow.
\nRun properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.
" } }, "MaxConcurrentRuns": { From 6398b6f3ba711532872e39c5affd5b07ffb5ec80 Mon Sep 17 00:00:00 2001 From: awstoolsCreates an hours of operation override in an Amazon Connect hours of operation + * resource
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateHoursOfOperationOverrideCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateHoursOfOperationOverrideCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // CreateHoursOfOperationOverrideRequest + * InstanceId: "STRING_VALUE", // required + * HoursOfOperationId: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * Description: "STRING_VALUE", + * Config: [ // HoursOfOperationOverrideConfigList // required + * { // HoursOfOperationOverrideConfig + * Day: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", + * StartTime: { // OverrideTimeSlice + * Hours: Number("int"), // required + * Minutes: Number("int"), // required + * }, + * EndTime: { + * Hours: Number("int"), // required + * Minutes: Number("int"), // required + * }, + * }, + * ], + * EffectiveFrom: "STRING_VALUE", // required + * EffectiveTill: "STRING_VALUE", // required + * }; + * const command = new CreateHoursOfOperationOverrideCommand(input); + * const response = await client.send(command); + * // { // CreateHoursOfOperationOverrideResponse + * // HoursOfOperationOverrideId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateHoursOfOperationOverrideCommandInput - {@link CreateHoursOfOperationOverrideCommandInput} + * @returns {@link CreateHoursOfOperationOverrideCommandOutput} + * @see {@link CreateHoursOfOperationOverrideCommandInput} for command's `input` shape. + * @see {@link CreateHoursOfOperationOverrideCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link DuplicateResourceException} (client fault) + *A resource with the specified name already exists.
+ * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *The allowed limit for the resource has been exceeded.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + * @public + */ +export class CreateHoursOfOperationOverrideCommand extends $Command + .classBuilder< + CreateHoursOfOperationOverrideCommandInput, + CreateHoursOfOperationOverrideCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "CreateHoursOfOperationOverride", {}) + .n("ConnectClient", "CreateHoursOfOperationOverrideCommand") + .f(void 0, void 0) + .ser(se_CreateHoursOfOperationOverrideCommand) + .de(de_CreateHoursOfOperationOverrideCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateHoursOfOperationOverrideRequest; + output: CreateHoursOfOperationOverrideResponse; + }; + sdk: { + input: CreateHoursOfOperationOverrideCommandInput; + output: CreateHoursOfOperationOverrideCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/CreateQueueCommand.ts b/clients/client-connect/src/commands/CreateQueueCommand.ts index c74cf0c74edc..731be563f51b 100644 --- a/clients/client-connect/src/commands/CreateQueueCommand.ts +++ b/clients/client-connect/src/commands/CreateQueueCommand.ts @@ -28,8 +28,7 @@ export interface CreateQueueCommandInput extends CreateQueueRequest {} export interface CreateQueueCommandOutput extends CreateQueueResponse, __MetadataBearer {} /** - *This API is in preview release for Amazon Connect and is subject to change.
- *Creates a new queue for the specified Amazon Connect instance.
+ *Creates a new queue for the specified Amazon Connect instance.
*Deletes an hours of operation override in an Amazon Connect hours of operation + * resource
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DeleteHoursOfOperationOverrideCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DeleteHoursOfOperationOverrideCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // DeleteHoursOfOperationOverrideRequest + * InstanceId: "STRING_VALUE", // required + * HoursOfOperationId: "STRING_VALUE", // required + * HoursOfOperationOverrideId: "STRING_VALUE", // required + * }; + * const command = new DeleteHoursOfOperationOverrideCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteHoursOfOperationOverrideCommandInput - {@link DeleteHoursOfOperationOverrideCommandInput} + * @returns {@link DeleteHoursOfOperationOverrideCommandOutput} + * @see {@link DeleteHoursOfOperationOverrideCommandInput} for command's `input` shape. + * @see {@link DeleteHoursOfOperationOverrideCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + * @public + */ +export class DeleteHoursOfOperationOverrideCommand extends $Command + .classBuilder< + DeleteHoursOfOperationOverrideCommandInput, + DeleteHoursOfOperationOverrideCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "DeleteHoursOfOperationOverride", {}) + .n("ConnectClient", "DeleteHoursOfOperationOverrideCommand") + .f(void 0, void 0) + .ser(se_DeleteHoursOfOperationOverrideCommand) + .de(de_DeleteHoursOfOperationOverrideCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteHoursOfOperationOverrideRequest; + output: {}; + }; + sdk: { + input: DeleteHoursOfOperationOverrideCommandInput; + output: DeleteHoursOfOperationOverrideCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/DeleteTaskTemplateCommand.ts b/clients/client-connect/src/commands/DeleteTaskTemplateCommand.ts index bb2ec49c0423..54be25b041ab 100644 --- a/clients/client-connect/src/commands/DeleteTaskTemplateCommand.ts +++ b/clients/client-connect/src/commands/DeleteTaskTemplateCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteTaskTemplateRequest, DeleteTaskTemplateResponse } from "../models/models_0"; +import { DeleteTaskTemplateRequest, DeleteTaskTemplateResponse } from "../models/models_1"; import { de_DeleteTaskTemplateCommand, se_DeleteTaskTemplateCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/DeleteTrafficDistributionGroupCommand.ts b/clients/client-connect/src/commands/DeleteTrafficDistributionGroupCommand.ts index 2c12ae5c33dd..77791eda6691 100644 --- a/clients/client-connect/src/commands/DeleteTrafficDistributionGroupCommand.ts +++ b/clients/client-connect/src/commands/DeleteTrafficDistributionGroupCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteTrafficDistributionGroupRequest, DeleteTrafficDistributionGroupResponse } from "../models/models_0"; +import { DeleteTrafficDistributionGroupRequest, DeleteTrafficDistributionGroupResponse } from "../models/models_1"; import { de_DeleteTrafficDistributionGroupCommand, se_DeleteTrafficDistributionGroupCommand, diff --git a/clients/client-connect/src/commands/DeleteUseCaseCommand.ts b/clients/client-connect/src/commands/DeleteUseCaseCommand.ts index aee870ec6802..e1cd1950614d 100644 --- a/clients/client-connect/src/commands/DeleteUseCaseCommand.ts +++ b/clients/client-connect/src/commands/DeleteUseCaseCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteUseCaseRequest } from "../models/models_0"; +import { DeleteUseCaseRequest } from "../models/models_1"; import { de_DeleteUseCaseCommand, se_DeleteUseCaseCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/DeleteUserCommand.ts b/clients/client-connect/src/commands/DeleteUserCommand.ts index ce8df779d824..addfb85ddd61 100644 --- a/clients/client-connect/src/commands/DeleteUserCommand.ts +++ b/clients/client-connect/src/commands/DeleteUserCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteUserRequest } from "../models/models_0"; +import { DeleteUserRequest } from "../models/models_1"; import { de_DeleteUserCommand, se_DeleteUserCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/DescribeHoursOfOperationOverrideCommand.ts b/clients/client-connect/src/commands/DescribeHoursOfOperationOverrideCommand.ts new file mode 100644 index 000000000000..ca2e8c07c454 --- /dev/null +++ b/clients/client-connect/src/commands/DescribeHoursOfOperationOverrideCommand.ts @@ -0,0 +1,135 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeHoursOfOperationOverrideRequest, DescribeHoursOfOperationOverrideResponse } from "../models/models_1"; +import { + de_DescribeHoursOfOperationOverrideCommand, + se_DescribeHoursOfOperationOverrideCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeHoursOfOperationOverrideCommand}. + */ +export interface DescribeHoursOfOperationOverrideCommandInput extends DescribeHoursOfOperationOverrideRequest {} +/** + * @public + * + * The output of {@link DescribeHoursOfOperationOverrideCommand}. + */ +export interface DescribeHoursOfOperationOverrideCommandOutput + extends DescribeHoursOfOperationOverrideResponse, + __MetadataBearer {} + +/** + *Describes the hours of operation override.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeHoursOfOperationOverrideCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeHoursOfOperationOverrideCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // DescribeHoursOfOperationOverrideRequest + * InstanceId: "STRING_VALUE", // required + * HoursOfOperationId: "STRING_VALUE", // required + * HoursOfOperationOverrideId: "STRING_VALUE", // required + * }; + * const command = new DescribeHoursOfOperationOverrideCommand(input); + * const response = await client.send(command); + * // { // DescribeHoursOfOperationOverrideResponse + * // HoursOfOperationOverride: { // HoursOfOperationOverride + * // HoursOfOperationOverrideId: "STRING_VALUE", + * // HoursOfOperationId: "STRING_VALUE", + * // HoursOfOperationArn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // Config: [ // HoursOfOperationOverrideConfigList + * // { // HoursOfOperationOverrideConfig + * // Day: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", + * // StartTime: { // OverrideTimeSlice + * // Hours: Number("int"), // required + * // Minutes: Number("int"), // required + * // }, + * // EndTime: { + * // Hours: Number("int"), // required + * // Minutes: Number("int"), // required + * // }, + * // }, + * // ], + * // EffectiveFrom: "STRING_VALUE", + * // EffectiveTill: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param DescribeHoursOfOperationOverrideCommandInput - {@link DescribeHoursOfOperationOverrideCommandInput} + * @returns {@link DescribeHoursOfOperationOverrideCommandOutput} + * @see {@link DescribeHoursOfOperationOverrideCommandInput} for command's `input` shape. + * @see {@link DescribeHoursOfOperationOverrideCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + * @public + */ +export class DescribeHoursOfOperationOverrideCommand extends $Command + .classBuilder< + DescribeHoursOfOperationOverrideCommandInput, + DescribeHoursOfOperationOverrideCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "DescribeHoursOfOperationOverride", {}) + .n("ConnectClient", "DescribeHoursOfOperationOverrideCommand") + .f(void 0, void 0) + .ser(se_DescribeHoursOfOperationOverrideCommand) + .de(de_DescribeHoursOfOperationOverrideCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeHoursOfOperationOverrideRequest; + output: DescribeHoursOfOperationOverrideResponse; + }; + sdk: { + input: DescribeHoursOfOperationOverrideCommandInput; + output: DescribeHoursOfOperationOverrideCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/GetEffectiveHoursOfOperationsCommand.ts b/clients/client-connect/src/commands/GetEffectiveHoursOfOperationsCommand.ts new file mode 100644 index 000000000000..a3cef7e8cfb8 --- /dev/null +++ b/clients/client-connect/src/commands/GetEffectiveHoursOfOperationsCommand.ts @@ -0,0 +1,132 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetEffectiveHoursOfOperationsRequest, GetEffectiveHoursOfOperationsResponse } from "../models/models_1"; +import { + de_GetEffectiveHoursOfOperationsCommand, + se_GetEffectiveHoursOfOperationsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetEffectiveHoursOfOperationsCommand}. + */ +export interface GetEffectiveHoursOfOperationsCommandInput extends GetEffectiveHoursOfOperationsRequest {} +/** + * @public + * + * The output of {@link GetEffectiveHoursOfOperationsCommand}. + */ +export interface GetEffectiveHoursOfOperationsCommandOutput + extends GetEffectiveHoursOfOperationsResponse, + __MetadataBearer {} + +/** + *Get the hours of operations with the effective override applied.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, GetEffectiveHoursOfOperationsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, GetEffectiveHoursOfOperationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // GetEffectiveHoursOfOperationsRequest + * InstanceId: "STRING_VALUE", // required + * HoursOfOperationId: "STRING_VALUE", // required + * FromDate: "STRING_VALUE", // required + * ToDate: "STRING_VALUE", // required + * }; + * const command = new GetEffectiveHoursOfOperationsCommand(input); + * const response = await client.send(command); + * // { // GetEffectiveHoursOfOperationsResponse + * // EffectiveHoursOfOperationList: [ // EffectiveHoursOfOperationList + * // { // EffectiveHoursOfOperations + * // Date: "STRING_VALUE", + * // OperationalHours: [ // OperationalHours + * // { // OperationalHour + * // Start: { // OverrideTimeSlice + * // Hours: Number("int"), // required + * // Minutes: Number("int"), // required + * // }, + * // End: { + * // Hours: Number("int"), // required + * // Minutes: Number("int"), // required + * // }, + * // }, + * // ], + * // }, + * // ], + * // TimeZone: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetEffectiveHoursOfOperationsCommandInput - {@link GetEffectiveHoursOfOperationsCommandInput} + * @returns {@link GetEffectiveHoursOfOperationsCommandOutput} + * @see {@link GetEffectiveHoursOfOperationsCommandInput} for command's `input` shape. + * @see {@link GetEffectiveHoursOfOperationsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + * @public + */ +export class GetEffectiveHoursOfOperationsCommand extends $Command + .classBuilder< + GetEffectiveHoursOfOperationsCommandInput, + GetEffectiveHoursOfOperationsCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "GetEffectiveHoursOfOperations", {}) + .n("ConnectClient", "GetEffectiveHoursOfOperationsCommand") + .f(void 0, void 0) + .ser(se_GetEffectiveHoursOfOperationsCommand) + .de(de_GetEffectiveHoursOfOperationsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetEffectiveHoursOfOperationsRequest; + output: GetEffectiveHoursOfOperationsResponse; + }; + sdk: { + input: GetEffectiveHoursOfOperationsCommandInput; + output: GetEffectiveHoursOfOperationsCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/ListHoursOfOperationOverridesCommand.ts b/clients/client-connect/src/commands/ListHoursOfOperationOverridesCommand.ts new file mode 100644 index 000000000000..a4f841607c77 --- /dev/null +++ b/clients/client-connect/src/commands/ListHoursOfOperationOverridesCommand.ts @@ -0,0 +1,141 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListHoursOfOperationOverridesRequest, ListHoursOfOperationOverridesResponse } from "../models/models_1"; +import { + de_ListHoursOfOperationOverridesCommand, + se_ListHoursOfOperationOverridesCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListHoursOfOperationOverridesCommand}. + */ +export interface ListHoursOfOperationOverridesCommandInput extends ListHoursOfOperationOverridesRequest {} +/** + * @public + * + * The output of {@link ListHoursOfOperationOverridesCommand}. + */ +export interface ListHoursOfOperationOverridesCommandOutput + extends ListHoursOfOperationOverridesResponse, + __MetadataBearer {} + +/** + *List the hours of operation overrides.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListHoursOfOperationOverridesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListHoursOfOperationOverridesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // ListHoursOfOperationOverridesRequest + * InstanceId: "STRING_VALUE", // required + * HoursOfOperationId: "STRING_VALUE", // required + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListHoursOfOperationOverridesCommand(input); + * const response = await client.send(command); + * // { // ListHoursOfOperationOverridesResponse + * // NextToken: "STRING_VALUE", + * // HoursOfOperationOverrideList: [ // HoursOfOperationOverrideList + * // { // HoursOfOperationOverride + * // HoursOfOperationOverrideId: "STRING_VALUE", + * // HoursOfOperationId: "STRING_VALUE", + * // HoursOfOperationArn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // Config: [ // HoursOfOperationOverrideConfigList + * // { // HoursOfOperationOverrideConfig + * // Day: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", + * // StartTime: { // OverrideTimeSlice + * // Hours: Number("int"), // required + * // Minutes: Number("int"), // required + * // }, + * // EndTime: { + * // Hours: Number("int"), // required + * // Minutes: Number("int"), // required + * // }, + * // }, + * // ], + * // EffectiveFrom: "STRING_VALUE", + * // EffectiveTill: "STRING_VALUE", + * // }, + * // ], + * // LastModifiedRegion: "STRING_VALUE", + * // LastModifiedTime: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param ListHoursOfOperationOverridesCommandInput - {@link ListHoursOfOperationOverridesCommandInput} + * @returns {@link ListHoursOfOperationOverridesCommandOutput} + * @see {@link ListHoursOfOperationOverridesCommandInput} for command's `input` shape. + * @see {@link ListHoursOfOperationOverridesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + * @public + */ +export class ListHoursOfOperationOverridesCommand extends $Command + .classBuilder< + ListHoursOfOperationOverridesCommandInput, + ListHoursOfOperationOverridesCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "ListHoursOfOperationOverrides", {}) + .n("ConnectClient", "ListHoursOfOperationOverridesCommand") + .f(void 0, void 0) + .ser(se_ListHoursOfOperationOverridesCommand) + .de(de_ListHoursOfOperationOverridesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListHoursOfOperationOverridesRequest; + output: ListHoursOfOperationOverridesResponse; + }; + sdk: { + input: ListHoursOfOperationOverridesCommandInput; + output: ListHoursOfOperationOverridesCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts b/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts index ecbab748b172..8f7e7d6356b9 100644 --- a/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts +++ b/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts @@ -6,8 +6,10 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListRealtimeContactAnalysisSegmentsV2Request } from "../models/models_1"; -import { ListRealtimeContactAnalysisSegmentsV2Response } from "../models/models_2"; +import { + ListRealtimeContactAnalysisSegmentsV2Request, + ListRealtimeContactAnalysisSegmentsV2Response, +} from "../models/models_2"; import { de_ListRealtimeContactAnalysisSegmentsV2Command, se_ListRealtimeContactAnalysisSegmentsV2Command, diff --git a/clients/client-connect/src/commands/SearchContactFlowModulesCommand.ts b/clients/client-connect/src/commands/SearchContactFlowModulesCommand.ts index ef3c5a813a4c..4a508c73710c 100644 --- a/clients/client-connect/src/commands/SearchContactFlowModulesCommand.ts +++ b/clients/client-connect/src/commands/SearchContactFlowModulesCommand.ts @@ -73,6 +73,8 @@ export interface SearchContactFlowModulesCommandOutput extends SearchContactFlow * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, + * StateCondition: "ACTIVE" || "ARCHIVED", + * StatusCondition: "PUBLISHED" || "SAVED", * }, * ], * AndConditions: [ @@ -83,6 +85,8 @@ export interface SearchContactFlowModulesCommandOutput extends SearchContactFlow * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, + * StateCondition: "ACTIVE" || "ARCHIVED", + * StatusCondition: "PUBLISHED" || "SAVED", * }, * }; * const command = new SearchContactFlowModulesCommand(input); diff --git a/clients/client-connect/src/commands/SearchHoursOfOperationOverridesCommand.ts b/clients/client-connect/src/commands/SearchHoursOfOperationOverridesCommand.ts new file mode 100644 index 000000000000..599242f03867 --- /dev/null +++ b/clients/client-connect/src/commands/SearchHoursOfOperationOverridesCommand.ts @@ -0,0 +1,194 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { SearchHoursOfOperationOverridesResponse } from "../models/models_2"; +import { SearchHoursOfOperationOverridesRequest } from "../models/models_3"; +import { + de_SearchHoursOfOperationOverridesCommand, + se_SearchHoursOfOperationOverridesCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link SearchHoursOfOperationOverridesCommand}. + */ +export interface SearchHoursOfOperationOverridesCommandInput extends SearchHoursOfOperationOverridesRequest {} +/** + * @public + * + * The output of {@link SearchHoursOfOperationOverridesCommand}. + */ +export interface SearchHoursOfOperationOverridesCommandOutput + extends SearchHoursOfOperationOverridesResponse, + __MetadataBearer {} + +/** + *Searches the hours of operation overrides.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, SearchHoursOfOperationOverridesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, SearchHoursOfOperationOverridesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // SearchHoursOfOperationOverridesRequest + * InstanceId: "STRING_VALUE", // required + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * SearchFilter: { // HoursOfOperationSearchFilter + * TagFilter: { // ControlPlaneTagFilter + * OrConditions: [ // TagOrConditionList + * [ // TagAndConditionList + * { // TagCondition + * TagKey: "STRING_VALUE", + * TagValue: "STRING_VALUE", + * }, + * ], + * ], + * AndConditions: [ + * { + * TagKey: "STRING_VALUE", + * TagValue: "STRING_VALUE", + * }, + * ], + * TagCondition: "Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + * @public + */ +export class SearchHoursOfOperationOverridesCommand extends $Command + .classBuilder< + SearchHoursOfOperationOverridesCommandInput, + SearchHoursOfOperationOverridesCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "SearchHoursOfOperationOverrides", {}) + .n("ConnectClient", "SearchHoursOfOperationOverridesCommand") + .f(void 0, void 0) + .ser(se_SearchHoursOfOperationOverridesCommand) + .de(de_SearchHoursOfOperationOverridesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: SearchHoursOfOperationOverridesRequest; + output: SearchHoursOfOperationOverridesResponse; + }; + sdk: { + input: SearchHoursOfOperationOverridesCommandInput; + output: SearchHoursOfOperationOverridesCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/UpdateHoursOfOperationOverrideCommand.ts b/clients/client-connect/src/commands/UpdateHoursOfOperationOverrideCommand.ts new file mode 100644 index 000000000000..28e847e0cc76 --- /dev/null +++ b/clients/client-connect/src/commands/UpdateHoursOfOperationOverrideCommand.ts @@ -0,0 +1,133 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateHoursOfOperationOverrideRequest } from "../models/models_2"; +import { + de_UpdateHoursOfOperationOverrideCommand, + se_UpdateHoursOfOperationOverrideCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateHoursOfOperationOverrideCommand}. + */ +export interface UpdateHoursOfOperationOverrideCommandInput extends UpdateHoursOfOperationOverrideRequest {} +/** + * @public + * + * The output of {@link UpdateHoursOfOperationOverrideCommand}. + */ +export interface UpdateHoursOfOperationOverrideCommandOutput extends __MetadataBearer {} + +/** + *Update the hours of operation override.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateHoursOfOperationOverrideCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateHoursOfOperationOverrideCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // UpdateHoursOfOperationOverrideRequest + * InstanceId: "STRING_VALUE", // required + * HoursOfOperationId: "STRING_VALUE", // required + * HoursOfOperationOverrideId: "STRING_VALUE", // required + * Name: "STRING_VALUE", + * Description: "STRING_VALUE", + * Config: [ // HoursOfOperationOverrideConfigList + * { // HoursOfOperationOverrideConfig + * Day: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", + * StartTime: { // OverrideTimeSlice + * Hours: Number("int"), // required + * Minutes: Number("int"), // required + * }, + * EndTime: { + * Hours: Number("int"), // required + * Minutes: Number("int"), // required + * }, + * }, + * ], + * EffectiveFrom: "STRING_VALUE", + * EffectiveTill: "STRING_VALUE", + * }; + * const command = new UpdateHoursOfOperationOverrideCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateHoursOfOperationOverrideCommandInput - {@link UpdateHoursOfOperationOverrideCommandInput} + * @returns {@link UpdateHoursOfOperationOverrideCommandOutput} + * @see {@link UpdateHoursOfOperationOverrideCommandInput} for command's `input` shape. + * @see {@link UpdateHoursOfOperationOverrideCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link ConditionalOperationFailedException} (client fault) + *Request processing failed because dependent condition failed.
+ * + * @throws {@link DuplicateResourceException} (client fault) + *A resource with the specified name already exists.
+ * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + * @public + */ +export class UpdateHoursOfOperationOverrideCommand extends $Command + .classBuilder< + UpdateHoursOfOperationOverrideCommandInput, + UpdateHoursOfOperationOverrideCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "UpdateHoursOfOperationOverride", {}) + .n("ConnectClient", "UpdateHoursOfOperationOverrideCommand") + .f(void 0, void 0) + .ser(se_UpdateHoursOfOperationOverrideCommand) + .de(de_UpdateHoursOfOperationOverrideCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateHoursOfOperationOverrideRequest; + output: {}; + }; + sdk: { + input: UpdateHoursOfOperationOverrideCommandInput; + output: UpdateHoursOfOperationOverrideCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts b/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts index 6306c9776b3e..e8549b069aeb 100644 --- a/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts +++ b/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts @@ -61,7 +61,7 @@ export interface UpdateQueueOutboundEmailConfigCommandOutput extends __MetadataB *You do not have sufficient permissions to perform this action.
* * @throws {@link ConditionalOperationFailedException} (client fault) - *A conditional check failed.
+ *Request processing failed because dependent condition failed.
* * @throws {@link InternalServiceException} (server fault) *Request processing failed because of an error or failure with the service.
diff --git a/clients/client-connect/src/commands/UpdateTaskTemplateCommand.ts b/clients/client-connect/src/commands/UpdateTaskTemplateCommand.ts index dc379e290246..13199fc8295f 100644 --- a/clients/client-connect/src/commands/UpdateTaskTemplateCommand.ts +++ b/clients/client-connect/src/commands/UpdateTaskTemplateCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateTaskTemplateRequest, UpdateTaskTemplateResponse } from "../models/models_2"; +import { UpdateTaskTemplateRequest } from "../models/models_2"; +import { UpdateTaskTemplateResponse } from "../models/models_3"; import { de_UpdateTaskTemplateCommand, se_UpdateTaskTemplateCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts b/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts index 454be078dbd5..555b49d278e6 100644 --- a/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts +++ b/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateTrafficDistributionRequest, UpdateTrafficDistributionResponse } from "../models/models_2"; +import { UpdateTrafficDistributionRequest, UpdateTrafficDistributionResponse } from "../models/models_3"; import { de_UpdateTrafficDistributionCommand, se_UpdateTrafficDistributionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserHierarchyCommand.ts b/clients/client-connect/src/commands/UpdateUserHierarchyCommand.ts index 116a429da150..01f8fb3f204b 100644 --- a/clients/client-connect/src/commands/UpdateUserHierarchyCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserHierarchyCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserHierarchyRequest } from "../models/models_2"; +import { UpdateUserHierarchyRequest } from "../models/models_3"; import { de_UpdateUserHierarchyCommand, se_UpdateUserHierarchyCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserHierarchyGroupNameCommand.ts b/clients/client-connect/src/commands/UpdateUserHierarchyGroupNameCommand.ts index b370bd420cbd..4dafe64775e6 100644 --- a/clients/client-connect/src/commands/UpdateUserHierarchyGroupNameCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserHierarchyGroupNameCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserHierarchyGroupNameRequest } from "../models/models_2"; +import { UpdateUserHierarchyGroupNameRequest } from "../models/models_3"; import { de_UpdateUserHierarchyGroupNameCommand, se_UpdateUserHierarchyGroupNameCommand, diff --git a/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts b/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts index ba897d6d6416..0e95c6cfa488 100644 --- a/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserHierarchyStructureRequest } from "../models/models_2"; +import { UpdateUserHierarchyStructureRequest } from "../models/models_3"; import { de_UpdateUserHierarchyStructureCommand, se_UpdateUserHierarchyStructureCommand, diff --git a/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts b/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts index bfb24fd5e64b..2dd09f2d6f44 100644 --- a/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserIdentityInfoRequest, UpdateUserIdentityInfoRequestFilterSensitiveLog } from "../models/models_2"; +import { UpdateUserIdentityInfoRequest, UpdateUserIdentityInfoRequestFilterSensitiveLog } from "../models/models_3"; import { de_UpdateUserIdentityInfoCommand, se_UpdateUserIdentityInfoCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts b/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts index 6a0fe9f19ab2..9d31664dacd8 100644 --- a/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserPhoneConfigRequest } from "../models/models_2"; +import { UpdateUserPhoneConfigRequest } from "../models/models_3"; import { de_UpdateUserPhoneConfigCommand, se_UpdateUserPhoneConfigCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserProficienciesCommand.ts b/clients/client-connect/src/commands/UpdateUserProficienciesCommand.ts index 9c9c723e6ac5..4b9cc3b77060 100644 --- a/clients/client-connect/src/commands/UpdateUserProficienciesCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserProficienciesCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserProficienciesRequest } from "../models/models_2"; +import { UpdateUserProficienciesRequest } from "../models/models_3"; import { de_UpdateUserProficienciesCommand, se_UpdateUserProficienciesCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts b/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts index fd07dec26dcb..f66e3ccb65ff 100644 --- a/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserRoutingProfileRequest } from "../models/models_2"; +import { UpdateUserRoutingProfileRequest } from "../models/models_3"; import { de_UpdateUserRoutingProfileCommand, se_UpdateUserRoutingProfileCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts b/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts index d2427a198daf..21d311470938 100644 --- a/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateUserSecurityProfilesRequest } from "../models/models_2"; +import { UpdateUserSecurityProfilesRequest } from "../models/models_3"; import { de_UpdateUserSecurityProfilesCommand, se_UpdateUserSecurityProfilesCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateViewContentCommand.ts b/clients/client-connect/src/commands/UpdateViewContentCommand.ts index a56d219af9da..6d778225cb57 100644 --- a/clients/client-connect/src/commands/UpdateViewContentCommand.ts +++ b/clients/client-connect/src/commands/UpdateViewContentCommand.ts @@ -11,7 +11,7 @@ import { UpdateViewContentRequestFilterSensitiveLog, UpdateViewContentResponse, UpdateViewContentResponseFilterSensitiveLog, -} from "../models/models_2"; +} from "../models/models_3"; import { de_UpdateViewContentCommand, se_UpdateViewContentCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateViewMetadataCommand.ts b/clients/client-connect/src/commands/UpdateViewMetadataCommand.ts index ad054aa72166..a175da33da66 100644 --- a/clients/client-connect/src/commands/UpdateViewMetadataCommand.ts +++ b/clients/client-connect/src/commands/UpdateViewMetadataCommand.ts @@ -10,7 +10,7 @@ import { UpdateViewMetadataRequest, UpdateViewMetadataRequestFilterSensitiveLog, UpdateViewMetadataResponse, -} from "../models/models_2"; +} from "../models/models_3"; import { de_UpdateViewMetadataCommand, se_UpdateViewMetadataCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/index.ts b/clients/client-connect/src/commands/index.ts index 595aaa8e2989..eaf942eae234 100644 --- a/clients/client-connect/src/commands/index.ts +++ b/clients/client-connect/src/commands/index.ts @@ -29,6 +29,7 @@ export * from "./CreateContactFlowVersionCommand"; export * from "./CreateEmailAddressCommand"; export * from "./CreateEvaluationFormCommand"; export * from "./CreateHoursOfOperationCommand"; +export * from "./CreateHoursOfOperationOverrideCommand"; export * from "./CreateInstanceCommand"; export * from "./CreateIntegrationAssociationCommand"; export * from "./CreateParticipantCommand"; @@ -57,6 +58,7 @@ export * from "./DeleteContactFlowModuleCommand"; export * from "./DeleteEmailAddressCommand"; export * from "./DeleteEvaluationFormCommand"; export * from "./DeleteHoursOfOperationCommand"; +export * from "./DeleteHoursOfOperationOverrideCommand"; export * from "./DeleteInstanceCommand"; export * from "./DeleteIntegrationAssociationCommand"; export * from "./DeletePredefinedAttributeCommand"; @@ -84,6 +86,7 @@ export * from "./DescribeContactFlowModuleCommand"; export * from "./DescribeEmailAddressCommand"; export * from "./DescribeEvaluationFormCommand"; export * from "./DescribeHoursOfOperationCommand"; +export * from "./DescribeHoursOfOperationOverrideCommand"; export * from "./DescribeInstanceAttributeCommand"; export * from "./DescribeInstanceCommand"; export * from "./DescribeInstanceStorageConfigCommand"; @@ -119,6 +122,7 @@ export * from "./GetAttachedFileCommand"; export * from "./GetContactAttributesCommand"; export * from "./GetCurrentMetricDataCommand"; export * from "./GetCurrentUserDataCommand"; +export * from "./GetEffectiveHoursOfOperationsCommand"; export * from "./GetFederationTokenCommand"; export * from "./GetFlowAssociationCommand"; export * from "./GetMetricDataCommand"; @@ -142,6 +146,7 @@ export * from "./ListDefaultVocabulariesCommand"; export * from "./ListEvaluationFormVersionsCommand"; export * from "./ListEvaluationFormsCommand"; export * from "./ListFlowAssociationsCommand"; +export * from "./ListHoursOfOperationOverridesCommand"; export * from "./ListHoursOfOperationsCommand"; export * from "./ListInstanceAttributesCommand"; export * from "./ListInstanceStorageConfigsCommand"; @@ -187,6 +192,7 @@ export * from "./SearchContactFlowModulesCommand"; export * from "./SearchContactFlowsCommand"; export * from "./SearchContactsCommand"; export * from "./SearchEmailAddressesCommand"; +export * from "./SearchHoursOfOperationOverridesCommand"; export * from "./SearchHoursOfOperationsCommand"; export * from "./SearchPredefinedAttributesCommand"; export * from "./SearchPromptsCommand"; @@ -237,6 +243,7 @@ export * from "./UpdateContactScheduleCommand"; export * from "./UpdateEmailAddressMetadataCommand"; export * from "./UpdateEvaluationFormCommand"; export * from "./UpdateHoursOfOperationCommand"; +export * from "./UpdateHoursOfOperationOverrideCommand"; export * from "./UpdateInstanceAttributeCommand"; export * from "./UpdateInstanceStorageConfigCommand"; export * from "./UpdateParticipantRoleConfigCommand"; diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts index c952fd180dc7..fbe7cdbd5d2d 100644 --- a/clients/client-connect/src/models/models_0.ts +++ b/clients/client-connect/src/models/models_0.ts @@ -3973,6 +3973,127 @@ export interface CreateHoursOfOperationResponse { HoursOfOperationArn?: string | undefined; } +/** + * @public + * @enum + */ +export const OverrideDays = { + FRIDAY: "FRIDAY", + MONDAY: "MONDAY", + SATURDAY: "SATURDAY", + SUNDAY: "SUNDAY", + THURSDAY: "THURSDAY", + TUESDAY: "TUESDAY", + WEDNESDAY: "WEDNESDAY", +} as const; + +/** + * @public + */ +export type OverrideDays = (typeof OverrideDays)[keyof typeof OverrideDays]; + +/** + *The start time or end time for an hours of operation override.
+ * @public + */ +export interface OverrideTimeSlice { + /** + *The hours.
+ * @public + */ + Hours: number | undefined; + + /** + *The minutes.
+ * @public + */ + Minutes: number | undefined; +} + +/** + *Information about the hours of operation override config: day, start time, and end + * time.
+ * @public + */ +export interface HoursOfOperationOverrideConfig { + /** + *The day that the hours of operation override applies to.
+ * @public + */ + Day?: OverrideDays | undefined; + + /** + *The start time when your contact center opens if overrides are applied.
+ * @public + */ + StartTime?: OverrideTimeSlice | undefined; + + /** + *The end time that your contact center closes if overrides are applied.
+ * @public + */ + EndTime?: OverrideTimeSlice | undefined; +} + +/** + * @public + */ +export interface CreateHoursOfOperationOverrideRequest { + /** + *The identifier of the Amazon Connect instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier for the hours of operation
+ * @public + */ + HoursOfOperationId: string | undefined; + + /** + *The name of the hours of operation override.
+ * @public + */ + Name: string | undefined; + + /** + *The description of the hours of operation override.
+ * @public + */ + Description?: string | undefined; + + /** + *Configuration information for the hours of operation override: day, start time, and end + * time.
+ * @public + */ + Config: HoursOfOperationOverrideConfig[] | undefined; + + /** + *The date from when the hours of operation override would be effective.
+ * @public + */ + EffectiveFrom: string | undefined; + + /** + *The date until when the hours of operation override would be effective.
+ * @public + */ + EffectiveTill: string | undefined; +} + +/** + * @public + */ +export interface CreateHoursOfOperationOverrideResponse { + /** + *The identifier for the hours of operation override.
+ * @public + */ + HoursOfOperationOverrideId?: string | undefined; +} + /** * @public * @enum @@ -4560,6 +4681,10 @@ export interface ContactConfiguration { /** *The role of the participant in the chat conversation.
+ *Only CUSTOMER
is currently supported. Any other values other than
+ * CUSTOMER
will result in an exception (4xx error).
The first name. This is required if you are using Amazon Connect or SAML for identity - * management.
+ * management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a + * non-NFC form (for example, decomposed characters or combining marks) are not accepted. * @public */ FirstName?: string | undefined; /** *The last name. This is required if you are using Amazon Connect or SAML for identity - * management.
+ * management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a + * non-NFC form (for example, decomposed characters or combining marks) are not accepted. * @public */ LastName?: string | undefined; @@ -6959,6 +7086,29 @@ export interface DeleteHoursOfOperationRequest { HoursOfOperationId: string | undefined; } +/** + * @public + */ +export interface DeleteHoursOfOperationOverrideRequest { + /** + *The identifier of the Amazon Connect instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier for the hours of operation.
+ * @public + */ + HoursOfOperationId: string | undefined; + + /** + *The identifier for the hours of operation override.
+ * @public + */ + HoursOfOperationOverrideId: string | undefined; +} + /** * @public */ @@ -7136,85 +7286,6 @@ export interface DeleteSecurityProfileRequest { SecurityProfileId: string | undefined; } -/** - * @public - */ -export interface DeleteTaskTemplateRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *A unique identifier for the task template.
- * @public - */ - TaskTemplateId: string | undefined; -} - -/** - * @public - */ -export interface DeleteTaskTemplateResponse {} - -/** - * @public - */ -export interface DeleteTrafficDistributionGroupRequest { - /** - *The identifier of the traffic distribution group. - * This can be the ID or the ARN of the traffic distribution group.
- * @public - */ - TrafficDistributionGroupId: string | undefined; -} - -/** - * @public - */ -export interface DeleteTrafficDistributionGroupResponse {} - -/** - * @public - */ -export interface DeleteUseCaseRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *The identifier for the integration association.
- * @public - */ - IntegrationAssociationId: string | undefined; - - /** - *The identifier for the use case.
- * @public - */ - UseCaseId: string | undefined; -} - -/** - * @public - */ -export interface DeleteUserRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *The identifier of the user.
- * @public - */ - UserId: string | undefined; -} - /** * @internal */ diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts index 821cd98c5c83..98537610a828 100644 --- a/clients/client-connect/src/models/models_1.ts +++ b/clients/client-connect/src/models/models_1.ts @@ -30,6 +30,7 @@ import { FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, + HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, @@ -39,8 +40,8 @@ import { MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, + OverrideTimeSlice, ParticipantCapabilities, - ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, @@ -65,6 +66,85 @@ import { VocabularyState, } from "./models_0"; +/** + * @public + */ +export interface DeleteTaskTemplateRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *A unique identifier for the task template.
+ * @public + */ + TaskTemplateId: string | undefined; +} + +/** + * @public + */ +export interface DeleteTaskTemplateResponse {} + +/** + * @public + */ +export interface DeleteTrafficDistributionGroupRequest { + /** + *The identifier of the traffic distribution group. + * This can be the ID or the ARN of the traffic distribution group.
+ * @public + */ + TrafficDistributionGroupId: string | undefined; +} + +/** + * @public + */ +export interface DeleteTrafficDistributionGroupResponse {} + +/** + * @public + */ +export interface DeleteUseCaseRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier for the integration association.
+ * @public + */ + IntegrationAssociationId: string | undefined; + + /** + *The identifier for the use case.
+ * @public + */ + UseCaseId: string | undefined; +} + +/** + * @public + */ +export interface DeleteUserRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier of the user.
+ * @public + */ + UserId: string | undefined; +} + /** * @public */ @@ -1316,6 +1396,95 @@ export interface DescribeHoursOfOperationResponse { HoursOfOperation?: HoursOfOperation | undefined; } +/** + * @public + */ +export interface DescribeHoursOfOperationOverrideRequest { + /** + *The identifier of the Amazon Connect instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier for the hours of operation.
+ * @public + */ + HoursOfOperationId: string | undefined; + + /** + *The identifier for the hours of operation override.
+ * @public + */ + HoursOfOperationOverrideId: string | undefined; +} + +/** + *Information about the hours of operations override.
+ * @public + */ +export interface HoursOfOperationOverride { + /** + *The identifier for the hours of operation override.
+ * @public + */ + HoursOfOperationOverrideId?: string | undefined; + + /** + *The identifier for the hours of operation.
+ * @public + */ + HoursOfOperationId?: string | undefined; + + /** + *The Amazon Resource Name (ARN) for the hours of operation.
+ * @public + */ + HoursOfOperationArn?: string | undefined; + + /** + *The name of the hours of operation override.
+ * @public + */ + Name?: string | undefined; + + /** + *The description of the hours of operation override.
+ * @public + */ + Description?: string | undefined; + + /** + *Configuration information for the hours of operation override: day, start time, and end + * time.
+ * @public + */ + Config?: HoursOfOperationOverrideConfig[] | undefined; + + /** + *The date from which the hours of operation override would be effective.
+ * @public + */ + EffectiveFrom?: string | undefined; + + /** + *The date till which the hours of operation override would be effective.
+ * @public + */ + EffectiveTill?: string | undefined; +} + +/** + * @public + */ +export interface DescribeHoursOfOperationOverrideResponse { + /** + *Information about the hours of operations override.
+ * @public + */ + HoursOfOperationOverride?: HoursOfOperationOverride | undefined; +} + /** * @public */ @@ -4607,6 +4776,88 @@ export interface GetCurrentUserDataResponse { ApproximateTotalCount?: number | undefined; } +/** + * @public + */ +export interface GetEffectiveHoursOfOperationsRequest { + /** + *The identifier of the Amazon Connect instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier for the hours of operation.
+ * @public + */ + HoursOfOperationId: string | undefined; + + /** + *The Date from when the hours of operation are listed.
+ * @public + */ + FromDate: string | undefined; + + /** + *The Date until when the hours of operation are listed.
+ * @public + */ + ToDate: string | undefined; +} + +/** + *Information about the hours of operations with the effective override applied.
+ * @public + */ +export interface OperationalHour { + /** + *The start time that your contact center opens.
+ * @public + */ + Start?: OverrideTimeSlice | undefined; + + /** + *The end time that your contact center closes.
+ * @public + */ + End?: OverrideTimeSlice | undefined; +} + +/** + *Information about the hours of operations with the effective override applied.
+ * @public + */ +export interface EffectiveHoursOfOperations { + /** + *The date that the hours of operation or overrides applies to.
+ * @public + */ + Date?: string | undefined; + + /** + *Information about the hours of operations with the effective override applied.
+ * @public + */ + OperationalHours?: OperationalHour[] | undefined; +} + +/** + * @public + */ +export interface GetEffectiveHoursOfOperationsResponse { + /** + *Information about the effective hours of operations
+ * @public + */ + EffectiveHoursOfOperationList?: EffectiveHoursOfOperations[] | undefined; + + /** + *The time zone for the hours of operation.
+ * @public + */ + TimeZone?: string | undefined; +} + /** * @public */ @@ -8407,6 +8658,67 @@ export interface ListFlowAssociationsResponse { NextToken?: string | undefined; } +/** + * @public + */ +export interface ListHoursOfOperationOverridesRequest { + /** + *The identifier of the Amazon Connect instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier for the hours of operation
+ * @public + */ + HoursOfOperationId: string | undefined; + + /** + *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.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The maximum number of results to return per page. The default MaxResult size is 100. Valid + * Range: Minimum value of 1. Maximum value of 1000.
+ * @public + */ + MaxResults?: number | undefined; +} + +/** + * @public + */ +export interface ListHoursOfOperationOverridesResponse { + /** + *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.
+ * @public + */ + NextToken?: string | undefined; + + /** + *Information about the hours of operation override.
+ * @public + */ + HoursOfOperationOverrideList?: HoursOfOperationOverride[] | undefined; + + /** + *The AWS Region where this resource was last modified.
+ * @public + */ + LastModifiedRegion?: string | undefined; + + /** + *The timestamp when this resource was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; +} + /** * @public */ @@ -9527,368 +9839,6 @@ export const RealTimeContactAnalysisSegmentType = { export type RealTimeContactAnalysisSegmentType = (typeof RealTimeContactAnalysisSegmentType)[keyof typeof RealTimeContactAnalysisSegmentType]; -/** - * @public - */ -export interface ListRealtimeContactAnalysisSegmentsV2Request { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *The identifier of the contact in this instance of Amazon Connect.
- * @public - */ - ContactId: string | undefined; - - /** - *The maximum number of results to return per page.
- * @public - */ - MaxResults?: number | undefined; - - /** - *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.
- * @public - */ - NextToken?: string | undefined; - - /** - *The Contact Lens output type to be returned.
- * @public - */ - OutputType: RealTimeContactAnalysisOutputType | undefined; - - /** - *Enum with segment types . Each value corresponds to a segment type returned in the segments - * list of the API. Each segment type has its own structure. Different channels may have different - * sets of supported segment types.
- * @public - */ - SegmentTypes: RealTimeContactAnalysisSegmentType[] | undefined; -} - -/** - * @public - * @enum - */ -export const RealTimeContactAnalysisSupportedChannel = { - CHAT: "CHAT", - VOICE: "VOICE", -} as const; - -/** - * @public - */ -export type RealTimeContactAnalysisSupportedChannel = - (typeof RealTimeContactAnalysisSupportedChannel)[keyof typeof RealTimeContactAnalysisSupportedChannel]; - -/** - * @public - * @enum - */ -export const ArtifactStatus = { - APPROVED: "APPROVED", - IN_PROGRESS: "IN_PROGRESS", - REJECTED: "REJECTED", -} as const; - -/** - * @public - */ -export type ArtifactStatus = (typeof ArtifactStatus)[keyof typeof ArtifactStatus]; - -/** - *Object that describes attached file.
- * @public - */ -export interface RealTimeContactAnalysisAttachment { - /** - *A case-sensitive name of the attachment being uploaded. Can be redacted.
- * @public - */ - AttachmentName: string | undefined; - - /** - *Describes the MIME file type of the attachment. For a list of supported file types, see - * Feature - * specifications in the Amazon Connect Administrator - * Guide.
- * @public - */ - ContentType?: string | undefined; - - /** - *A unique identifier for the attachment.
- * @public - */ - AttachmentId: string | undefined; - - /** - *Status of the attachment.
- * @public - */ - Status?: ArtifactStatus | undefined; -} - -/** - *Object describing time with which the segment is associated. It can have different - * representations of time. Currently supported: absoluteTime
- * @public - */ -export type RealTimeContactAnalysisTimeData = - | RealTimeContactAnalysisTimeData.AbsoluteTimeMember - | RealTimeContactAnalysisTimeData.$UnknownMember; - -/** - * @public - */ -export namespace RealTimeContactAnalysisTimeData { - /** - *Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, - * 2019-11-08T02:41:28.172Z.
- * @public - */ - export interface AbsoluteTimeMember { - AbsoluteTime: Date; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - AbsoluteTime?: never; - $unknown: [string, any]; - } - - export interface VisitorSegment containing list of attachments.
- * @public - */ -export interface RealTimeContactAnalysisSegmentAttachments { - /** - *The identifier of the segment.
- * @public - */ - Id: string | undefined; - - /** - *The identifier of the participant.
- * @public - */ - ParticipantId: string | undefined; - - /** - *The role of the participant. For example, is it a customer, agent, or system.
- * @public - */ - ParticipantRole: ParticipantRole | undefined; - - /** - *The display name of the participant. Can be redacted.
- * @public - */ - DisplayName?: string | undefined; - - /** - *List of objects describing an individual attachment.
- * @public - */ - Attachments: RealTimeContactAnalysisAttachment[] | undefined; - - /** - *Field describing the time of the event. It can have different representations of time.
- * @public - */ - Time: RealTimeContactAnalysisTimeData | undefined; -} - -/** - *Begin and end offsets for a part of text.
- * @public - */ -export interface RealTimeContactAnalysisCharacterInterval { - /** - *The beginning of the character interval.
- * @public - */ - BeginOffsetChar: number | undefined; - - /** - *The end of the character interval.
- * @public - */ - EndOffsetChar: number | undefined; -} - -/** - *Transcript representation containing Id and list of character intervals that are associated
- * with analysis data. For example, this object within a
- * RealTimeContactAnalysisPointOfInterest
in Category.MatchedDetails
- * would have character interval describing part of the text that matched category.
Transcript identifier. Matches the identifier from one of the TranscriptSegments.
- * @public - */ - Id: string | undefined; - - /** - *List of character intervals within transcript content/text.
- * @public - */ - CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined; -} - -/** - *The section of the contact transcript segment that category rule was detected.
- * @public - */ -export interface RealTimeContactAnalysisPointOfInterest { - /** - *List of the transcript items (segments) that are associated with a given point of interest. - *
- * @public - */ - TranscriptItems?: RealTimeContactAnalysisTranscriptItemWithCharacterOffsets[] | undefined; -} - -/** - *Provides information about the category rule that was matched.
- * @public - */ -export interface RealTimeContactAnalysisCategoryDetails { - /** - *List of PointOfInterest - objects describing a single match of a rule.
- * @public - */ - PointsOfInterest: RealTimeContactAnalysisPointOfInterest[] | undefined; -} - -/** - *The matched category rules.
- * @public - */ -export interface RealTimeContactAnalysisSegmentCategories { - /** - *Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.
- * @public - */ - MatchedDetails: RecordSegment type describing a contact event.
- * @public - */ -export interface RealTimeContactAnalysisSegmentEvent { - /** - *The identifier of the contact event.
- * @public - */ - Id: string | undefined; - - /** - *The identifier of the participant.
- * @public - */ - ParticipantId?: string | undefined; - - /** - *The role of the participant. For example, is it a customer, agent, or system.
- * @public - */ - ParticipantRole?: ParticipantRole | undefined; - - /** - *The display name of the participant. Can be redacted.
- * @public - */ - DisplayName?: string | undefined; - - /** - *Type of the event. For example,
- * application/vnd.amazonaws.connect.event.participant.left
.
Field describing the time of the event. It can have different representations of time.
- * @public - */ - Time: RealTimeContactAnalysisTimeData | undefined; -} - -/** - *Transcript representation containing Id, Content and list of character intervals that are - * associated with analysis data. For example, this object within an issue detected would describe - * both content that contains identified issue and intervals where that content is taken - * from.
- * @public - */ -export interface RealTimeContactAnalysisTranscriptItemWithContent { - /** - *Part of the transcript content that contains identified issue. Can be redacted
- * @public - */ - Content?: string | undefined; - - /** - *Transcript identifier. Matches the identifier from one of the TranscriptSegments.
- * @public - */ - Id: string | undefined; - - /** - *Begin and end offsets for a part of text.
- * @public - */ - CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined; -} - -/** - *Potential issues that are detected based on an artificial intelligence analysis of each turn - * in the conversation.
- * @public - */ -export interface RealTimeContactAnalysisIssueDetected { - /** - *List of the transcript items (segments) that are associated with a given issue.
- * @public - */ - TranscriptItems: RealTimeContactAnalysisTranscriptItemWithContent[] | undefined; -} - -/** - *Segment type containing a list of detected issues.
- * @public - */ -export interface RealTimeContactAnalysisSegmentIssues { - /** - *List of the issues detected.
- * @public - */ - IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined; -} - /** * @internal */ diff --git a/clients/client-connect/src/models/models_2.ts b/clients/client-connect/src/models/models_2.ts index e962f378e12a..f3fa67baa2bc 100644 --- a/clients/client-connect/src/models/models_2.ts +++ b/clients/client-connect/src/models/models_2.ts @@ -6,7 +6,6 @@ import { ConnectServiceException as __BaseException } from "./ConnectServiceExce import { ActionSummary, AgentAvailabilityTimer, - AgentConfig, AgentHierarchyGroups, AgentStatus, AgentStatusState, @@ -16,11 +15,11 @@ import { ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, - EvaluationFormQuestion, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, + HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, @@ -43,14 +42,8 @@ import { TaskTemplateField, TaskTemplateStatus, UseCaseType, - UserIdentityInfo, - UserIdentityInfoFilterSensitiveLog, UserPhoneConfig, UserProficiency, - View, - ViewFilterSensitiveLog, - ViewInputContent, - ViewInputContentFilterSensitiveLog, ViewStatus, ViewType, VocabularyLanguageCode, @@ -67,6 +60,7 @@ import { HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, + HoursOfOperationOverride, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, @@ -75,143 +69,169 @@ import { Queue, QueueStatus, QuickConnect, - RealTimeContactAnalysisCharacterInterval, - RealTimeContactAnalysisSegmentAttachments, - RealTimeContactAnalysisSegmentCategories, - RealTimeContactAnalysisSegmentEvent, - RealTimeContactAnalysisSegmentIssues, - RealTimeContactAnalysisSupportedChannel, - RealTimeContactAnalysisTimeData, + RealTimeContactAnalysisOutputType, + RealTimeContactAnalysisSegmentType, RoutingProfile, - SignInConfig, SortOrder, - TelephonyConfig, TrafficDistributionGroupStatus, } from "./models_1"; -import { EvaluationFormSection } from "./models_3"; +/** + * @public + */ +export interface ListRealtimeContactAnalysisSegmentsV2Request { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier of the contact in this instance of Amazon Connect.
+ * @public + */ + ContactId: string | undefined; + + /** + *The maximum number of results to return per page.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *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.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The Contact Lens output type to be returned.
+ * @public + */ + OutputType: RealTimeContactAnalysisOutputType | undefined; + + /** + *Enum with segment types . Each value corresponds to a segment type returned in the segments + * list of the API. Each segment type has its own structure. Different channels may have different + * sets of supported segment types.
+ * @public + */ + SegmentTypes: RealTimeContactAnalysisSegmentType[] | undefined; +} /** * @public * @enum */ -export const RealTimeContactAnalysisPostContactSummaryFailureCode = { - FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES", - INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT", - INTERNAL_ERROR: "INTERNAL_ERROR", - INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION", - QUOTA_EXCEEDED: "QUOTA_EXCEEDED", +export const RealTimeContactAnalysisSupportedChannel = { + CHAT: "CHAT", + VOICE: "VOICE", } as const; /** * @public */ -export type RealTimeContactAnalysisPostContactSummaryFailureCode = - (typeof RealTimeContactAnalysisPostContactSummaryFailureCode)[keyof typeof RealTimeContactAnalysisPostContactSummaryFailureCode]; +export type RealTimeContactAnalysisSupportedChannel = + (typeof RealTimeContactAnalysisSupportedChannel)[keyof typeof RealTimeContactAnalysisSupportedChannel]; /** * @public * @enum */ -export const RealTimeContactAnalysisPostContactSummaryStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", +export const ArtifactStatus = { + APPROVED: "APPROVED", + IN_PROGRESS: "IN_PROGRESS", + REJECTED: "REJECTED", } as const; /** * @public */ -export type RealTimeContactAnalysisPostContactSummaryStatus = - (typeof RealTimeContactAnalysisPostContactSummaryStatus)[keyof typeof RealTimeContactAnalysisPostContactSummaryStatus]; +export type ArtifactStatus = (typeof ArtifactStatus)[keyof typeof ArtifactStatus]; /** - *Information about the post-contact summary for a real-time contact segment.
+ *Object that describes attached file.
* @public */ -export interface RealTimeContactAnalysisSegmentPostContactSummary { +export interface RealTimeContactAnalysisAttachment { /** - *The content of the summary.
+ *A case-sensitive name of the attachment being uploaded. Can be redacted.
* @public */ - Content?: string | undefined; + AttachmentName: string | undefined; /** - *Whether the summary was successfully COMPLETED or FAILED to be generated.
+ *Describes the MIME file type of the attachment. For a list of supported file types, see + * Feature + * specifications in the Amazon Connect Administrator + * Guide.
* @public */ - Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined; + ContentType?: string | undefined; /** - *If the summary failed to be generated, one of the following failure codes occurs:
- *
- * QUOTA_EXCEEDED
: The number of concurrent analytics jobs reached your service
- * quota.
- * INSUFFICIENT_CONVERSATION_CONTENT
: The conversation needs to have at least
- * one turn from both the participants in order to generate the summary.
- * FAILED_SAFETY_GUIDELINES
: The generated summary cannot be provided because it
- * failed to meet system safety guidelines.
- * INVALID_ANALYSIS_CONFIGURATION
: This code occurs when, for example, you're
- * using a language that isn't supported by generative AI-powered post-contact summaries.
- *
- * INTERNAL_ERROR
: Internal system error.
A unique identifier for the attachment.
* @public */ - FailureCode?: RealTimeContactAnalysisPostContactSummaryFailureCode | undefined; -} + AttachmentId: string | undefined; -/** - *Object describing redaction applied to the segment.
- * @public - */ -export interface RealTimeContactAnalysisTranscriptItemRedaction { /** - *List of character intervals each describing a part of the text that was redacted. For
- * OutputType.Raw
, part of the original text that contains data that can be redacted.
- * For OutputType.Redacted
, part of the string with redaction tag.
Status of the attachment.
* @public */ - CharacterOffsets?: RealTimeContactAnalysisCharacterInterval[] | undefined; + Status?: ArtifactStatus | undefined; } /** + *Object describing time with which the segment is associated. It can have different + * representations of time. Currently supported: absoluteTime
* @public - * @enum */ -export const RealTimeContactAnalysisSentimentLabel = { - NEGATIVE: "NEGATIVE", - NEUTRAL: "NEUTRAL", - POSITIVE: "POSITIVE", -} as const; +export type RealTimeContactAnalysisTimeData = + | RealTimeContactAnalysisTimeData.AbsoluteTimeMember + | RealTimeContactAnalysisTimeData.$UnknownMember; /** * @public */ -export type RealTimeContactAnalysisSentimentLabel = - (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel]; +export namespace RealTimeContactAnalysisTimeData { + /** + *Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, + * 2019-11-08T02:41:28.172Z.
+ * @public + */ + export interface AbsoluteTimeMember { + AbsoluteTime: Date; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + AbsoluteTime?: never; + $unknown: [string, any]; + } + + export interface VisitorThe analyzed transcript segment.
+ *Segment containing list of attachments.
* @public */ -export interface RealTimeContactAnalysisSegmentTranscript { +export interface RealTimeContactAnalysisSegmentAttachments { /** - *The identifier of the transcript.
+ *The identifier of the segment.
* @public */ Id: string | undefined; @@ -229,731 +249,590 @@ export interface RealTimeContactAnalysisSegmentTranscript { ParticipantRole: ParticipantRole | undefined; /** - *The display name of the participant.
+ *The display name of the participant. Can be redacted.
* @public */ DisplayName?: string | undefined; /** - *The content of the transcript. Can be redacted.
+ *List of objects describing an individual attachment.
* @public */ - Content: string | undefined; + Attachments: RealTimeContactAnalysisAttachment[] | undefined; /** - *The type of content of the item. For example, text/plain
.
Field describing the time of the event. It can have different representations of time.
* @public */ - ContentType?: string | undefined; + Time: RealTimeContactAnalysisTimeData | undefined; +} +/** + *Begin and end offsets for a part of text.
+ * @public + */ +export interface RealTimeContactAnalysisCharacterInterval { /** - *Field describing the time of the event. It can have different representations of time.
+ *The beginning of the character interval.
* @public */ - Time: RealTimeContactAnalysisTimeData | undefined; + BeginOffsetChar: number | undefined; /** - *Object describing redaction that was applied to the transcript. If transcript has the field - * it means part of the transcript was redacted.
+ *The end of the character interval.
* @public */ - Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined; + EndOffsetChar: number | undefined; +} +/** + *Transcript representation containing Id and list of character intervals that are associated
+ * with analysis data. For example, this object within a
+ * RealTimeContactAnalysisPointOfInterest
in Category.MatchedDetails
+ * would have character interval describing part of the text that matched category.
The sentiment detected for this piece of transcript.
+ *Transcript identifier. Matches the identifier from one of the TranscriptSegments.
* @public */ - Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined; + Id: string | undefined; + + /** + *List of character intervals within transcript content/text.
+ * @public + */ + CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined; } /** - *An analyzed segment for a real-time analysis session.
+ *The section of the contact transcript segment that category rule was detected.
* @public */ -export type RealtimeContactAnalysisSegment = - | RealtimeContactAnalysisSegment.AttachmentsMember - | RealtimeContactAnalysisSegment.CategoriesMember - | RealtimeContactAnalysisSegment.EventMember - | RealtimeContactAnalysisSegment.IssuesMember - | RealtimeContactAnalysisSegment.PostContactSummaryMember - | RealtimeContactAnalysisSegment.TranscriptMember - | RealtimeContactAnalysisSegment.$UnknownMember; +export interface RealTimeContactAnalysisPointOfInterest { + /** + *List of the transcript items (segments) that are associated with a given point of interest. + *
+ * @public + */ + TranscriptItems?: RealTimeContactAnalysisTranscriptItemWithCharacterOffsets[] | undefined; +} /** + *Provides information about the category rule that was matched.
* @public */ -export namespace RealtimeContactAnalysisSegment { +export interface RealTimeContactAnalysisCategoryDetails { /** - *The analyzed transcript segment.
+ *List of PointOfInterest - objects describing a single match of a rule.
* @public */ - export interface TranscriptMember { - Transcript: RealTimeContactAnalysisSegmentTranscript; - Categories?: never; - Issues?: never; - Event?: never; - Attachments?: never; - PostContactSummary?: never; - $unknown?: never; - } + PointsOfInterest: RealTimeContactAnalysisPointOfInterest[] | undefined; +} +/** + *The matched category rules.
+ * @public + */ +export interface RealTimeContactAnalysisSegmentCategories { /** - *The matched category rules.
+ *Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.
* @public */ - export interface CategoriesMember { - Transcript?: never; - Categories: RealTimeContactAnalysisSegmentCategories; - Issues?: never; - Event?: never; - Attachments?: never; - PostContactSummary?: never; - $unknown?: never; - } + MatchedDetails: RecordSegment type describing a contact event.
+ * @public + */ +export interface RealTimeContactAnalysisSegmentEvent { /** - *Segment type containing a list of detected issues.
+ *The identifier of the contact event.
* @public */ - export interface IssuesMember { - Transcript?: never; - Categories?: never; - Issues: RealTimeContactAnalysisSegmentIssues; - Event?: never; - Attachments?: never; - PostContactSummary?: never; - $unknown?: never; - } + Id: string | undefined; /** - *Segment type describing a contact event.
+ *The identifier of the participant.
* @public */ - export interface EventMember { - Transcript?: never; - Categories?: never; - Issues?: never; - Event: RealTimeContactAnalysisSegmentEvent; - Attachments?: never; - PostContactSummary?: never; - $unknown?: never; - } + ParticipantId?: string | undefined; /** - *The analyzed attachments.
+ *The role of the participant. For example, is it a customer, agent, or system.
* @public */ - export interface AttachmentsMember { - Transcript?: never; - Categories?: never; - Issues?: never; - Event?: never; - Attachments: RealTimeContactAnalysisSegmentAttachments; - PostContactSummary?: never; - $unknown?: never; - } + ParticipantRole?: ParticipantRole | undefined; /** - *Information about the post-contact summary.
+ *The display name of the participant. Can be redacted.
* @public */ - export interface PostContactSummaryMember { - Transcript?: never; - Categories?: never; - Issues?: never; - Event?: never; - Attachments?: never; - PostContactSummary: RealTimeContactAnalysisSegmentPostContactSummary; - $unknown?: never; - } + DisplayName?: string | undefined; /** + *Type of the event. For example,
+ * application/vnd.amazonaws.connect.event.participant.left
.
Field describing the time of the event. It can have different representations of time.
+ * @public + */ + Time: RealTimeContactAnalysisTimeData | undefined; } /** - * @public - * @enum - */ -export const RealTimeContactAnalysisStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", -} as const; - -/** - * @public - */ -export type RealTimeContactAnalysisStatus = - (typeof RealTimeContactAnalysisStatus)[keyof typeof RealTimeContactAnalysisStatus]; - -/** + *Transcript representation containing Id, Content and list of character intervals that are + * associated with analysis data. For example, this object within an issue detected would describe + * both content that contains identified issue and intervals where that content is taken + * from.
* @public */ -export interface ListRealtimeContactAnalysisSegmentsV2Response { +export interface RealTimeContactAnalysisTranscriptItemWithContent { /** - *The channel of the contact. Voice
will not be returned.
Part of the transcript content that contains identified issue. Can be redacted
* @public */ - Channel: RealTimeContactAnalysisSupportedChannel | undefined; - - /** - *Status of real-time contact analysis.
- * @public - */ - Status: RealTimeContactAnalysisStatus | undefined; + Content?: string | undefined; /** - *An analyzed transcript or category.
+ *Transcript identifier. Matches the identifier from one of the TranscriptSegments.
* @public */ - Segments: RealtimeContactAnalysisSegment[] | undefined; + Id: string | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *Begin and end offsets for a part of text.
* @public */ - NextToken?: string | undefined; + CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined; } /** - *Thrown for analyzed content when requested OutputType was not enabled for a given contact. - * For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction - * policy set in the flow.
+ *Potential issues that are detected based on an artificial intelligence analysis of each turn + * in the conversation.
* @public */ -export class OutputTypeNotFoundException extends __BaseException { - readonly name: "OutputTypeNotFoundException" = "OutputTypeNotFoundException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; +export interface RealTimeContactAnalysisIssueDetected { /** - * @internal + *List of the transcript items (segments) that are associated with a given issue.
+ * @public */ - constructor(opts: __ExceptionOptionTypeSegment type containing a list of detected issues.
* @public */ -export interface ListRoutingProfileQueuesRequest { +export interface RealTimeContactAnalysisSegmentIssues { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *List of the issues detected.
* @public */ - InstanceId: string | undefined; - - /** - *The identifier of the routing profile.
- * @public - */ - RoutingProfileId: string | undefined; - - /** - *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.
- * @public - */ - NextToken?: string | undefined; - - /** - *The maximum number of results to return per page. The default MaxResult size is 100.
- * @public - */ - MaxResults?: number | undefined; + IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined; } /** - *Contains summary information about a routing profile queue.
* @public + * @enum */ -export interface RoutingProfileQueueConfigSummary { - /** - *The identifier for the queue.
- * @public - */ - QueueId: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the queue.
- * @public - */ - QueueArn: string | undefined; - - /** - *The name of the queue.
- * @public - */ - QueueName: string | undefined; - - /** - *The order in which contacts are to be handled for the queue. For more information, see - * Queues: priority and - * delay.
- * @public - */ - Priority: number | undefined; - - /** - *The delay, in seconds, that a contact should be in the queue before they are routed to an - * available agent. For more information, see Queues: priority and - * delay in the Amazon Connect Administrator Guide.
- * @public - */ - Delay: number | undefined; - - /** - *The channels this queue supports.
- * @public - */ - Channel: Channel | undefined; -} +export const RealTimeContactAnalysisPostContactSummaryFailureCode = { + FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES", + INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT", + INTERNAL_ERROR: "INTERNAL_ERROR", + INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION", + QUOTA_EXCEEDED: "QUOTA_EXCEEDED", +} as const; /** * @public */ -export interface ListRoutingProfileQueuesResponse { - /** - *If there are additional results, this is the token for the next set of results.
- * @public - */ - NextToken?: string | undefined; - - /** - *Information about the routing profiles.
- * @public - */ - RoutingProfileQueueConfigSummaryList?: RoutingProfileQueueConfigSummary[] | undefined; - - /** - *The timestamp when this resource was last modified.
- * @public - */ - LastModifiedTime?: Date | undefined; - - /** - *The Amazon Web Services Region where this resource was last modified.
- * @public - */ - LastModifiedRegion?: string | undefined; -} +export type RealTimeContactAnalysisPostContactSummaryFailureCode = + (typeof RealTimeContactAnalysisPostContactSummaryFailureCode)[keyof typeof RealTimeContactAnalysisPostContactSummaryFailureCode]; /** * @public + * @enum */ -export interface ListRoutingProfilesRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *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.
- * @public - */ - NextToken?: string | undefined; - - /** - *The maximum number of results to return per page. The default MaxResult size is 100.
- * @public - */ - MaxResults?: number | undefined; -} +export const RealTimeContactAnalysisPostContactSummaryStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", +} as const; /** - *Contains summary information about a routing profile.
* @public */ -export interface RoutingProfileSummary { - /** - *The identifier of the routing profile.
- * @public - */ - Id?: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the routing profile.
- * @public - */ - Arn?: string | undefined; +export type RealTimeContactAnalysisPostContactSummaryStatus = + (typeof RealTimeContactAnalysisPostContactSummaryStatus)[keyof typeof RealTimeContactAnalysisPostContactSummaryStatus]; +/** + *Information about the post-contact summary for a real-time contact segment.
+ * @public + */ +export interface RealTimeContactAnalysisSegmentPostContactSummary { /** - *The name of the routing profile.
+ *The content of the summary.
* @public */ - Name?: string | undefined; + Content?: string | undefined; /** - *The timestamp when this resource was last modified.
+ *Whether the summary was successfully COMPLETED or FAILED to be generated.
* @public */ - LastModifiedTime?: Date | undefined; + Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined; /** - *The Amazon Web Services Region where this resource was last modified.
+ *If the summary failed to be generated, one of the following failure codes occurs:
+ *
+ * QUOTA_EXCEEDED
: The number of concurrent analytics jobs reached your service
+ * quota.
+ * INSUFFICIENT_CONVERSATION_CONTENT
: The conversation needs to have at least
+ * one turn from both the participants in order to generate the summary.
+ * FAILED_SAFETY_GUIDELINES
: The generated summary cannot be provided because it
+ * failed to meet system safety guidelines.
+ * INVALID_ANALYSIS_CONFIGURATION
: This code occurs when, for example, you're
+ * using a language that isn't supported by generative AI-powered post-contact summaries.
+ *
+ * INTERNAL_ERROR
: Internal system error.
Object describing redaction applied to the segment.
* @public */ -export interface ListRoutingProfilesResponse { - /** - *Information about the routing profiles.
- * @public - */ - RoutingProfileSummaryList?: RoutingProfileSummary[] | undefined; - +export interface RealTimeContactAnalysisTranscriptItemRedaction { /** - *If there are additional results, this is the token for the next set of results.
+ *List of character intervals each describing a part of the text that was redacted. For
+ * OutputType.Raw
, part of the original text that contains data that can be redacted.
+ * For OutputType.Redacted
, part of the string with redaction tag.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *The publish status of the rule.
- * @public - */ - PublishStatus?: RulePublishStatus | undefined; - - /** - *The name of the event source.
- * @public - */ - EventSourceName?: EventSourceName | undefined; - - /** - *The maximum number of results to return per page.
- * @public - */ - MaxResults?: number | undefined; - - /** - *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.
- * @public - */ - NextToken?: string | undefined; -} +export const RealTimeContactAnalysisSentimentLabel = { + NEGATIVE: "NEGATIVE", + NEUTRAL: "NEUTRAL", + POSITIVE: "POSITIVE", +} as const; /** - *A list of ActionTypes
associated with a rule.
The name of the rule.
- * @public - */ - Name: string | undefined; - - /** - *A unique identifier for the rule.
- * @public - */ - RuleId: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the rule.
- * @public - */ - RuleArn: string | undefined; - - /** - *The name of the event source.
- * @public - */ - EventSourceName: EventSourceName | undefined; - - /** - *The publish status of the rule.
- * @public - */ - PublishStatus: RulePublishStatus | undefined; - - /** - *A list of ActionTypes associated with a rule.
- * @public - */ - ActionSummaries: ActionSummary[] | undefined; +export type RealTimeContactAnalysisSentimentLabel = + (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel]; +/** + *The analyzed transcript segment.
+ * @public + */ +export interface RealTimeContactAnalysisSegmentTranscript { /** - *The timestamp for when the rule was created.
+ *The identifier of the transcript.
* @public */ - CreatedTime: Date | undefined; + Id: string | undefined; /** - *The timestamp for when the rule was last updated.
+ *The identifier of the participant.
* @public */ - LastUpdatedTime: Date | undefined; -} + ParticipantId: string | undefined; -/** - * @public - */ -export interface ListRulesResponse { /** - *Summary information about a rule.
+ *The role of the participant. For example, is it a customer, agent, or system.
* @public */ - RuleSummaryList: RuleSummary[] | undefined; + ParticipantRole: ParticipantRole | undefined; /** - *If there are additional results, this is the token for the next set of results.
- * @public - */ - NextToken?: string | undefined; -} - -/** - * @public - */ -export interface ListSecurityKeysRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The display name of the participant.
* @public */ - InstanceId: string | undefined; + DisplayName?: string | undefined; /** - *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.
+ *The content of the transcript. Can be redacted.
* @public */ - NextToken?: string | undefined; + Content: string | undefined; /** - *The maximum number of results to return per page.
+ *The type of content of the item. For example, text/plain
.
Configuration information of the security key.
- * @public - */ -export interface SecurityKey { /** - *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
+ *Field describing the time of the event. It can have different representations of time.
* @public */ - AssociationId?: string | undefined; + Time: RealTimeContactAnalysisTimeData | undefined; /** - *The key of the security key.
+ *Object describing redaction that was applied to the transcript. If transcript has the field + * it means part of the transcript was redacted.
* @public */ - Key?: string | undefined; + Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined; /** - *When the security key was created.
+ *The sentiment detected for this piece of transcript.
* @public */ - CreationTime?: Date | undefined; + Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined; } /** + *An analyzed segment for a real-time analysis session.
* @public */ -export interface ListSecurityKeysResponse { - /** - *The security keys.
- * @public - */ - SecurityKeys?: SecurityKey[] | undefined; - - /** - *If there are additional results, this is the token for the next set of results.
- * @public - */ - NextToken?: string | undefined; -} +export type RealtimeContactAnalysisSegment = + | RealtimeContactAnalysisSegment.AttachmentsMember + | RealtimeContactAnalysisSegment.CategoriesMember + | RealtimeContactAnalysisSegment.EventMember + | RealtimeContactAnalysisSegment.IssuesMember + | RealtimeContactAnalysisSegment.PostContactSummaryMember + | RealtimeContactAnalysisSegment.TranscriptMember + | RealtimeContactAnalysisSegment.$UnknownMember; /** * @public */ -export interface ListSecurityProfileApplicationsRequest { +export namespace RealtimeContactAnalysisSegment { /** - *The identifier for the security profle.
+ *The analyzed transcript segment.
* @public */ - SecurityProfileId: string | undefined; + export interface TranscriptMember { + Transcript: RealTimeContactAnalysisSegmentTranscript; + Categories?: never; + Issues?: never; + Event?: never; + Attachments?: never; + PostContactSummary?: never; + $unknown?: never; + } /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The matched category rules.
* @public */ - InstanceId: string | undefined; + export interface CategoriesMember { + Transcript?: never; + Categories: RealTimeContactAnalysisSegmentCategories; + Issues?: never; + Event?: never; + Attachments?: never; + PostContactSummary?: never; + $unknown?: never; + } /** - *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.
+ *Segment type containing a list of detected issues.
* @public */ - NextToken?: string | undefined; + export interface IssuesMember { + Transcript?: never; + Categories?: never; + Issues: RealTimeContactAnalysisSegmentIssues; + Event?: never; + Attachments?: never; + PostContactSummary?: never; + $unknown?: never; + } /** - *The maximum number of results to return per page.
+ *Segment type describing a contact event.
* @public */ - MaxResults?: number | undefined; -} + export interface EventMember { + Transcript?: never; + Categories?: never; + Issues?: never; + Event: RealTimeContactAnalysisSegmentEvent; + Attachments?: never; + PostContactSummary?: never; + $unknown?: never; + } -/** - * @public - */ -export interface ListSecurityProfileApplicationsResponse { /** - *A list of the third-party application's metadata.
+ *The analyzed attachments.
* @public */ - Applications?: Application[] | undefined; + export interface AttachmentsMember { + Transcript?: never; + Categories?: never; + Issues?: never; + Event?: never; + Attachments: RealTimeContactAnalysisSegmentAttachments; + PostContactSummary?: never; + $unknown?: never; + } /** - *If there are additional results, this is the token for the next set of results.
+ *Information about the post-contact summary.
* @public */ - NextToken?: string | undefined; + export interface PostContactSummaryMember { + Transcript?: never; + Categories?: never; + Issues?: never; + Event?: never; + Attachments?: never; + PostContactSummary: RealTimeContactAnalysisSegmentPostContactSummary; + $unknown?: never; + } /** - *The timestamp when this resource was last modified.
* @public */ - LastModifiedTime?: Date | undefined; + export interface $UnknownMember { + Transcript?: never; + Categories?: never; + Issues?: never; + Event?: never; + Attachments?: never; + PostContactSummary?: never; + $unknown: [string, any]; + } - /** - *The Amazon Web Services Region where this resource was last modified.
- * @public - */ - LastModifiedRegion?: string | undefined; + export interface VisitorThe identifier for the security profle.
- * @public - */ - SecurityProfileId: string | undefined; +export const RealTimeContactAnalysisStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", +} as const; - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; +/** + * @public + */ +export type RealTimeContactAnalysisStatus = + (typeof RealTimeContactAnalysisStatus)[keyof typeof RealTimeContactAnalysisStatus]; +/** + * @public + */ +export interface ListRealtimeContactAnalysisSegmentsV2Response { /** - *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.
+ *The channel of the contact. Voice
will not be returned.
The maximum number of results to return per page.
+ *Status of real-time contact analysis.
* @public */ - MaxResults?: number | undefined; -} + Status: RealTimeContactAnalysisStatus | undefined; -/** - * @public - */ -export interface ListSecurityProfilePermissionsResponse { /** - *The permissions granted to the security profile. For a complete list of valid permissions, - * see List - * of security profile permissions.
+ *An analyzed transcript or category.
* @public */ - Permissions?: string[] | undefined; + Segments: RealtimeContactAnalysisSegment[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; +} +/** + *Thrown for analyzed content when requested OutputType was not enabled for a given contact. + * For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction + * policy set in the flow.
+ * @public + */ +export class OutputTypeNotFoundException extends __BaseException { + readonly name: "OutputTypeNotFoundException" = "OutputTypeNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *The timestamp when this resource was last modified.
- * @public - */ - LastModifiedTime?: Date | undefined; - - /** - *The Amazon Web Services Region where this resource was last modified.
- * @public + * @internal */ - LastModifiedRegion?: string | undefined; + constructor(opts: __ExceptionOptionTypeThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; + /** + *The identifier of the routing profile.
+ * @public + */ + RoutingProfileId: string | undefined; + /** *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.
@@ -969,85 +848,84 @@ export interface ListSecurityProfilesRequest { } /** - *Contains information about a security profile.
+ *Contains summary information about a routing profile queue.
* @public */ -export interface SecurityProfileSummary { +export interface RoutingProfileQueueConfigSummary { /** - *The identifier of the security profile.
+ *The identifier for the queue.
* @public */ - Id?: string | undefined; + QueueId: string | undefined; /** - *The Amazon Resource Name (ARN) of the security profile.
+ *The Amazon Resource Name (ARN) of the queue.
* @public */ - Arn?: string | undefined; + QueueArn: string | undefined; /** - *The name of the security profile.
+ *The name of the queue.
* @public */ - Name?: string | undefined; + QueueName: string | undefined; /** - *The timestamp when this resource was last modified.
+ *The order in which contacts are to be handled for the queue. For more information, see + * Queues: priority and + * delay.
* @public */ - LastModifiedTime?: Date | undefined; + Priority: number | undefined; /** - *The Amazon Web Services Region where this resource was last modified.
+ *The delay, in seconds, that a contact should be in the queue before they are routed to an + * available agent. For more information, see Queues: priority and + * delay in the Amazon Connect Administrator Guide.
* @public */ - LastModifiedRegion?: string | undefined; + Delay: number | undefined; + + /** + *The channels this queue supports.
+ * @public + */ + Channel: Channel | undefined; } /** * @public */ -export interface ListSecurityProfilesResponse { +export interface ListRoutingProfileQueuesResponse { /** - *Information about the security profiles.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - SecurityProfileSummaryList?: SecurityProfileSummary[] | undefined; + NextToken?: string | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *Information about the routing profiles.
* @public */ - NextToken?: string | undefined; -} + RoutingProfileQueueConfigSummaryList?: RoutingProfileQueueConfigSummary[] | undefined; -/** - * @public - */ -export interface ListTagsForResourceRequest { /** - *The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing - * profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.
+ *The timestamp when this resource was last modified.
* @public - */ - resourceArn: string | undefined; -} + */ + LastModifiedTime?: Date | undefined; -/** - * @public - */ -export interface ListTagsForResourceResponse { /** - *Information about the tags.
+ *The Amazon Web Services Region where this resource was last modified.
* @public */ - tags?: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -1057,103 +935,65 @@ export interface ListTaskTemplatesRequest { /** *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.
- *It is not expected that you set this because the value returned in the previous response is - * always null.
- *The maximum number of results to return per page.
- *It is not expected that you set this.
- *The maximum number of results to return per page. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; - - /** - *Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
- * Tasks can only be created from ACTIVE
templates.
- * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The name of the task template.
- * @public - */ - Name?: string | undefined; } /** - *Contains summary information about the task template.
+ *Contains summary information about a routing profile.
* @public */ -export interface TaskTemplateMetadata { +export interface RoutingProfileSummary { /** - *A unique identifier for the task template.
+ *The identifier of the routing profile.
* @public */ Id?: string | undefined; /** - *The Amazon Resource Name (ARN) of the task template.
+ *The Amazon Resource Name (ARN) of the routing profile.
* @public */ Arn?: string | undefined; /** - *The name of the task template.
+ *The name of the routing profile.
* @public */ Name?: string | undefined; /** - *The description of the task template.
- * @public - */ - Description?: string | undefined; - - /** - *Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
- * Tasks can only be created from ACTIVE
templates.
- * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The timestamp when the task template was last modified.
+ *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** - *The timestamp when the task template was created.
+ *The Amazon Web Services Region where this resource was last modified.
* @public */ - CreatedTime?: Date | undefined; + LastModifiedRegion?: string | undefined; } /** * @public */ -export interface ListTaskTemplatesResponse { +export interface ListRoutingProfilesResponse { /** - *Provides details about a list of task templates belonging to an instance.
+ *Information about the routing profiles.
* @public */ - TaskTemplates?: TaskTemplateMetadata[] | undefined; + RoutingProfileSummaryList?: RoutingProfileSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
- *This is always returned as a null in the response.
- *The maximum number of results to return per page.
- * @public - */ - MaxResults?: number | undefined; - +export interface ListRulesRequest { /** - *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.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - NextToken?: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The publish status of the rule.
* @public */ - InstanceId?: string | undefined; -} + PublishStatus?: RulePublishStatus | undefined; -/** - *Information about traffic distribution groups.
- * @public - */ -export interface TrafficDistributionGroupSummary { /** - *The identifier of the traffic distribution group. - * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. - * The ARN must be provided if the call is from the replicated Region.
+ *The name of the event source.
* @public */ - Id?: string | undefined; + EventSourceName?: EventSourceName | undefined; /** - *The Amazon Resource Name (ARN) of the traffic distribution group.
+ *The maximum number of results to return per page.
* @public */ - Arn?: string | undefined; + MaxResults?: number | undefined; /** - *The name of the traffic distribution group.
+ *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.
* @public */ - Name?: string | undefined; + NextToken?: string | undefined; +} +/** + *A list of ActionTypes
associated with a rule.
The Amazon Resource Name (ARN) of the traffic distribution group.
+ *The name of the rule.
* @public */ - InstanceArn?: string | undefined; + Name: string | undefined; /** - *The status of the traffic distribution group.
- *
- * CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet
- * completed.
- * ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded.
- * CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed.
- * PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet
- * completed.
- * DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed.
- * UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet
- * completed.
A unique identifier for the rule.
* @public */ - Status?: TrafficDistributionGroupStatus | undefined; + RuleId: string | undefined; /** - *Whether this is the default traffic distribution group created during instance
- * replication. The default traffic distribution group cannot be deleted by the
- * DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as
- * part of the process for deleting a replica.
The Amazon Resource Name (ARN) of the rule.
* @public */ - IsDefault?: boolean | undefined; -} + RuleArn: string | undefined; -/** - * @public - */ -export interface ListTrafficDistributionGroupsResponse { /** - *If there are additional results, this is the token for the next set of results.
+ *The name of the event source.
* @public */ - NextToken?: string | undefined; + EventSourceName: EventSourceName | undefined; /** - *A list of traffic distribution groups.
+ *The publish status of the rule.
* @public */ - TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[] | undefined; -} + PublishStatus: RulePublishStatus | undefined; -/** - * @public - */ -export interface ListTrafficDistributionGroupUsersRequest { /** - *The identifier of the traffic distribution group. - * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. - * The ARN must be provided if the call is from the replicated Region.
+ *A list of ActionTypes associated with a rule.
* @public */ - TrafficDistributionGroupId: string | undefined; + ActionSummaries: ActionSummary[] | undefined; /** - *The maximum number of results to return per page.
+ *The timestamp for when the rule was created.
* @public */ - MaxResults?: number | undefined; + CreatedTime: Date | undefined; /** - *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.
+ *The timestamp for when the rule was last updated.
* @public */ - NextToken?: string | undefined; + LastUpdatedTime: Date | undefined; } /** - *Summary information about a traffic distribution group user.
* @public */ -export interface TrafficDistributionGroupUserSummary { +export interface ListRulesResponse { /** - *The identifier for the user. This can be the ID or the ARN of the user.
+ *Summary information about a rule.
* @public */ - UserId?: string | undefined; -} + RuleSummaryList: RuleSummary[] | undefined; -/** - * @public - */ -export interface ListTrafficDistributionGroupUsersResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; - - /** - *A list of traffic distribution group users.
- * @public - */ - TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[] | undefined; } /** - *Provides summary information about the use cases for the specified integration - * association.
* @public */ -export interface ListUseCasesRequest { +export interface ListSecurityKeysRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; - /** - *The identifier for the integration association.
- * @public - */ - IntegrationAssociationId: string | undefined; - /** *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.
@@ -1364,41 +1131,38 @@ export interface ListUseCasesRequest { } /** - *Contains the - * use - * case.
+ *Configuration information of the security key.
* @public */ -export interface UseCase { +export interface SecurityKey { /** - *The identifier for the use case.
+ *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
* @public */ - UseCaseId?: string | undefined; + AssociationId?: string | undefined; /** - *The Amazon Resource Name (ARN) for the use case.
+ *The key of the security key.
* @public */ - UseCaseArn?: string | undefined; + Key?: string | undefined; /** - *The type of use case to associate to the integration association. Each integration - * association can have only one of each use case type.
+ *When the security key was created.
* @public */ - UseCaseType?: UseCaseType | undefined; + CreationTime?: Date | undefined; } /** * @public */ -export interface ListUseCasesResponse { +export interface ListSecurityKeysResponse { /** - *The use cases.
+ *The security keys.
* @public */ - UseCaseSummaryList?: UseCase[] | undefined; + SecurityKeys?: SecurityKey[] | undefined; /** *If there are additional results, this is the token for the next set of results.
@@ -1407,10 +1171,16 @@ export interface ListUseCasesResponse { NextToken?: string | undefined; } -/** - * @public - */ -export interface ListUserHierarchyGroupsRequest { +/** + * @public + */ +export interface ListSecurityProfileApplicationsRequest { + /** + *The identifier for the security profle.
+ * @public + */ + SecurityProfileId: string | undefined; + /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -1425,7 +1195,7 @@ export interface ListUserHierarchyGroupsRequest { NextToken?: string | undefined; /** - *The maximum number of results to return per page. The default MaxResult size is 100.
+ *The maximum number of results to return per page.
* @public */ MaxResults?: number | undefined; @@ -1434,40 +1204,51 @@ export interface ListUserHierarchyGroupsRequest { /** * @public */ -export interface ListUserHierarchyGroupsResponse { +export interface ListSecurityProfileApplicationsResponse { /** - *Information about the hierarchy groups.
+ *A list of the third-party application's metadata.
* @public */ - UserHierarchyGroupSummaryList?: HierarchyGroupSummary[] | undefined; + Applications?: Application[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; + + /** + *The timestamp when this resource was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *The Amazon Web Services Region where this resource was last modified.
+ * @public + */ + LastModifiedRegion?: string | undefined; } /** * @public */ -export interface ListUserProficienciesRequest { +export interface ListSecurityProfilePermissionsRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource - * Name (ARN) of the instance.
+ *The identifier for the security profle.
* @public */ - InstanceId: string | undefined; + SecurityProfileId: string | undefined; /** - *The identifier of the user account.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - UserId: string | undefined; + InstanceId: string | undefined; /** - *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.
+ *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.
* @public */ NextToken?: string | undefined; @@ -1482,27 +1263,29 @@ export interface ListUserProficienciesRequest { /** * @public */ -export interface ListUserProficienciesResponse { +export interface ListSecurityProfilePermissionsResponse { /** - *If there are additional results, this is the token for the next set of results.
+ *The permissions granted to the security profile. For a complete list of valid permissions, + * see List + * of security profile permissions.
* @public */ - NextToken?: string | undefined; + Permissions?: string[] | undefined; /** - *Information about the user proficiencies.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - UserProficiencyList?: UserProficiency[] | undefined; + NextToken?: string | undefined; /** - *The last time that the user's proficiencies are were modified.
+ *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** - *The region in which a user's proficiencies were last modified.
+ *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; @@ -1511,7 +1294,7 @@ export interface ListUserProficienciesResponse { /** * @public */ -export interface ListUsersRequest { +export interface ListSecurityProfilesRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -1533,27 +1316,27 @@ export interface ListUsersRequest { } /** - *Contains summary information about a user.
+ *Contains information about a security profile.
* @public */ -export interface UserSummary { +export interface SecurityProfileSummary { /** - *The identifier of the user account.
+ *The identifier of the security profile.
* @public */ Id?: string | undefined; /** - *The Amazon Resource Name (ARN) of the user account.
+ *The Amazon Resource Name (ARN) of the security profile.
* @public */ Arn?: string | undefined; /** - *The Amazon Connect user name of the user account.
+ *The name of the security profile.
* @public */ - Username?: string | undefined; + Name?: string | undefined; /** *The timestamp when this resource was last modified.
@@ -1571,12 +1354,12 @@ export interface UserSummary { /** * @public */ -export interface ListUsersResponse { +export interface ListSecurityProfilesResponse { /** - *Information about the users.
+ *Information about the security profiles.
* @public */ - UserSummaryList?: UserSummary[] | undefined; + SecurityProfileSummaryList?: SecurityProfileSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
@@ -1588,90 +1371,136 @@ export interface ListUsersResponse { /** * @public */ -export interface ListViewsRequest { +export interface ListTagsForResourceRequest { /** - *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of - * the instance.
+ *The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing + * profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.
* @public */ - InstanceId: string | undefined; + resourceArn: string | undefined; +} +/** + * @public + */ +export interface ListTagsForResourceResponse { /** - *The type of the view.
+ *Information about the tags.
* @public */ - Type?: ViewType | undefined; + tags?: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; /** - *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.
+ *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.
+ *It is not expected that you set this because the value returned in the previous response is + * always null.
+ *The maximum number of results to return per page. The default MaxResult size is 100.
+ *The maximum number of results to return per page.
+ *It is not expected that you set this.
+ *Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
+ * Tasks can only be created from ACTIVE
templates.
+ * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The name of the task template.
+ * @public + */ + Name?: string | undefined; } /** - *A summary of a view's metadata.
+ *Contains summary information about the task template.
* @public */ -export interface ViewSummary { +export interface TaskTemplateMetadata { /** - *The identifier of the view.
+ *A unique identifier for the task template.
* @public */ Id?: string | undefined; /** - *The Amazon Resource Name (ARN) of the view.
+ *The Amazon Resource Name (ARN) of the task template.
* @public */ Arn?: string | undefined; /** - *The name of the view.
+ *The name of the task template.
* @public */ Name?: string | undefined; /** - *The type of the view.
+ *The description of the task template.
* @public */ - Type?: ViewType | undefined; + Description?: string | undefined; /** - *Indicates the view status as either SAVED
or PUBLISHED
. The
- * PUBLISHED
status will initiate validation on the content.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
+ * Tasks can only be created from ACTIVE
templates.
+ * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The description of the view.
+ *The timestamp when the task template was last modified.
* @public */ - Description?: string | undefined; + LastModifiedTime?: Date | undefined; + + /** + *The timestamp when the task template was created.
+ * @public + */ + CreatedTime?: Date | undefined; } /** * @public */ -export interface ListViewsResponse { +export interface ListTaskTemplatesResponse { /** - *A list of view summaries.
+ *Provides details about a list of task templates belonging to an instance.
* @public */ - ViewsSummaryList?: ViewSummary[] | undefined; + TaskTemplates?: TaskTemplateMetadata[] | undefined; /** - *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.
+ *If there are additional results, this is the token for the next set of results.
+ *This is always returned as a null in the response.
+ *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of - * the instance.
+ *The maximum number of results to return per page.
* @public */ - InstanceId: string | undefined; + MaxResults?: number | undefined; /** - *The identifier of the view. Both ViewArn
and ViewId
can be
- * used.
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.
* @public */ - ViewId: string | undefined; + NextToken?: string | undefined; /** - *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.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId?: string | undefined; +} + +/** + *Information about traffic distribution groups.
+ * @public + */ +export interface TrafficDistributionGroupSummary { + /** + *The identifier of the traffic distribution group. + * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. + * The ARN must be provided if the call is from the replicated Region.
+ * @public + */ + Id?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the traffic distribution group.
+ * @public + */ + Arn?: string | undefined; + + /** + *The name of the traffic distribution group.
+ * @public + */ + Name?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the traffic distribution group.
+ * @public + */ + InstanceArn?: string | undefined; + + /** + *The status of the traffic distribution group.
+ *
+ * CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet
+ * completed.
+ * ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded.
+ * CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed.
+ * PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet
+ * completed.
+ * DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed.
+ * UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet
+ * completed.
The maximum number of results to return per page. The default MaxResult size is 100.
+ *Whether this is the default traffic distribution group created during instance
+ * replication. The default traffic distribution group cannot be deleted by the
+ * DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as
+ * part of the process for deleting a replica.
A summary of a view version's metadata.
* @public */ -export interface ViewVersionSummary { - /** - *The identifier of the view version.
- * @public - */ - Id?: string | undefined; - +export interface ListTrafficDistributionGroupsResponse { /** - *The Amazon Resource Name (ARN) of the view version.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - Arn?: string | undefined; + NextToken?: string | undefined; /** - *The description of the view version.
+ *A list of traffic distribution groups.
* @public */ - Description?: string | undefined; + TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[] | undefined; +} +/** + * @public + */ +export interface ListTrafficDistributionGroupUsersRequest { /** - *The name of the view version.
+ *The identifier of the traffic distribution group. + * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. + * The ARN must be provided if the call is from the replicated Region.
* @public */ - Name?: string | undefined; + TrafficDistributionGroupId: string | undefined; /** - *The type of the view version.
+ *The maximum number of results to return per page.
* @public */ - Type?: ViewType | undefined; + MaxResults?: number | undefined; /** - *The sequentially incremented version of the view version.
+ *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.
* @public */ - Version?: number | undefined; + NextToken?: string | undefined; +} +/** + *Summary information about a traffic distribution group user.
+ * @public + */ +export interface TrafficDistributionGroupUserSummary { /** - *The description of the view version.
+ *The identifier for the user. This can be the ID or the ARN of the user.
* @public */ - VersionDescription?: string | undefined; + UserId?: string | undefined; } /** * @public */ -export interface ListViewVersionsResponse { +export interface ListTrafficDistributionGroupUsersResponse { /** - *A list of view version summaries.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - ViewVersionSummaryList?: ViewVersionSummary[] | undefined; + NextToken?: string | undefined; /** - *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.
+ *A list of traffic distribution group users.
* @public */ - NextToken?: string | undefined; + TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[] | undefined; } /** + *Provides summary information about the use cases for the specified integration + * association.
* @public */ -export interface MonitorContactRequest { +export interface ListUseCasesRequest { /** - *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of - * the instance.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** - *The identifier of the contact.
- * @public - */ - ContactId: string | undefined; - - /** - *The identifier of the user account.
+ *The identifier for the integration association.
* @public */ - UserId: string | undefined; + IntegrationAssociationId: string | undefined; /** - *Specify which monitoring actions the user is allowed to take. For example, whether the user - * is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if - * barge is enabled.
+ *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.
* @public */ - AllowedMonitorCapabilities?: MonitorCapability[] | undefined; + NextToken?: string | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *The maximum number of results to return per page.
* @public */ - ClientToken?: string | undefined; + MaxResults?: number | undefined; } /** + *Contains the + * use + * case.
* @public */ -export interface MonitorContactResponse { +export interface UseCase { /** - *The identifier of the contact.
+ *The identifier for the use case.
* @public */ - ContactId?: string | undefined; + UseCaseId?: string | undefined; /** - *The ARN of the contact.
+ *The Amazon Resource Name (ARN) for the use case.
* @public */ - ContactArn?: string | undefined; -} + UseCaseArn?: string | undefined; -/** - * @public - */ -export interface PauseContactRequest { /** - *The identifier of the contact.
+ *The type of use case to associate to the integration association. Each integration + * association can have only one of each use case type.
* @public */ - ContactId: string | undefined; + UseCaseType?: UseCaseType | undefined; +} +/** + * @public + */ +export interface ListUseCasesResponse { /** - *The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of
- * the instance.
The use cases.
* @public */ - InstanceId: string | undefined; + UseCaseSummaryList?: UseCase[] | undefined; /** - *The identifier of the flow.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - ContactFlowId?: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface PauseContactResponse {} - -/** - * @public - */ -export interface PutUserStatusRequest { +export interface ListUserHierarchyGroupsRequest { /** - *The identifier of the user.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - UserId: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *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.
* @public */ - InstanceId: string | undefined; + NextToken?: string | undefined; /** - *The identifier of the agent status.
+ *The maximum number of results to return per page. The default MaxResult size is 100.
* @public */ - AgentStatusId: string | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface PutUserStatusResponse {} - -/** - * @public - */ -export interface ReleasePhoneNumberRequest { +export interface ListUserHierarchyGroupsResponse { /** - *A unique identifier for the phone number.
+ *Information about the hierarchy groups.
* @public */ - PhoneNumberId: string | undefined; + UserHierarchyGroupSummaryList?: HierarchyGroupSummary[] | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - ClientToken?: string | undefined; + NextToken?: string | undefined; } /** * @public */ -export interface ReplicateInstanceRequest { +export interface ListUserProficienciesRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId
, or the entire ARN.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource + * Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** - *The Amazon Web Services Region where to replicate the Amazon Connect instance.
+ *The identifier of the user account.
* @public */ - ReplicaRegion: string | undefined; + UserId: string | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *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.
* @public */ - ClientToken?: string | undefined; + NextToken?: string | undefined; /** - *The alias for the replicated instance. The ReplicaAlias
must be unique.
The maximum number of results to return per page.
* @public */ - ReplicaAlias: string | undefined; + MaxResults?: number | undefined; } /** * @public */ -export interface ReplicateInstanceResponse { +export interface ListUserProficienciesResponse { /** - *The identifier of the replicated instance. You can find the instanceId
in the
- * ARN of the instance. The replicated instance has the same identifier as the instance it was
- * replicated from.
If there are additional results, this is the token for the next set of results.
* @public */ - Id?: string | undefined; + NextToken?: string | undefined; /** - *The Amazon Resource Name (ARN) of the replicated instance.
+ *Information about the user proficiencies.
* @public */ - Arn?: string | undefined; + UserProficiencyList?: UserProficiency[] | undefined; + + /** + *The last time that the user's proficiencies are were modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *The region in which a user's proficiencies were last modified.
+ * @public + */ + LastModifiedRegion?: string | undefined; } /** * @public */ -export interface ResumeContactRequest { +export interface ListUsersRequest { /** - *The identifier of the contact.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - ContactId: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of
- * the instance.
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.
* @public */ - InstanceId: string | undefined; + NextToken?: string | undefined; /** - *The identifier of the flow.
+ *The maximum number of results to return per page. The default MaxResult size is 100.
* @public */ - ContactFlowId?: string | undefined; + MaxResults?: number | undefined; } /** + *Contains summary information about a user.
* @public */ -export interface ResumeContactResponse {} - -/** - * @public - * @enum - */ -export const ContactRecordingType = { - AGENT: "AGENT", - IVR: "IVR", - SCREEN: "SCREEN", -} as const; - -/** - * @public - */ -export type ContactRecordingType = (typeof ContactRecordingType)[keyof typeof ContactRecordingType]; +export interface UserSummary { + /** + *The identifier of the user account.
+ * @public + */ + Id?: string | undefined; -/** - * @public - */ -export interface ResumeContactRecordingRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The Amazon Resource Name (ARN) of the user account.
* @public */ - InstanceId: string | undefined; + Arn?: string | undefined; /** - *The identifier of the contact.
+ *The Amazon Connect user name of the user account.
* @public */ - ContactId: string | undefined; + Username?: string | undefined; /** - *The identifier of the contact. This is the identifier of the contact associated with the - * first interaction with the contact center.
+ *The timestamp when this resource was last modified.
* @public */ - InitialContactId: string | undefined; + LastModifiedTime?: Date | undefined; /** - *The type of recording being operated on.
+ *The Amazon Web Services Region where this resource was last modified.
* @public */ - ContactRecordingType?: ContactRecordingType | undefined; + LastModifiedRegion?: string | undefined; } /** * @public */ -export interface ResumeContactRecordingResponse {} - -/** - * @public - */ -export interface SearchAgentStatusesResponse { +export interface ListUsersResponse { /** - *The search criteria to be used to return agent statuses.
+ *Information about the users.
* @public */ - AgentStatuses?: AgentStatus[] | undefined; + UserSummaryList?: UserSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; - - /** - *The total number of agent statuses which matched your search query.
- * @public - */ - ApproximateTotalCount?: number | undefined; } /** * @public */ -export interface SearchAvailablePhoneNumbersRequest { +export interface ListViewsRequest { /** - *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.
* @public */ - TargetArn?: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the Amazon Connect instance that phone numbers are claimed to. You
- * can find the
- * instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The type of the view.
* @public */ - InstanceId?: string | undefined; + Type?: ViewType | undefined; /** - *The ISO country code.
+ *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.
* @public */ - PhoneNumberCountryCode: PhoneNumberCountryCode | undefined; + NextToken?: string | undefined; /** - *The type of phone number.
+ *The maximum number of results to return per page. The default MaxResult size is 100.
* @public */ - PhoneNumberType: PhoneNumberType | undefined; + MaxResults?: number | undefined; +} +/** + *A summary of a view's metadata.
+ * @public + */ +export interface ViewSummary { /** - *The prefix of the phone number. If provided, it must contain +
as part of the country code.
The identifier of the view.
* @public */ - PhoneNumberPrefix?: string | undefined; + Id?: string | undefined; /** - *The maximum number of results to return per page.
+ *The Amazon Resource Name (ARN) of the view.
* @public */ - MaxResults?: number | undefined; + Arn?: string | undefined; /** - *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.
+ *The name of the view.
* @public */ - NextToken?: string | undefined; -} + Name?: string | undefined; -/** - *Information about available phone numbers.
- * @public - */ -export interface AvailableNumberSummary { /** - *The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The type of the view.
* @public */ - PhoneNumber?: string | undefined; + Type?: ViewType | undefined; /** - *The ISO country code.
+ *Indicates the view status as either SAVED
or PUBLISHED
. The
+ * PUBLISHED
status will initiate validation on the content.
The type of phone number.
+ *The description of the view.
* @public */ - PhoneNumberType?: PhoneNumberType | undefined; + Description?: string | undefined; } /** * @public */ -export interface SearchAvailablePhoneNumbersResponse { +export interface ListViewsResponse { /** - *If there are additional results, this is the token for the next set of results.
+ *A list of view summaries.
* @public */ - NextToken?: string | undefined; + ViewsSummaryList?: ViewSummary[] | undefined; /** - *A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
+ *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.
* @public */ - AvailableNumbersList?: AvailableNumberSummary[] | undefined; + NextToken?: string | undefined; } /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
A list of conditions which would be applied together with an OR
condition.
- *
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.
* @public */ - OrConditions?: TagCondition[][] | undefined; + InstanceId: string | undefined; /** - *A list of conditions which would be applied together with an AND
- * condition.
The identifier of the view. Both ViewArn
and ViewId
can be
+ * used.
A leaf node condition which can be used to specify a tag condition.
+ *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.
* @public */ - TagCondition?: TagCondition | undefined; -} + NextToken?: string | undefined; -/** - *The search criteria to be used to return flow modules.
- * @public - */ -export interface ContactFlowModuleSearchFilter { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
The maximum number of results to return per page. The default MaxResult size is 100.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; + MaxResults?: number | undefined; } /** + *A summary of a view version's metadata.
* @public */ -export interface SearchContactFlowModulesResponse { +export interface ViewVersionSummary { /** - *The search criteria to be used to return flow modules.
+ *The identifier of the view version.
* @public */ - ContactFlowModules?: ContactFlowModule[] | undefined; + Id?: string | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *The Amazon Resource Name (ARN) of the view version.
* @public */ - NextToken?: string | undefined; + Arn?: string | undefined; /** - *The total number of flows which matched your search query.
+ *The description of the view version.
* @public */ - ApproximateTotalCount?: number | undefined; -} + Description?: string | undefined; -/** - *Filters to be applied to search results.
- * @public - */ -export interface ContactFlowSearchFilter { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
The name of the view version.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; -} + Name?: string | undefined; -/** - * @public - */ -export interface SearchContactFlowsResponse { /** - *Information about the flows.
+ *The type of the view version.
* @public */ - ContactFlows?: ContactFlow[] | undefined; + Type?: ViewType | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *The sequentially incremented version of the view version.
* @public */ - NextToken?: string | undefined; + Version?: number | undefined; /** - *The total number of flows which matched your search query.
+ *The description of the view version.
* @public */ - ApproximateTotalCount?: number | undefined; + VersionDescription?: string | undefined; } /** * @public - * @enum */ -export const SearchContactsMatchType = { - MATCH_ALL: "MATCH_ALL", - MATCH_ANY: "MATCH_ANY", -} as const; +export interface ListViewVersionsResponse { + /** + *A list of view version summaries.
+ * @public + */ + ViewVersionSummaryList?: ViewVersionSummary[] | undefined; -/** - * @public - */ -export type SearchContactsMatchType = (typeof SearchContactsMatchType)[keyof typeof SearchContactsMatchType]; + /** + *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.
+ * @public + */ + NextToken?: string | undefined; +} /** - *A structure that defines search criteria base on words or phrases, participants in the - * Contact Lens conversational analytics transcript.
* @public */ -export interface TranscriptCriteria { +export interface MonitorContactRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier of the contact.
+ * @public + */ + ContactId: string | undefined; + /** - *The participant role in a transcript
+ *The identifier of the user account.
* @public */ - ParticipantRole: ParticipantRole | undefined; + UserId: string | undefined; /** - *The words or phrases used to search within a transcript.
+ *Specify which monitoring actions the user is allowed to take. For example, whether the user + * is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if + * barge is enabled.
* @public */ - SearchText: string[] | undefined; + AllowedMonitorCapabilities?: MonitorCapability[] | undefined; /** - *The match type combining search criteria using multiple search texts in a transcript - * criteria.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - MatchType: SearchContactsMatchType | undefined; + ClientToken?: string | undefined; } /** - *A structure that defines search criteria and matching logic to search for contacts by - * matching text with transcripts analyzed by Amazon Connect Contact Lens.
* @public */ -export interface Transcript { +export interface MonitorContactResponse { /** - *The list of search criteria based on Contact Lens conversational analytics - * transcript.
+ *The identifier of the contact.
* @public */ - Criteria: TranscriptCriteria[] | undefined; + ContactId?: string | undefined; /** - *The match type combining search criteria using multiple transcript criteria.
+ *The ARN of the contact.
* @public */ - MatchType?: SearchContactsMatchType | undefined; + ContactArn?: string | undefined; } /** - *A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
* @public */ -export interface ContactAnalysis { +export interface PauseContactRequest { /** - *Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
+ *The identifier of the contact.
* @public */ - Transcript?: Transcript | undefined; -} + ContactId: string | undefined; -/** - *The search criteria based on user-defined contact attribute key and values to search - * on.
- * @public - */ -export interface SearchableContactAttributesCriteria { /** - *The key containing a searchable user-defined contact attribute.
+ *The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of
+ * the instance.
The list of values to search for within a user-defined contact attribute.
+ *The identifier of the flow.
* @public */ - Values: string[] | undefined; + ContactFlowId?: string | undefined; } /** - *A structure that defines search criteria based on user-defined contact attributes that are - * configured for contact search.
* @public */ -export interface SearchableContactAttributes { - /** - *The list of criteria based on user-defined contact attributes that are configured for - * contact search.
- * @public - */ - Criteria: SearchableContactAttributesCriteria[] | undefined; +export interface PauseContactResponse {} +/** + * @public + */ +export interface PutUserStatusRequest { /** - *The match type combining search criteria using multiple searchable contact - * attributes.
+ *The identifier of the user.
* @public */ - MatchType?: SearchContactsMatchType | undefined; -} + UserId: string | undefined; -/** - *The search criteria based on searchable segment attribute key and values to search - * on.
- * @public - */ -export interface SearchableSegmentAttributesCriteria { /** - *The key containing a searchable segment attribute.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Key: string | undefined; + InstanceId: string | undefined; /** - *The list of values to search for within a searchable segment attribute.
+ *The identifier of the agent status.
* @public */ - Values: string[] | undefined; + AgentStatusId: string | undefined; } /** - *The search criteria based on searchable segment attributes of a contact
* @public */ -export interface SearchableSegmentAttributes { - /** - *The list of criteria based on searchable segment attributes.
- * @public - */ - Criteria: SearchableSegmentAttributesCriteria[] | undefined; - - /** - *The match type combining search criteria using multiple searchable segment - * attributes.
- * @public - */ - MatchType?: SearchContactsMatchType | undefined; -} +export interface PutUserStatusResponse {} /** - *A structure of search criteria to be used to return contacts.
* @public */ -export interface SearchCriteria { +export interface ReleasePhoneNumberRequest { /** - *The identifiers of agents who handled the contacts.
+ *A unique identifier for the phone number.
* @public */ - AgentIds?: string[] | undefined; + PhoneNumberId: string | undefined; /** - *The agent hierarchy groups of the agent at the time of handling the contact.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - AgentHierarchyGroups?: AgentHierarchyGroups | undefined; + ClientToken?: string | undefined; +} +/** + * @public + */ +export interface ReplicateInstanceRequest { /** - *The list of channels associated with contacts.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId
, or the entire ARN.
Search criteria based on analysis outputs from Amazon Connect Contact Lens.
+ *The Amazon Web Services Region where to replicate the Amazon Connect instance.
* @public */ - ContactAnalysis?: ContactAnalysis | undefined; + ReplicaRegion: string | undefined; /** - *The list of initiation methods associated with contacts.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - InitiationMethods?: ContactInitiationMethod[] | undefined; + ClientToken?: string | undefined; /** - *The list of queue IDs associated with contacts.
+ *The alias for the replicated instance. The ReplicaAlias
must be unique.
The search criteria based on user-defined contact attributes that have been configured for - * contact search. For more information, see Search by custom contact - * attributes in the Amazon Connect Administrator Guide.
- *To use SearchableContactAttributes
in a search request, the
- * GetContactAttributes
action is required to perform an API request. For more
- * information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The identifier of the replicated instance. You can find the instanceId
in the
+ * ARN of the instance. The replicated instance has the same identifier as the instance it was
+ * replicated from.
The search criteria based on searchable segment attributes of a contact.
+ *The Amazon Resource Name (ARN) of the replicated instance.
* @public */ - SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined; + Arn?: string | undefined; } -/** - * @public - * @enum - */ -export const SortableFieldName = { - CHANNEL: "CHANNEL", - CONNECTED_TO_AGENT_TIMESTAMP: "CONNECTED_TO_AGENT_TIMESTAMP", - DISCONNECT_TIMESTAMP: "DISCONNECT_TIMESTAMP", - INITIATION_METHOD: "INITIATION_METHOD", - INITIATION_TIMESTAMP: "INITIATION_TIMESTAMP", - SCHEDULED_TIMESTAMP: "SCHEDULED_TIMESTAMP", -} as const; - /** * @public */ -export type SortableFieldName = (typeof SortableFieldName)[keyof typeof SortableFieldName]; +export interface ResumeContactRequest { + /** + *The identifier of the contact.
+ * @public + */ + ContactId: string | undefined; -/** - *A structure that defines the field name to sort by and a sort order.
- * @public - */ -export interface Sort { /** - *The name of the field on which to sort.
+ *The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of
+ * the instance.
An ascending or descending sort.
+ *The identifier of the flow.
* @public */ - Order: SortOrder | undefined; + ContactFlowId?: string | undefined; } +/** + * @public + */ +export interface ResumeContactResponse {} + /** * @public * @enum */ -export const SearchContactsTimeRangeType = { - CONNECTED_TO_AGENT_TIMESTAMP: "CONNECTED_TO_AGENT_TIMESTAMP", - DISCONNECT_TIMESTAMP: "DISCONNECT_TIMESTAMP", - INITIATION_TIMESTAMP: "INITIATION_TIMESTAMP", - SCHEDULED_TIMESTAMP: "SCHEDULED_TIMESTAMP", +export const ContactRecordingType = { + AGENT: "AGENT", + IVR: "IVR", + SCREEN: "SCREEN", } as const; /** * @public */ -export type SearchContactsTimeRangeType = - (typeof SearchContactsTimeRangeType)[keyof typeof SearchContactsTimeRangeType]; +export type ContactRecordingType = (typeof ContactRecordingType)[keyof typeof ContactRecordingType]; /** - *A structure of time range that you want to search results.
* @public */ -export interface SearchContactsTimeRange { - /** - *The type of timestamp to search.
- * @public - */ - Type: SearchContactsTimeRangeType | undefined; - +export interface ResumeContactRecordingRequest { /** - *The start time of the time range.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - StartTime: Date | undefined; + InstanceId: string | undefined; /** - *The end time of the time range.
+ *The identifier of the contact.
* @public */ - EndTime: Date | undefined; -} + ContactId: string | undefined; -/** - * @public - */ -export interface SearchContactsRequest { /** - *The identifier of Amazon Connect instance. You can find the instance ID in the Amazon - * Resource Name (ARN) of the instance.
+ *The identifier of the contact. This is the identifier of the contact associated with the + * first interaction with the contact center.
* @public */ - InstanceId: string | undefined; + InitialContactId: string | undefined; /** - *Time range that you want to search results.
+ *The type of recording being operated on.
* @public */ - TimeRange: SearchContactsTimeRange | undefined; + ContactRecordingType?: ContactRecordingType | undefined; +} - /** - *The search criteria to be used to return contacts.
- * @public - */ - SearchCriteria?: SearchCriteria | undefined; +/** + * @public + */ +export interface ResumeContactRecordingResponse {} +/** + * @public + */ +export interface SearchAgentStatusesResponse { /** - *The maximum number of results to return per page.
+ *The search criteria to be used to return agent statuses.
* @public */ - MaxResults?: number | undefined; + AgentStatuses?: AgentStatus[] | undefined; /** - *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.
+ *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** - *Specifies a field to sort by and a sort order.
+ *The total number of agent statuses which matched your search query.
* @public */ - Sort?: Sort | undefined; + ApproximateTotalCount?: number | undefined; } /** - *Information about the agent who accepted the contact.
* @public */ -export interface ContactSearchSummaryAgentInfo { - /** - *The identifier of the agent who accepted the contact.
- * @public - */ - Id?: string | undefined; - +export interface SearchAvailablePhoneNumbersRequest { /** - *The timestamp when the contact was connected to the agent.
+ *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
If this contact was queued, this contains information about the queue.
- * @public - */ -export interface ContactSearchSummaryQueueInfo { /** - *The unique identifier for the queue.
+ *The identifier of the Amazon Connect instance that phone numbers are claimed to. You
+ * can find the
+ * instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The timestamp when the contact was added to the queue.
+ *The ISO country code.
* @public */ - EnqueueTimestamp?: Date | undefined; -} + PhoneNumberCountryCode: PhoneNumberCountryCode | undefined; -/** - *The value of a segment attribute. This is structured as a map with a single key-value pair. - * The key 'valueString' indicates that the attribute type is a string, and its corresponding value - * is the actual string value of the segment attribute.
- * @public - */ -export interface ContactSearchSummarySegmentAttributeValue { /** - *The value of a segment attribute represented as a string.
+ *The type of phone number.
* @public */ - ValueString?: string | undefined; -} + PhoneNumberType: PhoneNumberType | undefined; -/** - *Information of returned contact.
- * @public - */ -export interface ContactSearchSummary { /** - *The Amazon Resource Name (ARN) of the contact.
+ *The prefix of the phone number. If provided, it must contain +
as part of the country code.
The identifier of the contact summary.
+ *The maximum number of results to return per page.
* @public */ - Id?: string | undefined; + MaxResults?: number | undefined; /** - *If this contact is related to other contacts, this is the ID of the initial contact.
+ *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.
* @public */ - InitialContactId?: string | undefined; + NextToken?: string | undefined; +} +/** + *Information about available phone numbers.
+ * @public + */ +export interface AvailableNumberSummary { /** - *If this contact is not the first contact, this is the ID of the previous contact.
+ *The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
Indicates how the contact was initiated.
+ *The ISO country code.
* @public */ - InitiationMethod?: ContactInitiationMethod | undefined; + PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined; /** - *How the contact reached your contact center.
+ *The type of phone number.
* @public */ - Channel?: Channel | undefined; + PhoneNumberType?: PhoneNumberType | undefined; +} +/** + * @public + */ +export interface SearchAvailablePhoneNumbersResponse { /** - *If this contact was queued, this contains information about the queue.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - QueueInfo?: ContactSearchSummaryQueueInfo | undefined; + NextToken?: string | undefined; /** - *Information about the agent who accepted the contact.
+ *A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
* @public */ - AgentInfo?: ContactSearchSummaryAgentInfo | undefined; + AvailableNumbersList?: AvailableNumberSummary[] | undefined; +} +/** + *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
+ * operator
Inner list specifies conditions that need to be applied with AND
+ * operator.
The date and time this contact was initiated, in UTC time. For INBOUND
, this is
- * when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For
- * CALLBACK
, this is when the callback contact was created. For TRANSFER
- * and QUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when
- * the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing
- * the external participant. For MONITOR
, this is when the supervisor started listening
- * to a contact.
A list of conditions which would be applied together with an OR
condition.
+ *
The timestamp when the customer endpoint disconnected from Amazon Connect.
+ *A list of conditions which would be applied together with an AND
+ * condition.
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
+ *A leaf node condition which can be used to specify a tag condition.
* @public */ - ScheduledTimestamp?: Date | undefined; + TagCondition?: TagCondition | undefined; +} +/** + *The search criteria to be used to return flow modules.
+ * @public + */ +export interface ContactFlowModuleSearchFilter { /** - *Set of segment attributes for a contact.
+ *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
+ * operator
Inner list specifies conditions that need to be applied with AND
+ * operator.
Information about the contacts.
+ *The search criteria to be used to return flow modules.
* @public */ - Contacts: ContactSearchSummary[] | undefined; + ContactFlowModules?: ContactFlowModule[] | undefined; /** *If there are additional results, this is the token for the next set of results.
@@ -2765,17 +2578,17 @@ export interface SearchContactsResponse { NextToken?: string | undefined; /** - *The total number of contacts which matched your search query.
+ *The total number of flows which matched your search query.
* @public */ - TotalCount?: number | undefined; + ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ -export interface EmailAddressSearchFilter { +export interface ContactFlowSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter
.
* This accepts an OR
of AND
(List of List) input where:
Contains information about an email address for a contact center.
* @public */ -export interface EmailAddressMetadata { +export interface SearchContactFlowsResponse { /** - *The identifier of the email address.
+ *Information about the flows.
* @public */ - EmailAddressId?: string | undefined; + ContactFlows?: ContactFlow[] | undefined; /** - *The Amazon Resource Name (ARN) of the email address.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - EmailAddressArn?: string | undefined; + NextToken?: string | undefined; /** - *The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.
+ *The total number of flows which matched your search query.
* @public */ - EmailAddress?: string | undefined; + ApproximateTotalCount?: number | undefined; +} - /** - *The description of the email address.
- * @public - */ - Description?: string | undefined; +/** + * @public + * @enum + */ +export const SearchContactsMatchType = { + MATCH_ALL: "MATCH_ALL", + MATCH_ANY: "MATCH_ANY", +} as const; - /** - *The display name of email address.
- * @public - */ - DisplayName?: string | undefined; -} +/** + * @public + */ +export type SearchContactsMatchType = (typeof SearchContactsMatchType)[keyof typeof SearchContactsMatchType]; /** + *A structure that defines search criteria base on words or phrases, participants in the + * Contact Lens conversational analytics transcript.
* @public */ -export interface SearchEmailAddressesResponse { +export interface TranscriptCriteria { /** - *If there are additional results, this is the token for the next set of results.
+ *The participant role in a transcript
* @public */ - NextToken?: string | undefined; + ParticipantRole: ParticipantRole | undefined; /** - *List of email addresses matching SearchFilter and SearchCriteria
+ *The words or phrases used to search within a transcript.
* @public */ - EmailAddresses?: EmailAddressMetadata[] | undefined; + SearchText: string[] | undefined; /** - *The total number of email addresses which matched your search query.
+ *The match type combining search criteria using multiple search texts in a transcript + * criteria.
* @public */ - ApproximateTotalCount?: number | undefined; + MatchType: SearchContactsMatchType | undefined; } /** - *Filters to be applied to search results.
+ *A structure that defines search criteria and matching logic to search for contacts by + * matching text with transcripts analyzed by Amazon Connect Contact Lens.
* @public */ -export interface HoursOfOperationSearchFilter { +export interface Transcript { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
The list of search criteria based on Contact Lens conversational analytics + * transcript.
+ * @public + */ + Criteria: TranscriptCriteria[] | undefined; + + /** + *The match type combining search criteria using multiple transcript criteria.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; + MatchType?: SearchContactsMatchType | undefined; } /** + *A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
* @public */ -export interface SearchHoursOfOperationsResponse { +export interface ContactAnalysis { /** - *Information about the hours of operations.
+ *Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
* @public */ - HoursOfOperations?: HoursOfOperation[] | undefined; + Transcript?: Transcript | undefined; +} +/** + *The search criteria based on user-defined contact attribute key and values to search + * on.
+ * @public + */ +export interface SearchableContactAttributesCriteria { /** - *If there are additional results, this is the token for the next set of results.
+ *The key containing a searchable user-defined contact attribute.
* @public */ - NextToken?: string | undefined; + Key: string | undefined; /** - *The total number of hours of operations which matched your search query.
+ *The list of values to search for within a user-defined contact attribute.
* @public */ - ApproximateTotalCount?: number | undefined; + Values: string[] | undefined; } /** + *A structure that defines search criteria based on user-defined contact attributes that are + * configured for contact search.
* @public */ -export interface SearchPredefinedAttributesResponse { - /** - *Predefined attributes matched by the search criteria.
- * @public - */ - PredefinedAttributes?: PredefinedAttribute[] | undefined; - +export interface SearchableContactAttributes { /** - *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.
+ *The list of criteria based on user-defined contact attributes that are configured for + * contact search.
* @public */ - NextToken?: string | undefined; + Criteria: SearchableContactAttributesCriteria[] | undefined; /** - *The approximate number of predefined attributes which matched your search query.
+ *The match type combining search criteria using multiple searchable contact + * attributes.
* @public */ - ApproximateTotalCount?: number | undefined; + MatchType?: SearchContactsMatchType | undefined; } /** - *Filters to be applied to search results.
+ *The search criteria based on searchable segment attribute key and values to search + * on.
* @public */ -export interface PromptSearchFilter { +export interface SearchableSegmentAttributesCriteria { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
The key containing a searchable segment attribute.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; -} + Key: string | undefined; -/** - * @public - */ -export interface SearchPromptsResponse { /** - *Information about the prompts.
+ *The list of values to search for within a searchable segment attribute.
* @public */ - Prompts?: Prompt[] | undefined; + Values: string[] | undefined; +} +/** + *The search criteria based on searchable segment attributes of a contact
+ * @public + */ +export interface SearchableSegmentAttributes { /** - *If there are additional results, this is the token for the next set of results.
+ *The list of criteria based on searchable segment attributes.
* @public */ - NextToken?: string | undefined; + Criteria: SearchableSegmentAttributesCriteria[] | undefined; /** - *The total number of quick connects which matched your search query.
+ *The match type combining search criteria using multiple searchable segment + * attributes.
* @public */ - ApproximateTotalCount?: number | undefined; + MatchType?: SearchContactsMatchType | undefined; } /** - * @public - * @enum - */ -export const SearchableQueueType = { - STANDARD: "STANDARD", -} as const; - -/** - * @public - */ -export type SearchableQueueType = (typeof SearchableQueueType)[keyof typeof SearchableQueueType]; - -/** - *Filters to be applied to search results.
+ *A structure of search criteria to be used to return contacts.
* @public */ -export interface QueueSearchFilter { +export interface SearchCriteria { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
The identifiers of agents who handled the contacts.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; -} + AgentIds?: string[] | undefined; -/** - * @public - */ -export interface SearchQueuesResponse { /** - *Information about the queues.
+ *The agent hierarchy groups of the agent at the time of handling the contact.
* @public */ - Queues?: Queue[] | undefined; + AgentHierarchyGroups?: AgentHierarchyGroups | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *The list of channels associated with contacts.
* @public */ - NextToken?: string | undefined; + Channels?: Channel[] | undefined; /** - *The total number of queues which matched your search query.
+ *Search criteria based on analysis outputs from Amazon Connect Contact Lens.
* @public */ - ApproximateTotalCount?: number | undefined; -} + ContactAnalysis?: ContactAnalysis | undefined; -/** - *Filters to be applied to search results.
- * @public - */ -export interface QuickConnectSearchFilter { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
The list of initiation methods associated with contacts.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; -} + InitiationMethods?: ContactInitiationMethod[] | undefined; -/** - * @public - */ -export interface SearchQuickConnectsResponse { /** - *Information about the quick connects.
+ *The list of queue IDs associated with contacts.
* @public */ - QuickConnects?: QuickConnect[] | undefined; + QueueIds?: string[] | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *The search criteria based on user-defined contact attributes that have been configured for + * contact search. For more information, see Search by custom contact + * attributes in the Amazon Connect Administrator Guide.
+ *To use SearchableContactAttributes
in a search request, the
+ * GetContactAttributes
action is required to perform an API request. For more
+ * information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The total number of quick connects which matched your search query.
+ *The search criteria based on searchable segment attributes of a contact.
* @public */ - ApproximateTotalCount?: number | undefined; + SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined; } /** - *Maximum number (1000) of tags have been returned with current request. Consider changing - * request parameters to get more tags.
* @public + * @enum */ -export class MaximumResultReturnedException extends __BaseException { - readonly name: "MaximumResultReturnedException" = "MaximumResultReturnedException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe search criteria to be used to return tags.
* @public */ -export interface TagSearchCondition { +export type SortableFieldName = (typeof SortableFieldName)[keyof typeof SortableFieldName]; + +/** + *A structure that defines the field name to sort by and a sort order.
+ * @public + */ +export interface Sort { /** - *The tag key used in the tag search condition.
+ *The name of the field on which to sort.
* @public */ - tagKey?: string | undefined; + FieldName: SortableFieldName | undefined; /** - *The tag value used in the tag search condition.
+ *An ascending or descending sort.
* @public */ - tagValue?: string | undefined; + Order: SortOrder | undefined; +} - /** - *The type of comparison to be made when evaluating the tag key in tag search - * condition.
+/** + * @public + * @enum + */ +export const SearchContactsTimeRangeType = { + CONNECTED_TO_AGENT_TIMESTAMP: "CONNECTED_TO_AGENT_TIMESTAMP", + DISCONNECT_TIMESTAMP: "DISCONNECT_TIMESTAMP", + INITIATION_TIMESTAMP: "INITIATION_TIMESTAMP", + SCHEDULED_TIMESTAMP: "SCHEDULED_TIMESTAMP", +} as const; + +/** + * @public + */ +export type SearchContactsTimeRangeType = + (typeof SearchContactsTimeRangeType)[keyof typeof SearchContactsTimeRangeType]; + +/** + *A structure of time range that you want to search results.
+ * @public + */ +export interface SearchContactsTimeRange { + /** + *The type of timestamp to search.
* @public */ - tagKeyComparisonType?: StringComparisonType | undefined; + Type: SearchContactsTimeRangeType | undefined; /** - *The type of comparison to be made when evaluating the tag value in tag search - * condition.
+ *The start time of the time range.
* @public */ - tagValueComparisonType?: StringComparisonType | undefined; -} + StartTime: Date | undefined; -/** - *The search criteria to be used to search tags.
- * @public - */ -export interface ResourceTagsSearchCriteria { /** - *The search criteria to be used to return tags.
+ *The end time of the time range.
* @public */ - TagSearchCondition?: TagSearchCondition | undefined; + EndTime: Date | undefined; } /** * @public */ -export interface SearchResourceTagsRequest { +export interface SearchContactsRequest { /** - *The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon + *
The identifier of Amazon Connect instance. You can find the instance ID in the Amazon * Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** - *The list of resource types to be used to search tags from. If not provided or if any empty - * list is provided, this API will search from all supported resource types.
- *- * Supported resource types - *
- *AGENT
- *ROUTING_PROFILE
- *STANDARD_QUEUE
- *SECURITY_PROFILE
- *OPERATING_HOURS
- *PROMPT
- *CONTACT_FLOW
- *FLOW_MODULE
- *Time range that you want to search results.
* @public */ - ResourceTypes?: string[] | undefined; + TimeRange: SearchContactsTimeRange | undefined; /** - *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.
+ *The search criteria to be used to return contacts.
* @public */ - NextToken?: string | undefined; + SearchCriteria?: SearchCriteria | undefined; /** *The maximum number of results to return per page.
@@ -3202,167 +2948,162 @@ export interface SearchResourceTagsRequest { MaxResults?: number | undefined; /** - *The search criteria to be used to return tags.
+ *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.
* @public */ - SearchCriteria?: ResourceTagsSearchCriteria | undefined; + NextToken?: string | undefined; + + /** + *Specifies a field to sort by and a sort order.
+ * @public + */ + Sort?: Sort | undefined; } /** - *A tag set contains tag key and tag value.
+ *Information about the agent who accepted the contact.
* @public */ -export interface TagSet { +export interface ContactSearchSummaryAgentInfo { /** - *The tag key in the TagSet.
+ *The identifier of the agent who accepted the contact.
* @public */ - key?: string | undefined; + Id?: string | undefined; /** - *The tag value in the tagSet.
+ *The timestamp when the contact was connected to the agent.
* @public */ - value?: string | undefined; + ConnectedToAgentTimestamp?: Date | undefined; } /** + *If this contact was queued, this contains information about the queue.
* @public */ -export interface SearchResourceTagsResponse { +export interface ContactSearchSummaryQueueInfo { /** - *A list of tags used in the Amazon Connect instance.
+ *The unique identifier for the queue.
* @public */ - Tags?: TagSet[] | undefined; + Id?: string | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *The timestamp when the contact was added to the queue.
* @public */ - NextToken?: string | undefined; + EnqueueTimestamp?: Date | undefined; } /** - *Filters to be applied to search results.
+ *The value of a segment attribute. This is structured as a map with a single key-value pair. + * The key 'valueString' indicates that the attribute type is a string, and its corresponding value + * is the actual string value of the segment attribute.
* @public */ -export interface RoutingProfileSearchFilter { +export interface ContactSearchSummarySegmentAttributeValue { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
The value of a segment attribute represented as a string.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; + ValueString?: string | undefined; } /** + *Information of returned contact.
* @public */ -export interface SearchRoutingProfilesResponse { +export interface ContactSearchSummary { /** - *Information about the routing profiles.
+ *The Amazon Resource Name (ARN) of the contact.
* @public */ - RoutingProfiles?: RoutingProfile[] | undefined; + Arn?: string | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *The identifier of the contact summary.
* @public */ - NextToken?: string | undefined; + Id?: string | undefined; /** - *The total number of routing profiles which matched your search query.
+ *If this contact is related to other contacts, this is the ID of the initial contact.
* @public */ - ApproximateTotalCount?: number | undefined; -} + InitialContactId?: string | undefined; -/** - *Filters to be applied to search results.
- * @public - */ -export interface SecurityProfilesSearchFilter { /** - *An object that can be used to specify Tag conditions inside the SearchFilter
.
- * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
- * operator
Inner list specifies conditions that need to be applied with AND
- * operator.
If this contact is not the first contact, this is the ID of the previous contact.
* @public */ - TagFilter?: ControlPlaneTagFilter | undefined; -} + PreviousContactId?: string | undefined; -/** - *Information about the returned security profiles.
- * @public - */ -export interface SecurityProfileSearchSummary { /** - *The identifier of the security profile.
+ *Indicates how the contact was initiated.
* @public */ - Id?: string | undefined; + InitiationMethod?: ContactInitiationMethod | undefined; /** - *The organization resource identifier.
+ *How the contact reached your contact center.
* @public */ - OrganizationResourceId?: string | undefined; + Channel?: Channel | undefined; /** - *The Amazon Resource Name (ARN) of the security profile.
+ *If this contact was queued, this contains information about the queue.
* @public */ - Arn?: string | undefined; + QueueInfo?: ContactSearchSummaryQueueInfo | undefined; /** - *The name of the security profile.
+ *Information about the agent who accepted the contact.
* @public */ - SecurityProfileName?: string | undefined; + AgentInfo?: ContactSearchSummaryAgentInfo | undefined; /** - *The description of the security profile.
+ *The date and time this contact was initiated, in UTC time. For INBOUND
, this is
+ * when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For
+ * CALLBACK
, this is when the callback contact was created. For TRANSFER
+ * and QUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when
+ * the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing
+ * the external participant. For MONITOR
, this is when the supervisor started listening
+ * to a contact.
The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The timestamp when the customer endpoint disconnected from Amazon Connect.
* @public */ - Tags?: RecordThe timestamp, in Unix epoch time format, at which to start running the inbound flow.
+ * @public + */ + ScheduledTimestamp?: Date | undefined; + + /** + *Set of segment attributes for a contact.
+ * @public + */ + SegmentAttributes?: RecordInformation about the security profiles.
+ *Information about the contacts.
* @public */ - SecurityProfiles?: SecurityProfileSearchSummary[] | undefined; + Contacts: ContactSearchSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
@@ -3371,270 +3112,236 @@ export interface SearchSecurityProfilesResponse { NextToken?: string | undefined; /** - *The total number of security profiles which matched your search query.
+ *The total number of contacts which matched your search query.
* @public */ - ApproximateTotalCount?: number | undefined; + TotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ -export interface UserHierarchyGroupSearchFilter { +export interface EmailAddressSearchFilter { /** - *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts - * an OR or AND (List of List) input where:
+ *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
- * operator.
Top level list specifies conditions that need to be applied with OR
+ * operator
The inner list specifies conditions that need to be applied with AND
+ *
Inner list specifies conditions that need to be applied with AND
* operator.
Contains information about an email address for a contact center.
* @public */ -export interface SearchUserHierarchyGroupsResponse { +export interface EmailAddressMetadata { /** - *Information about the userHierarchyGroups.
+ *The identifier of the email address.
* @public */ - UserHierarchyGroups?: HierarchyGroup[] | undefined; + EmailAddressId?: string | undefined; /** - *If there are additional results, this is the token for the next set of results.
+ *The Amazon Resource Name (ARN) of the email address.
* @public */ - NextToken?: string | undefined; + EmailAddressArn?: string | undefined; /** - *The total number of userHierarchyGroups which matched your search query.
+ *The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.
* @public */ - ApproximateTotalCount?: number | undefined; -} + EmailAddress?: string | undefined; -/** - * @public - * @enum - */ -export const HierarchyGroupMatchType = { - EXACT: "EXACT", - WITH_CHILD_GROUPS: "WITH_CHILD_GROUPS", -} as const; + /** + *The description of the email address.
+ * @public + */ + Description?: string | undefined; + + /** + *The display name of email address.
+ * @public + */ + DisplayName?: string | undefined; +} /** * @public */ -export type HierarchyGroupMatchType = (typeof HierarchyGroupMatchType)[keyof typeof HierarchyGroupMatchType]; +export interface SearchEmailAddressesResponse { + /** + *If there are additional results, this is the token for the next set of results.
+ * @public + */ + NextToken?: string | undefined; -/** - *A leaf node condition which can be used to specify a hierarchy group condition.
- * @public - */ -export interface HierarchyGroupCondition { /** - *The value in the hierarchy group condition.
+ *List of email addresses matching SearchFilter and SearchCriteria
* @public */ - Value?: string | undefined; + EmailAddresses?: EmailAddressMetadata[] | undefined; /** - *The type of hierarchy group match.
+ *The total number of email addresses which matched your search query.
* @public */ - HierarchyGroupMatchType?: HierarchyGroupMatchType | undefined; + ApproximateTotalCount?: number | undefined; } /** * @public * @enum */ -export const NumberComparisonType = { - EQUAL: "EQUAL", - GREATER: "GREATER", - GREATER_OR_EQUAL: "GREATER_OR_EQUAL", - LESSER: "LESSER", - LESSER_OR_EQUAL: "LESSER_OR_EQUAL", - NOT_EQUAL: "NOT_EQUAL", - RANGE: "RANGE", +export const DateComparisonType = { + EQUAL_TO: "EQUAL_TO", + GREATER_THAN: "GREATER_THAN", + GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO", + LESS_THAN: "LESS_THAN", + LESS_THAN_OR_EQUAL_TO: "LESS_THAN_OR_EQUAL_TO", } as const; /** * @public */ -export type NumberComparisonType = (typeof NumberComparisonType)[keyof typeof NumberComparisonType]; +export type DateComparisonType = (typeof DateComparisonType)[keyof typeof DateComparisonType]; /** - *A leaf node condition which can be used to specify a numeric condition.
- *The currently supported value for FieldName
is limit
.
An object to specify the hours of operation override date condition.
* @public */ -export interface NumberCondition { +export interface DateCondition { /** - *The name of the field in the number condition.
+ *An object to specify the hours of operation override date field.
* @public */ FieldName?: string | undefined; /** - *The minValue to be used while evaluating the number condition.
- * @public - */ - MinValue?: number | undefined; - - /** - *The maxValue to be used while evaluating the number condition.
+ *An object to specify the hours of operation override date value.
* @public */ - MaxValue?: number | undefined; + Value?: string | undefined; /** - *The type of comparison to be made when evaluating the number condition.
+ *An object to specify the hours of operation override date condition
+ * comparisonType
.
A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and - * ProficiencyLimit.
+ *Filters to be applied to search results.
* @public */ -export interface Condition { - /** - *A leaf node condition which can be used to specify a string condition.
- *The currently supported values for FieldName
are name
and
- * value
.
A leaf node condition which can be used to specify a numeric condition.
+ *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
+ * operator
Inner list specifies conditions that need to be applied with AND
+ * operator.
Information about the hours of operations overrides.
+ * @public + */ + HoursOfOperationOverrides?: HoursOfOperationOverride[] | undefined; -/** - *A leaf node condition which can be used to specify a List condition to search users with - * attributes included in Lists like Proficiencies.
- * @public - */ -export interface ListCondition { /** - *The type of target list that will be used to filter the users.
+ *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. Length Constraints: Minimum length of 1. + * Maximum length of 2500.
* @public */ - TargetListType?: TargetListType | undefined; + NextToken?: string | undefined; /** - *A list of Condition objects which would be applied together with an AND condition.
+ *The total number of hours of operations which matched your search query.
* @public */ - Conditions?: Condition[] | undefined; + ApproximateTotalCount?: number | undefined; } /** - *A list of conditions which would be applied together with an AND
- * condition.
A leaf node condition which can be used to specify a tag condition.
+ *Information about the hours of operations.
* @public */ - TagConditions?: TagCondition[] | undefined; + HoursOfOperations?: HoursOfOperation[] | undefined; /** - *A leaf node condition which can be used to specify a hierarchy group condition.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - HierarchyGroupCondition?: HierarchyGroupCondition | undefined; -} + NextToken?: string | undefined; -/** - *An object that can be used to specify Tag conditions or Hierarchy Group conditions inside
- * the SearchFilter
.
This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
- * operator
The inner list specifies conditions that need to be applied with AND
- * operator.
Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum - * number of allowed Hierarchy Group conditions is 20.
- *A list of conditions which would be applied together with an OR
- * condition.
The total number of hours of operations which matched your search query.
* @public */ - OrConditions?: AttributeAndCondition[] | undefined; + ApproximateTotalCount?: number | undefined; +} +/** + * @public + */ +export interface SearchPredefinedAttributesResponse { /** - *A list of conditions which would be applied together with an AND
- * condition.
Predefined attributes matched by the search criteria.
* @public */ - AndCondition?: AttributeAndCondition | undefined; + PredefinedAttributes?: PredefinedAttribute[] | undefined; /** - *A leaf node condition which can be used to specify a tag condition, for example, HAVE
- * BPO = 123
.
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.
* @public */ - TagCondition?: TagCondition | undefined; + NextToken?: string | undefined; /** - *A leaf node condition which can be used to specify a hierarchy group condition.
+ *The approximate number of predefined attributes which matched your search query.
* @public */ - HierarchyGroupCondition?: HierarchyGroupCondition | undefined; + ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ -export interface UserSearchFilter { +export interface PromptSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter
.
* This accepts an OR
of AND
(List of List) input where:
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside - * the SearchFilter.
- *This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
- * operator.
The inner list specifies conditions that need to be applied with AND
- * operator.
Only one field can be populated. This object can’t be used along with TagFilter. Request - * can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of - * both is not supported and such request will throw AccessDeniedException.
- *The user's first name and last name.
- * @public - */ -export interface UserIdentityInfoLite { - /** - *The user's first name.
- * @public - */ - FirstName?: string | undefined; - - /** - *The user's last name.
- * @public - */ - LastName?: string | undefined; } /** - *Information about the returned users.
* @public */ -export interface UserSearchSummary { +export interface SearchPromptsResponse { /** - *The Amazon Resource Name (ARN) of the user.
+ *Information about the prompts.
* @public */ - Arn?: string | undefined; + Prompts?: Prompt[] | undefined; /** - *The directory identifier of the user.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - DirectoryUserId?: string | undefined; + NextToken?: string | undefined; /** - *The identifier of the user's hierarchy group.
+ *The total number of quick connects which matched your search query.
* @public */ - HierarchyGroupId?: string | undefined; + ApproximateTotalCount?: number | undefined; +} - /** - *The identifier of the user's summary.
- * @public - */ - Id?: string | undefined; +/** + * @public + * @enum + */ +export const SearchableQueueType = { + STANDARD: "STANDARD", +} as const; - /** - *The user's first name and last name.
- * @public - */ - IdentityInfo?: UserIdentityInfoLite | undefined; +/** + * @public + */ +export type SearchableQueueType = (typeof SearchableQueueType)[keyof typeof SearchableQueueType]; +/** + *Filters to be applied to search results.
+ * @public + */ +export interface QueueSearchFilter { /** - *Contains information about the phone configuration settings for a user.
+ *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
+ * operator
Inner list specifies conditions that need to be applied with AND
+ * operator.
The identifier of the user's routing profile.
+ *Information about the queues.
* @public */ - RoutingProfileId?: string | undefined; + Queues?: Queue[] | undefined; /** - *The identifiers of the user's security profiles.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - SecurityProfileIds?: string[] | undefined; + NextToken?: string | undefined; /** - *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The total number of queues which matched your search query.
* @public */ - Tags?: RecordFilters to be applied to search results.
+ * @public + */ +export interface QuickConnectSearchFilter { /** - *The name of the user.
+ *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
+ * operator
Inner list specifies conditions that need to be applied with AND
+ * operator.
Information about the users.
+ *Information about the quick connects.
* @public */ - Users?: UserSearchSummary[] | undefined; + QuickConnects?: QuickConnect[] | undefined; /** *If there are additional results, this is the token for the next set of results.
@@ -3777,115 +3482,173 @@ export interface SearchUsersResponse { NextToken?: string | undefined; /** - *The total number of users who matched your search query.
+ *The total number of quick connects which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** + *Maximum number (1000) of tags have been returned with current request. Consider changing + * request parameters to get more tags.
* @public */ -export interface SearchVocabulariesRequest { +export class MaximumResultReturnedException extends __BaseException { + readonly name: "MaximumResultReturnedException" = "MaximumResultReturnedException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public + * @internal */ - InstanceId: string | undefined; + constructor(opts: __ExceptionOptionTypeThe search criteria to be used to return tags.
+ * @public + */ +export interface TagSearchCondition { /** - *The maximum number of results to return per page.
+ *The tag key used in the tag search condition.
* @public */ - MaxResults?: number | undefined; + tagKey?: string | undefined; /** - *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.
+ *The tag value used in the tag search condition.
* @public */ - NextToken?: string | undefined; + tagValue?: string | undefined; /** - *The current state of the custom vocabulary.
+ *The type of comparison to be made when evaluating the tag key in tag search + * condition.
* @public */ - State?: VocabularyState | undefined; + tagKeyComparisonType?: StringComparisonType | undefined; /** - *The starting pattern of the name of the vocabulary.
+ *The type of comparison to be made when evaluating the tag value in tag search + * condition.
* @public */ - NameStartsWith?: string | undefined; + tagValueComparisonType?: StringComparisonType | undefined; +} +/** + *The search criteria to be used to search tags.
+ * @public + */ +export interface ResourceTagsSearchCriteria { /** - *The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see - * What is Amazon Transcribe? - *
+ *The search criteria to be used to return tags.
* @public */ - LanguageCode?: VocabularyLanguageCode | undefined; + TagSearchCondition?: TagSearchCondition | undefined; } /** - *Contains summary information about the custom vocabulary.
* @public */ -export interface VocabularySummary { +export interface SearchResourceTagsRequest { /** - *A unique name of the custom vocabulary.
+ *The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon + * Resource Name (ARN) of the instance.
* @public */ - Name: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the custom vocabulary.
+ *The list of resource types to be used to search tags from. If not provided or if any empty + * list is provided, this API will search from all supported resource types.
+ *+ * Supported resource types + *
+ *AGENT
+ *ROUTING_PROFILE
+ *STANDARD_QUEUE
+ *SECURITY_PROFILE
+ *OPERATING_HOURS
+ *PROMPT
+ *CONTACT_FLOW
+ *FLOW_MODULE
+ *The Amazon Resource Name (ARN) of the custom vocabulary.
+ *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.
* @public */ - Arn: string | undefined; + NextToken?: string | undefined; /** - *The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see - * What is Amazon Transcribe? - *
+ *The maximum number of results to return per page.
* @public */ - LanguageCode: VocabularyLanguageCode | undefined; + MaxResults?: number | undefined; /** - *The current state of the custom vocabulary.
+ *The search criteria to be used to return tags.
* @public */ - State: VocabularyState | undefined; + SearchCriteria?: ResourceTagsSearchCriteria | undefined; +} +/** + *A tag set contains tag key and tag value.
+ * @public + */ +export interface TagSet { /** - *The timestamp when the custom vocabulary was last modified.
+ *The tag key in the TagSet.
* @public */ - LastModifiedTime: Date | undefined; + key?: string | undefined; /** - *The reason why the custom vocabulary was not created.
+ *The tag value in the tagSet.
* @public */ - FailureReason?: string | undefined; + value?: string | undefined; } /** * @public */ -export interface SearchVocabulariesResponse { +export interface SearchResourceTagsResponse { /** - *The list of the available custom vocabularies.
+ *A list of tags used in the Amazon Connect instance.
* @public */ - VocabularySummaryList?: VocabularySummary[] | undefined; + Tags?: TagSet[] | undefined; /** *If there are additional results, this is the token for the next set of results.
@@ -3895,1257 +3658,1354 @@ export interface SearchVocabulariesResponse { } /** - * @public - * @enum - */ -export const ChatEventType = { - DISCONNECT: "DISCONNECT", - EVENT: "EVENT", - MESSAGE: "MESSAGE", -} as const; - -/** - * @public - */ -export type ChatEventType = (typeof ChatEventType)[keyof typeof ChatEventType]; - -/** - *Chat integration event containing payload to perform different chat actions such as:
- *Sending a chat message
- *Sending a chat event, such as typing
- *Disconnecting from a chat
- *Filters to be applied to search results.
* @public */ -export interface ChatEvent { - /** - *Type of chat integration event.
- * @public - */ - Type: ChatEventType | undefined; - - /** - *Type of content. This is required when Type
is MESSAGE
or
- * EVENT
.
For allowed message content types, see the ContentType
parameter in the
- * SendMessage topic in the Amazon Connect Participant Service API
- * Reference.
For allowed event content types, see the ContentType
parameter in the SendEvent topic in the Amazon Connect Participant Service API
- * Reference.
Content of the message or event. This is required when Type
is
- * MESSAGE
and for certain ContentTypes
when Type
is
- * EVENT
.
An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
For allowed message content, see the Content
parameter in the SendMessage topic in the Amazon Connect Participant Service API
- * Reference.
Top level list specifies conditions that need to be applied with OR
+ * operator
For allowed event content, see the Content
parameter in the SendEvent topic in the Amazon Connect Participant Service API
- * Reference.
Inner list specifies conditions that need to be applied with AND
+ * operator.
The customer's details.
* @public */ -export interface ParticipantDetails { +export interface SearchRoutingProfilesResponse { /** - *Display name of the participant.
+ *Information about the routing profiles.
* @public */ - DisplayName: string | undefined; + RoutingProfiles?: RoutingProfile[] | undefined; + + /** + *If there are additional results, this is the token for the next set of results.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The total number of routing profiles which matched your search query.
+ * @public + */ + ApproximateTotalCount?: number | undefined; } /** - *The streaming configuration, such as the Amazon SNS streaming endpoint.
+ *Filters to be applied to search results.
* @public */ -export interface ChatStreamingConfiguration { +export interface SecurityProfilesSearchFilter { /** - *The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used - * to publish real-time message streaming for chat conversations.
+ *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
+ * operator
Inner list specifies conditions that need to be applied with AND
+ * operator.
Payload of chat properties to apply when starting a new contact.
+ *Information about the returned security profiles.
* @public */ -export interface NewSessionDetails { +export interface SecurityProfileSearchSummary { /** - * The supported chat message content types. Supported types are text/plain
,
- * text/markdown
, application/json
,
- * application/vnd.amazonaws.connect.message.interactive
, and
- * application/vnd.amazonaws.connect.message.interactive.response
.
Content types must always contain text/plain
. You can then put any other
- * supported type in the list. For example, all the following lists are valid because they contain
- * text/plain
: [text/plain, text/markdown, application/json]
,
- * [text/markdown, text/plain]
, [text/plain, application/json,
- * application/vnd.amazonaws.connect.message.interactive.response]
.
The identifier of the security profile.
* @public */ - SupportedMessagingContentTypes?: string[] | undefined; + Id?: string | undefined; /** - *The customer's details.
+ *The organization resource identifier.
* @public */ - ParticipantDetails?: ParticipantDetails | undefined; + OrganizationResourceId?: string | undefined; /** - *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
- *There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute - * keys can include only alphanumeric, dash, and underscore characters.
+ *The Amazon Resource Name (ARN) of the security profile.
* @public */ - Attributes?: RecordThe streaming configuration, such as the Amazon SNS streaming endpoint.
+ *The name of the security profile.
* @public */ - StreamingConfiguration?: ChatStreamingConfiguration | undefined; + SecurityProfileName?: string | undefined; + + /** + *The description of the security profile.
+ * @public + */ + Description?: string | undefined; + + /** + *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
+ * @public + */ + Tags?: RecordExternal identifier of chat customer participant, used in part to uniquely identify a chat. - * For SMS, this is the E164 phone number of the chat customer participant.
+ *Information about the security profiles.
* @public */ - SourceId: string | undefined; + SecurityProfiles?: SecurityProfileSearchSummary[] | undefined; /** - *Chat system identifier, used in part to uniquely identify chat. This is associated with the - * Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is - * the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - DestinationId: string | undefined; + NextToken?: string | undefined; /** - *Classification of a channel. This is used in part to uniquely identify chat.
- *Valid value: ["connect:sms", connect:"WhatsApp"]
- *
The total number of security profiles which matched your search query.
* @public */ - Subtype?: string | undefined; + ApproximateTotalCount?: number | undefined; +} +/** + *Filters to be applied to search results.
+ * @public + */ +export interface UserHierarchyGroupSearchFilter { /** - *Chat integration event payload
+ *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts + * an OR or AND (List of List) input where:
+ *The top level list specifies conditions that need to be applied with OR
+ * operator.
The inner list specifies conditions that need to be applied with AND
+ * operator.
Information about the userHierarchyGroups.
+ * @public + */ + UserHierarchyGroups?: HierarchyGroup[] | undefined; /** - *Contact properties to apply when starting a new chat. If the integration event is handled - * with an existing chat, this is ignored.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - NewSessionDetails?: NewSessionDetails | undefined; + NextToken?: string | undefined; + + /** + *The total number of userHierarchyGroups which matched your search query.
+ * @public + */ + ApproximateTotalCount?: number | undefined; } /** * @public + * @enum */ -export interface SendChatIntegrationEventResponse { +export const HierarchyGroupMatchType = { + EXACT: "EXACT", + WITH_CHILD_GROUPS: "WITH_CHILD_GROUPS", +} as const; + +/** + * @public + */ +export type HierarchyGroupMatchType = (typeof HierarchyGroupMatchType)[keyof typeof HierarchyGroupMatchType]; + +/** + *A leaf node condition which can be used to specify a hierarchy group condition.
+ * @public + */ +export interface HierarchyGroupCondition { /** - *Identifier of chat contact used to handle integration event. This may be null if the - * integration event is not valid without an already existing chat contact.
+ *The value in the hierarchy group condition.
* @public */ - InitialContactId?: string | undefined; + Value?: string | undefined; /** - *Whether handling the integration event resulted in creating a new chat or acting on existing - * chat.
+ *The type of hierarchy group match.
* @public */ - NewChatCreated?: boolean | undefined; + HierarchyGroupMatchType?: HierarchyGroupMatchType | undefined; } /** - *Contains information about a source or destination email address
* @public + * @enum */ -export interface EmailAddressInfo { +export const NumberComparisonType = { + EQUAL: "EQUAL", + GREATER: "GREATER", + GREATER_OR_EQUAL: "GREATER_OR_EQUAL", + LESSER: "LESSER", + LESSER_OR_EQUAL: "LESSER_OR_EQUAL", + NOT_EQUAL: "NOT_EQUAL", + RANGE: "RANGE", +} as const; + +/** + * @public + */ +export type NumberComparisonType = (typeof NumberComparisonType)[keyof typeof NumberComparisonType]; + +/** + *A leaf node condition which can be used to specify a numeric condition.
+ *The currently supported value for FieldName
is limit
.
The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.
+ *The name of the field in the number condition.
* @public */ - EmailAddress: string | undefined; + FieldName?: string | undefined; /** - *The display name of email address.
+ *The minValue to be used while evaluating the number condition.
* @public */ - DisplayName?: string | undefined; + MinValue?: number | undefined; + + /** + *The maxValue to be used while evaluating the number condition.
+ * @public + */ + MaxValue?: number | undefined; + + /** + *The type of comparison to be made when evaluating the number condition.
+ * @public + */ + ComparisonType?: NumberComparisonType | undefined; } /** - *The additional recipients information of outbound email.
+ *A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and + * ProficiencyLimit.
* @public */ -export interface OutboundAdditionalRecipients { +export interface Condition { /** - *The additional CC email address recipients information.
+ *A leaf node condition which can be used to specify a string condition.
+ *The currently supported values for FieldName
are name
and
+ * value
.
A leaf node condition which can be used to specify a numeric condition.
+ * @public + */ + NumberCondition?: NumberCondition | undefined; } /** * @public * @enum */ -export const OutboundMessageSourceType = { - RAW: "RAW", - TEMPLATE: "TEMPLATE", +export const TargetListType = { + PROFICIENCIES: "PROFICIENCIES", } as const; /** * @public */ -export type OutboundMessageSourceType = (typeof OutboundMessageSourceType)[keyof typeof OutboundMessageSourceType]; - -/** - *Information about the raw email body content.
- * @public - */ -export interface OutboundRawMessage { - /** - *The email subject.
- * @public - */ - Subject: string | undefined; +export type TargetListType = (typeof TargetListType)[keyof typeof TargetListType]; +/** + *A leaf node condition which can be used to specify a List condition to search users with + * attributes included in Lists like Proficiencies.
+ * @public + */ +export interface ListCondition { /** - *The email message body.
+ *The type of target list that will be used to filter the users.
* @public */ - Body: string | undefined; + TargetListType?: TargetListType | undefined; /** - *Type of content, that is, text/plain
or text/html
.
A list of Condition objects which would be applied together with an AND condition.
* @public */ - ContentType: string | undefined; + Conditions?: Condition[] | undefined; } /** - *Information about the template attributes.
+ *A list of conditions which would be applied together with an AND
+ * condition.
An object that specifies the custom attributes values to use for variables in the message - * template. This object contains different categories of key-value pairs. Each key defines a - * variable or placeholder in the message template.
+ *A leaf node condition which can be used to specify a tag condition.
* @public */ - CustomAttributes?: RecordAn object that specifies the customer profile attributes values to use for variables in the - * message template. This object contains different categories of key-value pairs. Each key defines - * a variable or placeholder in the message template.
+ *A leaf node condition which can be used to specify a hierarchy group condition.
* @public */ - CustomerProfileAttributes?: string | undefined; + HierarchyGroupCondition?: HierarchyGroupCondition | undefined; } /** - *Information about template message configuration.
+ *An object that can be used to specify Tag conditions or Hierarchy Group conditions inside
+ * the SearchFilter
.
This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
+ * operator
The inner list specifies conditions that need to be applied with AND
+ * operator.
Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum + * number of allowed Hierarchy Group conditions is 20.
+ *The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain - * the ARN.
+ *A list of conditions which would be applied together with an OR
+ * condition.
The identifier of the message template Id.
+ *A list of conditions which would be applied together with an AND
+ * condition.
Information about template attributes, that is, CustomAttributes or - * CustomerProfileAttributes.
+ *A leaf node condition which can be used to specify a tag condition, for example, HAVE
+ * BPO = 123
.
Information about email body content.
- * @public - */ -export interface OutboundEmailContent { /** - *The message source type, that is, RAW
or TEMPLATE
.
A leaf node condition which can be used to specify a hierarchy group condition.
* @public */ - MessageSourceType: OutboundMessageSourceType | undefined; + HierarchyGroupCondition?: HierarchyGroupCondition | undefined; +} +/** + *Filters to be applied to search results.
+ * @public + */ +export interface UserSearchFilter { /** - *Information about template message configuration.
+ *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
+ * operator
Inner list specifies conditions that need to be applied with AND
+ * operator.
The raw email body content.
+ *An object that can be used to specify Tag conditions or Hierarchy Group conditions inside + * the SearchFilter.
+ *This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
+ * operator.
The inner list specifies conditions that need to be applied with AND
+ * operator.
Only one field can be populated. This object can’t be used along with TagFilter. Request + * can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of + * both is not supported and such request will throw AccessDeniedException.
+ *Information about the campaign.
+ *The user's first name and last name.
* @public */ -export interface SourceCampaign { +export interface UserIdentityInfoLite { /** - *A unique identifier for a campaign.
+ *The user's first name.
* @public */ - CampaignId?: string | undefined; + FirstName?: string | undefined; /** - *A unique identifier for a each request part of same campaign.
+ *The user's last name.
* @public */ - OutboundRequestId?: string | undefined; + LastName?: string | undefined; } /** + *Information about the returned users.
* @public - * @enum */ -export const TrafficType = { - CAMPAIGN: "CAMPAIGN", - GENERAL: "GENERAL", -} as const; +export interface UserSearchSummary { + /** + *The Amazon Resource Name (ARN) of the user.
+ * @public + */ + Arn?: string | undefined; -/** - * @public - */ -export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType]; + /** + *The directory identifier of the user.
+ * @public + */ + DirectoryUserId?: string | undefined; -/** - * @public - */ -export interface SendOutboundEmailRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The identifier of the user's hierarchy group.
* @public */ - InstanceId: string | undefined; + HierarchyGroupId?: string | undefined; /** - *The email address to be used for sending email.
+ *The identifier of the user's summary.
* @public */ - FromEmailAddress: EmailAddressInfo | undefined; + Id?: string | undefined; /** - *The email address to send the email to.
+ *The user's first name and last name.
* @public */ - DestinationEmailAddress: EmailAddressInfo | undefined; + IdentityInfo?: UserIdentityInfoLite | undefined; /** - *The additional recipients address of the email in CC.
+ *Contains information about the phone configuration settings for a user.
* @public */ - AdditionalRecipients?: OutboundAdditionalRecipients | undefined; + PhoneConfig?: UserPhoneConfig | undefined; /** - *The email message body to be sent to the newly created email.
+ *The identifier of the user's routing profile.
* @public */ - EmailMessage: OutboundEmailContent | undefined; + RoutingProfileId?: string | undefined; /** - *Denotes the class of traffic.
+ *The identifiers of the user's security profiles.
* @public */ - TrafficType: TrafficType | undefined; + SecurityProfileIds?: string[] | undefined; /** - *A Campaign object need for Campaign traffic type.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ - SourceCampaign?: SourceCampaign | undefined; + Tags?: RecordA unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *The name of the user.
* @public */ - ClientToken?: string | undefined; + Username?: string | undefined; } /** * @public */ -export interface SendOutboundEmailResponse {} - -/** - * @public - */ -export interface StartAttachedFileUploadRequest { +export interface SearchUsersResponse { /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *Information about the users.
* @public */ - ClientToken?: string | undefined; + Users?: UserSearchSummary[] | undefined; /** - *The unique identifier of the Amazon Connect instance.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - InstanceId: string | undefined; + NextToken?: string | undefined; /** - *A case-sensitive name of the attached file being uploaded.
+ *The total number of users who matched your search query.
* @public */ - FileName: string | undefined; + ApproximateTotalCount?: number | undefined; +} +/** + * @public + */ +export interface SearchVocabulariesRequest { /** - *The size of the attached file in bytes.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - FileSizeInBytes: number | undefined; + InstanceId: string | undefined; /** - *Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is - * 300.
+ *The maximum number of results to return per page.
* @public */ - UrlExpiryInSeconds?: number | undefined; + MaxResults?: number | undefined; /** - *The use case for the file.
- * Only ATTACHMENTS
are supported.
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.
* @public */ - FileUseCaseType: FileUseCaseType | undefined; + NextToken?: string | undefined; /** - *The resource to which the attached file is (being) uploaded to. The supported resources are - * Cases and Email.
- *This value must be a valid ARN.
- *The current state of the custom vocabulary.
* @public */ - AssociatedResourceArn: string | undefined; + State?: VocabularyState | undefined; /** - *Represents the identity that created the file.
+ *The starting pattern of the name of the vocabulary.
* @public */ - CreatedBy?: CreatedByInfo | undefined; + NameStartsWith?: string | undefined; /** - *The tags used to organize, track, or control access for this resource. For example, \{
- * "Tags": \{"key1":"value1", "key2":"value2"\} \}
.
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see + * What is Amazon Transcribe? + *
* @public */ - Tags?: RecordFields required when uploading an attached file.
+ *Contains summary information about the custom vocabulary.
* @public */ -export interface UploadUrlMetadata { +export interface VocabularySummary { /** - *A pre-signed S3 URL that should be used for uploading the attached file.
+ *A unique name of the custom vocabulary.
* @public */ - Url?: string | undefined; + Name: string | undefined; /** - *The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:
- * yyyy-MM-ddThh:mm:ss.SSSZ
. For example,
- * 2019-11-08T02:41:28.172Z
.
The identifier of the custom vocabulary.
* @public */ - UrlExpiry?: string | undefined; + Id: string | undefined; /** - *A map of headers that should be provided when uploading the attached file.
+ *The Amazon Resource Name (ARN) of the custom vocabulary.
* @public */ - HeadersToInclude?: RecordThe unique identifier of the attached file resource (ARN).
+ *The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see + * What is Amazon Transcribe? + *
* @public */ - FileArn?: string | undefined; + LanguageCode: VocabularyLanguageCode | undefined; /** - *The unique identifier of the attached file resource.
+ *The current state of the custom vocabulary.
* @public */ - FileId?: string | undefined; + State: VocabularyState | undefined; /** - *The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601
- * format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example,
- * 2024-05-03T02:41:28.172Z
.
The timestamp when the custom vocabulary was last modified.
* @public */ - CreationTime?: string | undefined; + LastModifiedTime: Date | undefined; /** - *The current status of the attached file.
+ *The reason why the custom vocabulary was not created.
* @public */ - FileStatus?: FileStatusType | undefined; + FailureReason?: string | undefined; +} +/** + * @public + */ +export interface SearchVocabulariesResponse { /** - *Represents the identity that created the file.
+ *The list of the available custom vocabularies.
* @public */ - CreatedBy?: CreatedByInfo | undefined; + VocabularySummaryList?: VocabularySummary[] | undefined; /** - *Information to be used while uploading the attached file.
+ *If there are additional results, this is the token for the next set of results.
* @public */ - UploadUrlMetadata?: UploadUrlMetadata | undefined; + NextToken?: string | undefined; } /** - *A chat message.
* @public + * @enum */ -export interface ChatMessage { +export const ChatEventType = { + DISCONNECT: "DISCONNECT", + EVENT: "EVENT", + MESSAGE: "MESSAGE", +} as const; + +/** + * @public + */ +export type ChatEventType = (typeof ChatEventType)[keyof typeof ChatEventType]; + +/** + *Chat integration event containing payload to perform different chat actions such as:
+ *Sending a chat message
+ *Sending a chat event, such as typing
+ *Disconnecting from a chat
+ *The type of the content. Supported types are text/plain
,
- * text/markdown
, application/json
, and
- * application/vnd.amazonaws.connect.message.interactive.response
.
Type of chat integration event.
* @public */ - ContentType: string | undefined; + Type: ChatEventType | undefined; /** - *The content of the chat message.
+ *Type of content. This is required when Type
is MESSAGE
or
+ * EVENT
.
For text/plain
and text/markdown
, the Length Constraints are
- * Minimum of 1, Maximum of 1024.
For application/json
, the Length Constraints are Minimum of 1, Maximum of
- * 12000.
For allowed message content types, see the ContentType
parameter in the
+ * SendMessage topic in the Amazon Connect Participant Service API
+ * Reference.
For application/vnd.amazonaws.connect.message.interactive.response
, the
- * Length Constraints are Minimum of 1, Maximum of 12288.
For allowed event content types, see the ContentType
parameter in the SendEvent topic in the Amazon Connect Participant Service API
+ * Reference.
Enable persistent chats. For more information about enabling persistent chat, and for - * example use cases and how to configure for them, see Enable persistent chat.
- * @public - */ -export interface PersistentChat { /** - *The contactId that is used for rehydration depends on the rehydration type. RehydrationType - * is required for persistent chat.
+ *Content of the message or event. This is required when Type
is
+ * MESSAGE
and for certain ContentTypes
when Type
is
+ * EVENT
.
- * ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past
- * chat contact of the specified past ended chat session. To use this type, provide the
- * initialContactId
of the past ended chat session in the
- * sourceContactId
field. In this type, Amazon Connect determines the most
- * recent chat contact on the specified chat session that has ended, and uses it to start a
- * persistent chat.
For allowed message content, see the Content
parameter in the SendMessage topic in the Amazon Connect Participant Service API
+ * Reference.
- * FROM_SEGMENT
: Rehydrates a chat from the past chat contact that is specified
- * in the sourceContactId
field.
For allowed event content, see the Content
parameter in the SendEvent topic in the Amazon Connect Participant Service API
+ * Reference.
The actual contactId used for rehydration is provided in the response of this API.
* @public */ - RehydrationType?: RehydrationType | undefined; + Content?: string | undefined; +} +/** + *The customer's details.
+ * @public + */ +export interface ParticipantDetails { /** - *The contactId from which a persistent chat session must be started.
+ *Display name of the participant.
* @public */ - SourceContactId?: string | undefined; + DisplayName: string | undefined; } /** + *The streaming configuration, such as the Amazon SNS streaming endpoint.
* @public */ -export interface StartChatContactResponse { +export interface ChatStreamingConfiguration { /** - *The identifier of this contact within the Amazon Connect instance.
+ *The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used + * to publish real-time message streaming for chat conversations.
* @public */ - ContactId?: string | undefined; + StreamingEndpointArn: string | undefined; +} +/** + *Payload of chat properties to apply when starting a new contact.
+ * @public + */ +export interface NewSessionDetails { /** - *The identifier for a chat participant. The participantId for a chat participant is the same - * throughout the chat lifecycle.
+ * The supported chat message content types. Supported types are text/plain
,
+ * text/markdown
, application/json
,
+ * application/vnd.amazonaws.connect.message.interactive
, and
+ * application/vnd.amazonaws.connect.message.interactive.response
.
Content types must always contain text/plain
. You can then put any other
+ * supported type in the list. For example, all the following lists are valid because they contain
+ * text/plain
: [text/plain, text/markdown, application/json]
,
+ * [text/markdown, text/plain]
, [text/plain, application/json,
+ * application/vnd.amazonaws.connect.message.interactive.response]
.
The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat - * participant.
+ *The customer's details.
* @public */ - ParticipantToken?: string | undefined; + ParticipantDetails?: ParticipantDetails | undefined; /** - *The contactId from which a persistent chat session is started. This field is populated only - * for persistent chats.
+ *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
+ *There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute + * keys can include only alphanumeric, dash, and underscore characters.
* @public */ - ContinuedFromContactId?: string | undefined; + Attributes?: RecordThe streaming configuration, such as the Amazon SNS streaming endpoint.
+ * @public + */ + StreamingConfiguration?: ChatStreamingConfiguration | undefined; } /** * @public */ -export interface StartContactEvaluationRequest { +export interface SendChatIntegrationEventRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *External identifier of chat customer participant, used in part to uniquely identify a chat. + * For SMS, this is the E164 phone number of the chat customer participant.
* @public */ - InstanceId: string | undefined; + SourceId: string | undefined; /** - *The identifier of the contact in this instance of Amazon Connect.
+ *Chat system identifier, used in part to uniquely identify chat. This is associated with the + * Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is + * the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.
* @public */ - ContactId: string | undefined; + DestinationId: string | undefined; /** - *The unique identifier for the evaluation form.
+ *Classification of a channel. This is used in part to uniquely identify chat.
+ *Valid value: ["connect:sms", connect:"WhatsApp"]
+ *
A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *Chat integration event payload
* @public */ - ClientToken?: string | undefined; + Event: ChatEvent | undefined; + + /** + *Contact properties to apply when starting a new chat. If the integration event is handled + * with an existing chat, this is ignored.
+ * @public + */ + NewSessionDetails?: NewSessionDetails | undefined; } /** * @public */ -export interface StartContactEvaluationResponse { +export interface SendChatIntegrationEventResponse { /** - *A unique identifier for the contact evaluation.
+ *Identifier of chat contact used to handle integration event. This may be null if the + * integration event is not valid without an already existing chat contact.
* @public */ - EvaluationId: string | undefined; + InitialContactId?: string | undefined; /** - *The Amazon Resource Name (ARN) for the contact evaluation resource.
+ *Whether handling the integration event resulted in creating a new chat or acting on existing + * chat.
* @public */ - EvaluationArn: string | undefined; + NewChatCreated?: boolean | undefined; +} + +/** + *Contains information about a source or destination email address
+ * @public + */ +export interface EmailAddressInfo { + /** + *The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.
+ * @public + */ + EmailAddress: string | undefined; + + /** + *The display name of email address.
+ * @public + */ + DisplayName?: string | undefined; } /** - * @public - * @enum - */ -export const IvrRecordingTrack = { - ALL: "ALL", -} as const; - -/** + *The additional recipients information of outbound email.
* @public */ -export type IvrRecordingTrack = (typeof IvrRecordingTrack)[keyof typeof IvrRecordingTrack]; +export interface OutboundAdditionalRecipients { + /** + *The additional CC email address recipients information.
+ * @public + */ + CcEmailAddresses?: EmailAddressInfo[] | undefined; +} /** * @public * @enum */ -export const VoiceRecordingTrack = { - ALL: "ALL", - FROM_AGENT: "FROM_AGENT", - TO_AGENT: "TO_AGENT", +export const OutboundMessageSourceType = { + RAW: "RAW", + TEMPLATE: "TEMPLATE", } as const; /** * @public */ -export type VoiceRecordingTrack = (typeof VoiceRecordingTrack)[keyof typeof VoiceRecordingTrack]; +export type OutboundMessageSourceType = (typeof OutboundMessageSourceType)[keyof typeof OutboundMessageSourceType]; /** - *Contains information about the recording configuration settings.
+ *Information about the raw email body content.
* @public */ -export interface VoiceRecordingConfiguration { - /** - *Identifies which track is being recorded.
- * @public - */ - VoiceRecordingTrack?: VoiceRecordingTrack | undefined; - +export interface OutboundRawMessage { /** - *Identifies which IVR track is being recorded.
+ *The email subject.
* @public */ - IvrRecordingTrack?: IvrRecordingTrack | undefined; -} + Subject: string | undefined; -/** - * @public - */ -export interface StartContactRecordingRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The email message body.
* @public */ - InstanceId: string | undefined; + Body: string | undefined; /** - *The identifier of the contact.
+ *Type of content, that is, text/plain
or text/html
.
Information about the template attributes.
+ * @public + */ +export interface TemplateAttributes { /** - *The identifier of the contact. This is the identifier of the contact associated with the - * first interaction with the contact center.
+ *An object that specifies the custom attributes values to use for variables in the message + * template. This object contains different categories of key-value pairs. Each key defines a + * variable or placeholder in the message template.
* @public */ - InitialContactId: string | undefined; + CustomAttributes?: RecordThe person being recorded.
+ *An object that specifies the customer profile attributes values to use for variables in the + * message template. This object contains different categories of key-value pairs. Each key defines + * a variable or placeholder in the message template.
* @public */ - VoiceRecordingConfiguration: VoiceRecordingConfiguration | undefined; + CustomerProfileAttributes?: string | undefined; } /** + *Information about template message configuration.
* @public */ -export interface StartContactRecordingResponse {} - -/** - * @public - */ -export interface StartContactStreamingRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - +export interface TemplatedMessageConfig { /** - *The identifier of the contact. This is the identifier of the contact associated with the - * first interaction with the contact center.
+ *The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain + * the ARN.
* @public */ - ContactId: string | undefined; + KnowledgeBaseId: string | undefined; /** - *The streaming configuration, such as the Amazon SNS streaming endpoint.
+ *The identifier of the message template Id.
* @public */ - ChatStreamingConfiguration: ChatStreamingConfiguration | undefined; + MessageTemplateId: string | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *Information about template attributes, that is, CustomAttributes or + * CustomerProfileAttributes.
* @public */ - ClientToken?: string | undefined; + TemplateAttributes: TemplateAttributes | undefined; } /** + *Information about email body content.
* @public */ -export interface StartContactStreamingResponse { +export interface OutboundEmailContent { /** - *The identifier of the streaming configuration enabled.
+ *The message source type, that is, RAW
or TEMPLATE
.
The additional TO CC recipients information of inbound email.
- * @public - */ -export interface InboundAdditionalRecipients { /** - *The additional recipients information present in to list.
+ *Information about template message configuration.
* @public */ - ToAddresses?: EmailAddressInfo[] | undefined; + TemplatedMessageConfig?: TemplatedMessageConfig | undefined; /** - *The additional recipients information present in cc list.
+ *The raw email body content.
* @public */ - CcAddresses?: EmailAddressInfo[] | undefined; + RawMessage?: OutboundRawMessage | undefined; } /** - *Information about the email attachment files.
+ *Information about the campaign.
* @public */ -export interface EmailAttachment { +export interface SourceCampaign { /** - *A case-sensitive name of the attached file being uploaded.
+ *A unique identifier for a campaign.
* @public */ - FileName: string | undefined; + CampaignId?: string | undefined; /** - *The pre-signed URLs for the S3 bucket where the email attachment is stored.
+ *A unique identifier for a each request part of same campaign.
* @public */ - S3Url: string | undefined; + OutboundRequestId?: string | undefined; } /** * @public * @enum */ -export const InboundMessageSourceType = { - RAW: "RAW", +export const TrafficType = { + CAMPAIGN: "CAMPAIGN", + GENERAL: "GENERAL", } as const; /** * @public */ -export type InboundMessageSourceType = (typeof InboundMessageSourceType)[keyof typeof InboundMessageSourceType]; +export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType]; /** * @public - * @enum */ -export const EmailHeaderType = { - IN_REPLY_TO: "IN_REPLY_TO", - MESSAGE_ID: "MESSAGE_ID", - REFERENCES: "REFERENCES", - X_SES_SPAM_VERDICT: "X_SES_SPAM_VERDICT", - X_SES_VIRUS_VERDICT: "X_SES_VIRUS_VERDICT", -} as const; +export interface SendOutboundEmailRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; -/** - * @public - */ -export type EmailHeaderType = (typeof EmailHeaderType)[keyof typeof EmailHeaderType]; + /** + *The email address to be used for sending email.
+ * @public + */ + FromEmailAddress: EmailAddressInfo | undefined; -/** - *Information about the raw email body content.
- * @public - */ -export interface InboundRawMessage { /** - *The email subject.
+ *The email address to send the email to.
* @public */ - Subject: string | undefined; + DestinationEmailAddress: EmailAddressInfo | undefined; /** - *The email message body.
+ *The additional recipients address of the email in CC.
* @public */ - Body: string | undefined; + AdditionalRecipients?: OutboundAdditionalRecipients | undefined; /** - *Type of content, that is, text/plain
or text/html
.
The email message body to be sent to the newly created email.
* @public */ - ContentType: string | undefined; + EmailMessage: OutboundEmailContent | undefined; /** - *Headers present in inbound email.
+ *Denotes the class of traffic.
* @public */ - Headers?: PartialInformation about email body content.
- * @public - */ -export interface InboundEmailContent { /** - *The message source type, that is, RAW
.
A Campaign object need for Campaign traffic type.
* @public */ - MessageSourceType: InboundMessageSourceType | undefined; + SourceCampaign?: SourceCampaign | undefined; /** - *The raw email body content.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - RawMessage?: InboundRawMessage | undefined; + ClientToken?: string | undefined; } /** * @public */ -export interface StartEmailContactResponse { - /** - *The identifier of this contact within the Amazon Connect instance.
- * @public - */ - ContactId?: string | undefined; -} +export interface SendOutboundEmailResponse {} /** * @public */ -export interface StartOutboundChatContactResponse { +export interface StartAttachedFileUploadRequest { /** - *The identifier of this contact within the Amazon Connect instance.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - ContactId?: string | undefined; -} + ClientToken?: string | undefined; -/** - * @public - */ -export interface StartOutboundEmailContactRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The unique identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** - *The identifier of the contact in this instance of Amazon Connect.
+ *A case-sensitive name of the attached file being uploaded.
* @public */ - ContactId: string | undefined; + FileName: string | undefined; /** - *The email address associated with the instance.
+ *The size of the attached file in bytes.
* @public */ - FromEmailAddress?: EmailAddressInfo | undefined; + FileSizeInBytes: number | undefined; /** - *The email address of the customer.
+ *Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is + * 300.
* @public */ - DestinationEmailAddress: EmailAddressInfo | undefined; + UrlExpiryInSeconds?: number | undefined; /** - *The addtional recipients address of email in CC.
+ *The use case for the file.
+ * Only ATTACHMENTS
are supported.
The email message body to be sent to the newly created email.
+ *The resource to which the attached file is (being) uploaded to. The supported resources are + * Cases and Email.
+ *This value must be a valid ARN.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *Represents the identity that created the file.
* @public */ - ClientToken?: string | undefined; -} + CreatedBy?: CreatedByInfo | undefined; -/** - * @public - */ -export interface StartOutboundEmailContactResponse { /** - *The identifier of the contact in this instance of Amazon Connect.
+ *The tags used to organize, track, or control access for this resource. For example, \{
+ * "Tags": \{"key1":"value1", "key2":"value2"\} \}
.
Outbound calls to the destination number are not allowed.
+ *Fields required when uploading an attached file.
* @public */ -export class DestinationNotAllowedException extends __BaseException { - readonly name: "DestinationNotAllowedException" = "DestinationNotAllowedException"; - readonly $fault: "client" = "client"; +export interface UploadUrlMetadata { /** - *The message about the outbound calls.
+ *A pre-signed S3 URL that should be used for uploading the attached file.
* @public */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe contact is not permitted.
- * @public - */ -export class OutboundContactNotPermittedException extends __BaseException { - readonly name: "OutboundContactNotPermittedException" = "OutboundContactNotPermittedException"; - readonly $fault: "client" = "client"; /** - *The message about the contact.
+ *The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:
+ * yyyy-MM-ddThh:mm:ss.SSSZ
. For example,
+ * 2019-11-08T02:41:28.172Z
.
A map of headers that should be provided when uploading the attached file.
+ * @public */ - constructor(opts: __ExceptionOptionTypeConfiguration of the answering machine detection.
+ * Response from StartAttachedFileUpload API. * @public */ -export interface AnswerMachineDetectionConfig { +export interface StartAttachedFileUploadResponse { /** - *The flag to indicate if answer machine detection analysis needs to be performed for a voice
- * call. If set to true
, TrafficType
must be set as CAMPAIGN
.
- *
The unique identifier of the attached file resource (ARN).
* @public */ - EnableAnswerMachineDetection?: boolean | undefined; + FileArn?: string | undefined; /** - *Wait for the answering machine prompt.
+ *The unique identifier of the attached file resource.
* @public */ - AwaitAnswerMachinePrompt?: boolean | undefined; -} + FileId?: string | undefined; -/** - * @public - */ -export interface StartOutboundVoiceContactRequest { /** - *The name of a voice contact that is shown to an agent in the Contact Control Panel - * (CCP).
+ *The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601
+ * format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example,
+ * 2024-05-03T02:41:28.172Z
.
A description of the voice contact that is shown to an agent in the Contact Control Panel - * (CCP).
+ *The current status of the attached file.
* @public */ - Description?: string | undefined; + FileStatus?: FileStatusType | undefined; /** - *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
- * have the following reference types at the time of creation: URL
|
- * NUMBER
| STRING
| DATE
| EMAIL
.
- * ATTACHMENT
is not a supported reference type during voice contact creation.
Represents the identity that created the file.
* @public */ - References?: RecordThe contactId
that is related to this contact. Linking voice, task, or chat by
- * using RelatedContactID
copies over contact attributes from the related contact to
- * the new contact. All updates to user-defined attributes in the new contact are limited to the
- * individual contact ID. There are no limits to the number of contacts that can be linked by using
- * RelatedContactId
.
Information to be used while uploading the attached file.
* @public */ - RelatedContactId?: string | undefined; + UploadUrlMetadata?: UploadUrlMetadata | undefined; +} +/** + *A chat message.
+ * @public + */ +export interface ChatMessage { /** - *The phone number of the customer, in E.164 format.
+ *The type of the content. Supported types are text/plain
,
+ * text/markdown
, application/json
, and
+ * application/vnd.amazonaws.connect.message.interactive.response
.
The - * identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the - * navigation menu go to Routing, Contact - * Flows. Choose the flow. On the flow page, under the name of the flow, choose - * Show additional flow information. The ContactFlowId is the last - * part of the ARN, shown here in bold:
- *arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx - *
+ *The content of the chat message.
+ *For text/plain
and text/markdown
, the Length Constraints are
+ * Minimum of 1, Maximum of 1024.
For application/json
, the Length Constraints are Minimum of 1, Maximum of
+ * 12000.
For application/vnd.amazonaws.connect.message.interactive.response
, the
+ * Length Constraints are Minimum of 1, Maximum of 12288.
Enable persistent chats. For more information about enabling persistent chat, and for + * example use cases and how to configure for them, see Enable persistent chat.
+ * @public + */ +export interface PersistentChat { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The contactId that is used for rehydration depends on the rehydration type. RehydrationType + * is required for persistent chat.
+ *
+ * ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past
+ * chat contact of the specified past ended chat session. To use this type, provide the
+ * initialContactId
of the past ended chat session in the
+ * sourceContactId
field. In this type, Amazon Connect determines the most
+ * recent chat contact on the specified chat session that has ended, and uses it to start a
+ * persistent chat.
+ * FROM_SEGMENT
: Rehydrates a chat from the past chat contact that is specified
+ * in the sourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
* @public */ - InstanceId: string | undefined; + RehydrationType?: RehydrationType | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, - * the contact ID is returned. - *
+ *The contactId from which a persistent chat session must be started.
* @public */ - ClientToken?: string | undefined; + SourceContactId?: string | undefined; +} +/** + * @public + */ +export interface StartChatContactResponse { /** - *The phone number associated with the Amazon Connect instance, in E.164 format. If you do - * not specify a source phone number, you must specify a queue.
+ *The identifier of this contact within the Amazon Connect instance.
* @public */ - SourcePhoneNumber?: string | undefined; + ContactId?: string | undefined; /** - *The queue for the call. If you specify a queue, the phone displayed for caller ID is the - * phone number specified in the queue. If you do not specify a queue, the queue defined in the flow - * is used. If you do not specify a queue, you must specify a source phone number.
+ *The identifier for a chat participant. The participantId for a chat participant is the same + * throughout the chat lifecycle.
* @public */ - QueueId?: string | undefined; + ParticipantId?: string | undefined; /** - *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
- *There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys - * can include only alphanumeric, dash, and underscore characters.
+ *The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat + * participant.
* @public */ - Attributes?: RecordConfiguration of the answering machine detection for this outbound call.
+ *The contactId from which a persistent chat session is started. This field is populated only + * for persistent chats.
* @public */ - AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined; + ContinuedFromContactId?: string | undefined; +} +/** + * @public + */ +export interface StartContactEvaluationRequest { /** - *The campaign identifier of the outbound communication.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - CampaignId?: string | undefined; + InstanceId: string | undefined; /** - *Denotes the class of traffic. Calls with different traffic types are handled differently by
- * Amazon Connect. The default value is GENERAL
. Use CAMPAIGN
if
- * EnableAnswerMachineDetection
is set to true
. For all other cases, use
- * GENERAL
.
The identifier of the contact in this instance of Amazon Connect.
* @public */ - TrafficType?: TrafficType | undefined; -} + ContactId: string | undefined; -/** - * @public - */ -export interface StartOutboundVoiceContactResponse { /** - *The identifier of this contact within the Amazon Connect instance.
+ *The unique identifier for the evaluation form.
* @public */ - ContactId?: string | undefined; -} + EvaluationFormId: string | undefined; -/** - * @public - */ -export interface StartScreenSharingRequest { /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services @@ -5154,70 +5014,75 @@ export interface StartScreenSharingRequest { * @public */ ClientToken?: string | undefined; +} +/** + * @public + */ +export interface StartContactEvaluationResponse { /** - *
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *A unique identifier for the contact evaluation.
* @public */ - InstanceId: string | undefined; + EvaluationId: string | undefined; /** - *The identifier of the contact in this instance of Amazon Connect.
+ *The Amazon Resource Name (ARN) for the contact evaluation resource.
* @public */ - ContactId: string | undefined; + EvaluationArn: string | undefined; } /** * @public + * @enum */ -export interface StartScreenSharingResponse {} +export const IvrRecordingTrack = { + ALL: "ALL", +} as const; /** * @public */ -export interface StartTaskContactResponse { - /** - *The identifier of this contact within the Amazon Connect instance.
- * @public - */ - ContactId?: string | undefined; -} +export type IvrRecordingTrack = (typeof IvrRecordingTrack)[keyof typeof IvrRecordingTrack]; /** * @public + * @enum */ -export interface StartWebRTCContactRequest { - /** - *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
- *There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys - * can include only alphanumeric, -, and _ characters.
- * @public - */ - Attributes?: RecordContains information about the recording configuration settings.
+ * @public + */ +export interface VoiceRecordingConfiguration { /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
- *The token is valid for 7 days after creation. If a contact is already started, the contact - * ID is returned.
+ *Identifies which track is being recorded.
* @public */ - ClientToken?: string | undefined; + VoiceRecordingTrack?: VoiceRecordingTrack | undefined; /** - *The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the - * navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose - * Show additional flow information. The ContactFlowId is the last - * part of the ARN, shown here in bold:
- *arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx - *
+ *Identifies which IVR track is being recorded.
* @public */ - ContactFlowId: string | undefined; + IvrRecordingTrack?: IvrRecordingTrack | undefined; +} +/** + * @public + */ +export interface StartContactRecordingRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -5225,449 +5090,484 @@ export interface StartWebRTCContactRequest { InstanceId: string | undefined; /** - *Information about the video sharing capabilities of the participants (customer, - * agent).
+ *The identifier of the contact.
* @public */ - AllowedCapabilities?: AllowedCapabilities | undefined; + ContactId: string | undefined; /** - *The customer's details.
+ *The identifier of the contact. This is the identifier of the contact associated with the + * first interaction with the contact center.
* @public */ - ParticipantDetails: ParticipantDetails | undefined; + InitialContactId: string | undefined; /** - *The unique identifier for an Amazon Connect contact. This identifier is related to the - * contact starting.
+ *The person being recorded.
* @public */ - RelatedContactId?: string | undefined; + VoiceRecordingConfiguration: VoiceRecordingConfiguration | undefined; +} + +/** + * @public + */ +export interface StartContactRecordingResponse {} +/** + * @public + */ +export interface StartContactStreamingRequest { /** - *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
- * the following reference types at the time of creation: URL
| NUMBER
|
- * STRING
| DATE
| EMAIL
. ATTACHMENT
is not a
- * supported reference type during task creation.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - References?: RecordA description of the task that is shown to an agent in the Contact Control Panel - * (CCP).
+ *The identifier of the contact. This is the identifier of the contact associated with the + * first interaction with the contact center.
* @public */ - Description?: string | undefined; -} + ContactId: string | undefined; -/** - *The attendee information, including attendee ID and join token.
- * @public - */ -export interface Attendee { /** - *The Amazon Chime SDK attendee ID.
+ *The streaming configuration, such as the Amazon SNS streaming endpoint.
* @public */ - AttendeeId?: string | undefined; + ChatStreamingConfiguration: ChatStreamingConfiguration | undefined; /** - *The join token used by the Amazon Chime SDK attendee.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - JoinToken?: string | undefined; + ClientToken?: string | undefined; } /** - *A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
* @public */ -export interface MediaPlacement { +export interface StartContactStreamingResponse { /** - *The audio host URL.
+ *The identifier of the streaming configuration enabled.
* @public */ - AudioHostUrl?: string | undefined; + StreamingId: string | undefined; +} +/** + *The additional TO CC recipients information of inbound email.
+ * @public + */ +export interface InboundAdditionalRecipients { /** - *The audio fallback URL.
+ *The additional recipients information present in to list.
* @public */ - AudioFallbackUrl?: string | undefined; + ToAddresses?: EmailAddressInfo[] | undefined; /** - *The signaling URL.
+ *The additional recipients information present in cc list.
* @public */ - SignalingUrl?: string | undefined; + CcAddresses?: EmailAddressInfo[] | undefined; +} +/** + *Information about the email attachment files.
+ * @public + */ +export interface EmailAttachment { /** - *The turn control URL.
+ *A case-sensitive name of the attached file being uploaded.
* @public */ - TurnControlUrl?: string | undefined; + FileName: string | undefined; /** - *The event ingestion URL to which you send client meeting events.
+ *The pre-signed URLs for the S3 bucket where the email attachment is stored.
* @public */ - EventIngestionUrl?: string | undefined; + S3Url: string | undefined; } /** * @public * @enum */ -export const MeetingFeatureStatus = { - AVAILABLE: "AVAILABLE", - UNAVAILABLE: "UNAVAILABLE", +export const InboundMessageSourceType = { + RAW: "RAW", } as const; /** * @public */ -export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus]; +export type InboundMessageSourceType = (typeof InboundMessageSourceType)[keyof typeof InboundMessageSourceType]; /** - *Has audio-specific configurations as the operating parameter for Echo Reduction.
* @public + * @enum */ -export interface AudioFeatures { - /** - *Makes echo reduction available to clients who connect to the meeting.
- * @public - */ - EchoReduction?: MeetingFeatureStatus | undefined; -} +export const EmailHeaderType = { + IN_REPLY_TO: "IN_REPLY_TO", + MESSAGE_ID: "MESSAGE_ID", + REFERENCES: "REFERENCES", + X_SES_SPAM_VERDICT: "X_SES_SPAM_VERDICT", + X_SES_VIRUS_VERDICT: "X_SES_VIRUS_VERDICT", +} as const; /** - *The configuration settings of the features available to a meeting.
* @public */ -export interface MeetingFeaturesConfiguration { +export type EmailHeaderType = (typeof EmailHeaderType)[keyof typeof EmailHeaderType]; + +/** + *Information about the raw email body content.
+ * @public + */ +export interface InboundRawMessage { /** - *The configuration settings for the audio features available to a meeting.
+ *The email subject.
* @public */ - Audio?: AudioFeatures | undefined; + Subject: string | undefined; + + /** + *The email message body.
+ * @public + */ + Body: string | undefined; + + /** + *Type of content, that is, text/plain
or text/html
.
Headers present in inbound email.
+ * @public + */ + Headers?: PartialA meeting created using the Amazon Chime SDK.
+ *Information about email body content.
* @public */ -export interface Meeting { +export interface InboundEmailContent { /** - *The Amazon Web Services Region in which you create the meeting.
+ *The message source type, that is, RAW
.
The media placement for the meeting.
+ *The raw email body content.
* @public */ - MediaPlacement?: MediaPlacement | undefined; + RawMessage?: InboundRawMessage | undefined; +} +/** + * @public + */ +export interface StartEmailContactResponse { /** - *The configuration settings of the features available to a meeting.
+ *The identifier of this contact within the Amazon Connect instance.
* @public */ - MeetingFeatures?: MeetingFeaturesConfiguration | undefined; + ContactId?: string | undefined; +} +/** + * @public + */ +export interface StartOutboundChatContactResponse { /** - *The Amazon Chime SDK meeting ID.
+ *The identifier of this contact within the Amazon Connect instance.
* @public */ - MeetingId?: string | undefined; + ContactId?: string | undefined; } /** - *Information required to join the call.
* @public */ -export interface ConnectionData { +export interface StartOutboundEmailContactRequest { /** - *The attendee information, including attendee ID and join token.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier of the contact in this instance of Amazon Connect.
+ * @public + */ + ContactId: string | undefined; + + /** + *The email address associated with the instance.
* @public */ - Attendee?: Attendee | undefined; + FromEmailAddress?: EmailAddressInfo | undefined; /** - *A meeting created using the Amazon Chime SDK.
+ *The email address of the customer.
* @public */ - Meeting?: Meeting | undefined; -} + DestinationEmailAddress: EmailAddressInfo | undefined; -/** - * @public - */ -export interface StartWebRTCContactResponse { /** - *Information required for the client application (mobile application or website) to connect - * to the call.
+ *The addtional recipients address of email in CC.
* @public */ - ConnectionData?: ConnectionData | undefined; + AdditionalRecipients?: OutboundAdditionalRecipients | undefined; /** - *The identifier of the contact in this instance of Amazon Connect.
+ *The email message body to be sent to the newly created email.
* @public */ - ContactId?: string | undefined; + EmailMessage: OutboundEmailContent | undefined; /** - *The identifier for a contact participant. The ParticipantId
for a contact
- * participant is the same throughout the contact lifecycle.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - ParticipantId?: string | undefined; + ClientToken?: string | undefined; +} +/** + * @public + */ +export interface StartOutboundEmailContactResponse { /** - *The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a - * contact participant.
+ *The identifier of the contact in this instance of Amazon Connect.
* @public */ - ParticipantToken?: string | undefined; + ContactId?: string | undefined; } /** - *The contact with the specified ID is not active or does not exist. Applies to Voice calls - * only, not to Chat or Task contacts.
+ *Outbound calls to the destination number are not allowed.
* @public */ -export class ContactNotFoundException extends __BaseException { - readonly name: "ContactNotFoundException" = "ContactNotFoundException"; +export class DestinationNotAllowedException extends __BaseException { + readonly name: "DestinationNotAllowedException" = "DestinationNotAllowedException"; readonly $fault: "client" = "client"; /** - *The message.
+ *The message about the outbound calls.
* @public */ Message?: string | undefined; /** * @internal */ - constructor(opts: __ExceptionOptionTypeContains details about why a contact was disconnected. Only Amazon Connect outbound - * campaigns can provide this field.
+ *The contact is not permitted.
* @public */ -export interface DisconnectReason { +export class OutboundContactNotPermittedException extends __BaseException { + readonly name: "OutboundContactNotPermittedException" = "OutboundContactNotPermittedException"; + readonly $fault: "client" = "client"; /** - *A code that indicates how the contact was terminated.
+ *The message about the contact.
* @public */ - Code?: string | undefined; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeConfiguration of the answering machine detection.
* @public */ -export interface StopContactRequest { - /** - *The ID of the contact.
- * @public - */ - ContactId: string | undefined; - +export interface AnswerMachineDetectionConfig { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The flag to indicate if answer machine detection analysis needs to be performed for a voice
+ * call. If set to true
, TrafficType
must be set as CAMPAIGN
.
+ *
The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can - * provide this field.
+ *Wait for the answering machine prompt.
* @public */ - DisconnectReason?: DisconnectReason | undefined; + AwaitAnswerMachinePrompt?: boolean | undefined; } /** * @public */ -export interface StopContactResponse {} - -/** - * @public - */ -export interface StopContactRecordingRequest { +export interface StartOutboundVoiceContactRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The name of a voice contact that is shown to an agent in the Contact Control Panel + * (CCP).
* @public */ - InstanceId: string | undefined; + Name?: string | undefined; /** - *The identifier of the contact.
+ *A description of the voice contact that is shown to an agent in the Contact Control Panel + * (CCP).
* @public */ - ContactId: string | undefined; + Description?: string | undefined; /** - *The identifier of the contact. This is the identifier of the contact associated with the - * first interaction with the contact center.
+ *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
+ * have the following reference types at the time of creation: URL
|
+ * NUMBER
| STRING
| DATE
| EMAIL
.
+ * ATTACHMENT
is not a supported reference type during voice contact creation.
The type of recording being operated on.
+ *The contactId
that is related to this contact. Linking voice, task, or chat by
+ * using RelatedContactID
copies over contact attributes from the related contact to
+ * the new contact. All updates to user-defined attributes in the new contact are limited to the
+ * individual contact ID. There are no limits to the number of contacts that can be linked by using
+ * RelatedContactId
.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The phone number of the customer, in E.164 format.
* @public */ - InstanceId: string | undefined; + DestinationPhoneNumber: string | undefined; /** - *The identifier of the contact. This is the identifier of the contact that is associated with - * the first interaction with the contact center.
+ *The + * identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the + * navigation menu go to Routing, Contact + * Flows. Choose the flow. On the flow page, under the name of the flow, choose + * Show additional flow information. The ContactFlowId is the last + * part of the ARN, shown here in bold:
+ *arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx + *
* @public */ - ContactId: string | undefined; + ContactFlowId: string | undefined; /** - *The identifier of the streaming configuration enabled.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - StreamingId: string | undefined; -} - -/** - * @public - */ -export interface StopContactStreamingResponse {} + InstanceId: string | undefined; -/** - *Information about input answers for a contact evaluation.
- * @public - */ -export interface EvaluationAnswerInput { /** - *The value for an answer in a contact evaluation.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, + * the contact ID is returned. + *
* @public */ - Value?: EvaluationAnswerData | undefined; -} + ClientToken?: string | undefined; -/** - * @public - */ -export interface SubmitContactEvaluationRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The phone number associated with the Amazon Connect instance, in E.164 format. If you do + * not specify a source phone number, you must specify a queue.
* @public */ - InstanceId: string | undefined; + SourcePhoneNumber?: string | undefined; /** - *A unique identifier for the contact evaluation.
+ *The queue for the call. If you specify a queue, the phone displayed for caller ID is the + * phone number specified in the queue. If you do not specify a queue, the queue defined in the flow + * is used. If you do not specify a queue, you must specify a source phone number.
* @public */ - EvaluationId: string | undefined; + QueueId?: string | undefined; /** - *A map of question identifiers to answer value.
+ *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
+ *There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys + * can include only alphanumeric, dash, and underscore characters.
* @public */ - Answers?: RecordA map of question identifiers to note value.
+ *Configuration of the answering machine detection for this outbound call.
* @public */ - Notes?: RecordA unique identifier for the contact evaluation.
+ *The campaign identifier of the outbound communication.
* @public */ - EvaluationId: string | undefined; + CampaignId?: string | undefined; /** - *The Amazon Resource Name (ARN) for the contact evaluation resource.
+ *Denotes the class of traffic. Calls with different traffic types are handled differently by
+ * Amazon Connect. The default value is GENERAL
. Use CAMPAIGN
if
+ * EnableAnswerMachineDetection
is set to true
. For all other cases, use
+ * GENERAL
.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *The identifier of the contact.
- * @public - */ - ContactId: string | undefined; - - /** - *The identifier of the contact. This is the identifier of the contact associated with the - * first interaction with the contact center.
- * @public - */ - InitialContactId: string | undefined; - +export interface StartOutboundVoiceContactResponse { /** - *The type of recording being operated on.
+ *The identifier of this contact within the Amazon Connect instance.
* @public */ - ContactRecordingType?: ContactRecordingType | undefined; + ContactId?: string | undefined; } /** * @public */ -export interface SuspendContactRecordingResponse {} - -/** - * @public - */ -export interface TagContactRequest { +export interface StartScreenSharingRequest { /** - *The identifier of the contact in this instance of Amazon Connect.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - ContactId: string | undefined; + ClientToken?: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
@@ -5676,42 +5576,62 @@ export interface TagContactRequest { InstanceId: string | undefined; /** - *The tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1", - * "key2":"value2"\} \}.
- *Authorization is not supported by this tag.
- *The identifier of the contact in this instance of Amazon Connect.
* @public */ - Tags: RecordThe Amazon Resource Name (ARN) of the resource.
- * @public - */ - resourceArn: string | undefined; - +export interface StartTaskContactResponse { /** - *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The identifier of this contact within the Amazon Connect instance.
* @public */ - tags: RecordA custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
+ *There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys + * can include only alphanumeric, -, and _ characters.
+ * @public + */ + Attributes?: RecordA unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
+ *The token is valid for 7 days after creation. If a contact is already started, the contact + * ID is returned.
+ * @public + */ + ClientToken?: string | undefined; + + /** + *The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the + * navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose + * Show additional flow information. The ContactFlowId is the last + * part of the ARN, shown here in bold:
+ *arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx + *
+ * @public + */ + ContactFlowId: string | undefined; + /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -5719,232 +5639,263 @@ export interface TransferContactRequest { InstanceId: string | undefined; /** - *The identifier of the contact in this instance of Amazon Connect.
+ *Information about the video sharing capabilities of the participants (customer, + * agent).
* @public */ - ContactId: string | undefined; + AllowedCapabilities?: AllowedCapabilities | undefined; /** - *The identifier for the queue.
+ *The customer's details.
* @public */ - QueueId?: string | undefined; + ParticipantDetails: ParticipantDetails | undefined; /** - *The identifier for the user. This can be the ID or the ARN of the user.
+ *The unique identifier for an Amazon Connect contact. This identifier is related to the + * contact starting.
* @public */ - UserId?: string | undefined; + RelatedContactId?: string | undefined; /** - *The identifier of the flow.
+ *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
+ * the following reference types at the time of creation: URL
| NUMBER
|
+ * STRING
| DATE
| EMAIL
. ATTACHMENT
is not a
+ * supported reference type during task creation.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *A description of the task that is shown to an agent in the Contact Control Panel + * (CCP).
* @public */ - ClientToken?: string | undefined; + Description?: string | undefined; } /** + *The attendee information, including attendee ID and join token.
* @public */ -export interface TransferContactResponse { +export interface Attendee { /** - *The identifier of the contact in this instance of Amazon Connect.
+ *The Amazon Chime SDK attendee ID.
* @public */ - ContactId?: string | undefined; + AttendeeId?: string | undefined; /** - *The Amazon Resource Name (ARN) of the contact.
+ *The join token used by the Amazon Chime SDK attendee.
* @public */ - ContactArn?: string | undefined; + JoinToken?: string | undefined; } /** + *A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
* @public */ -export interface UntagContactRequest { +export interface MediaPlacement { /** - *The identifier of the contact in this instance of Amazon Connect.
+ *The audio host URL.
* @public */ - ContactId: string | undefined; + AudioHostUrl?: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The audio fallback URL.
* @public */ - InstanceId: string | undefined; + AudioFallbackUrl?: string | undefined; /** - *A list of tag keys. Existing tags on the contact whose keys are members of this list will be - * removed.
+ *The signaling URL.
* @public */ - TagKeys: string[] | undefined; + SignalingUrl?: string | undefined; + + /** + *The turn control URL.
+ * @public + */ + TurnControlUrl?: string | undefined; + + /** + *The event ingestion URL to which you send client meeting events.
+ * @public + */ + EventIngestionUrl?: string | undefined; } /** * @public + * @enum */ -export interface UntagContactResponse {} +export const MeetingFeatureStatus = { + AVAILABLE: "AVAILABLE", + UNAVAILABLE: "UNAVAILABLE", +} as const; /** * @public */ -export interface UntagResourceRequest { - /** - *The Amazon Resource Name (ARN) of the resource.
- * @public - */ - resourceArn: string | undefined; +export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus]; +/** + *Has audio-specific configurations as the operating parameter for Echo Reduction.
+ * @public + */ +export interface AudioFeatures { /** - *The tag keys.
+ *Makes echo reduction available to clients who connect to the meeting.
* @public */ - tagKeys: string[] | undefined; + EchoReduction?: MeetingFeatureStatus | undefined; } /** + *The configuration settings of the features available to a meeting.
* @public */ -export interface UpdateAgentStatusRequest { +export interface MeetingFeaturesConfiguration { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The configuration settings for the audio features available to a meeting.
* @public */ - InstanceId: string | undefined; + Audio?: AudioFeatures | undefined; +} +/** + *A meeting created using the Amazon Chime SDK.
+ * @public + */ +export interface Meeting { /** - *The identifier of the agent status.
+ *The Amazon Web Services Region in which you create the meeting.
* @public */ - AgentStatusId: string | undefined; + MediaRegion?: string | undefined; /** - *The name of the agent status.
+ *The media placement for the meeting.
* @public */ - Name?: string | undefined; + MediaPlacement?: MediaPlacement | undefined; /** - *The description of the agent status.
+ *The configuration settings of the features available to a meeting.
* @public */ - Description?: string | undefined; + MeetingFeatures?: MeetingFeaturesConfiguration | undefined; /** - *The state of the agent status.
+ *The Amazon Chime SDK meeting ID.
* @public */ - State?: AgentStatusState | undefined; + MeetingId?: string | undefined; +} +/** + *Information required to join the call.
+ * @public + */ +export interface ConnectionData { /** - *The display order of the agent status.
+ *The attendee information, including attendee ID and join token.
* @public */ - DisplayOrder?: number | undefined; + Attendee?: Attendee | undefined; /** - *A number indicating the reset order of the agent status.
+ *A meeting created using the Amazon Chime SDK.
* @public */ - ResetOrderNumber?: boolean | undefined; + Meeting?: Meeting | undefined; } /** * @public */ -export interface UpdateAuthenticationProfileRequest { - /** - *A unique identifier for the authentication profile.
- * @public - */ - AuthenticationProfileId: string | undefined; - +export interface StartWebRTCContactResponse { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *Information required for the client application (mobile application or website) to connect + * to the call.
* @public */ - InstanceId: string | undefined; + ConnectionData?: ConnectionData | undefined; /** - *The name for the authentication profile.
+ *The identifier of the contact in this instance of Amazon Connect.
* @public */ - Name?: string | undefined; + ContactId?: string | undefined; /** - *The description for the authentication profile.
+ *The identifier for a contact participant. The ParticipantId
for a contact
+ * participant is the same throughout the contact lifecycle.
A list of IP address range strings that are allowed to access the instance. For more - * information on how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator - * Guide.
+ *The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a + * contact participant.
* @public */ - AllowedIps?: string[] | undefined; + ParticipantToken?: string | undefined; +} +/** + *The contact with the specified ID is not active or does not exist. Applies to Voice calls + * only, not to Chat or Task contacts.
+ * @public + */ +export class ContactNotFoundException extends __BaseException { + readonly name: "ContactNotFoundException" = "ContactNotFoundException"; + readonly $fault: "client" = "client"; /** - *A list of IP address range strings that are blocked from accessing the instance. For more - * information on how to configure IP addresses, For more information on how to configure IP - * addresses, see Configure - * IP-based access control in the Amazon Connect Administrator - * Guide.
+ *The message.
* @public */ - BlockedIps?: string[] | undefined; - + Message?: string | undefined; /** - *The short lived session duration configuration for users logged in to Amazon Connect, in - * minutes. This value determines the maximum possible time before an agent is authenticated. For - * more information, For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator - * Guide.
- * @public + * @internal */ - PeriodicSessionDuration?: number | undefined; + constructor(opts: __ExceptionOptionTypeInformation about a queue.
+ *Contains details about why a contact was disconnected. Only Amazon Connect outbound + * campaigns can provide this field.
* @public */ -export interface QueueInfoInput { +export interface DisconnectReason { /** - *The identifier of the queue.
+ *A code that indicates how the contact was terminated.
* @public */ - Id?: string | undefined; + Code?: string | undefined; } /** * @public */ -export interface UpdateContactResponse {} - -/** - * @public - */ -export interface UpdateContactAttributesRequest { +export interface StopContactRequest { /** - *The identifier of the contact. This is the identifier of the contact associated with the - * first interaction with the contact center.
+ *The ID of the contact.
* @public */ - InitialContactId: string | undefined; + ContactId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
@@ -5953,38 +5904,22 @@ export interface UpdateContactAttributesRequest { InstanceId: string | undefined; /** - *The Amazon Connect attributes. These attributes can be accessed in flows just like any - * other contact attributes.
- *You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys - * can include only alphanumeric, dash, and underscore characters.
- *When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch - * of the flow. As a mitigation, consider the following options:
- *Remove unnecessary attributes by setting their values to empty.
- *If the attributes are only used in one flow and don't need to be referred to outside of - * that flow (for example, by a Lambda or another flow), then use flow attributes. This way you - * aren't needlessly persisting the 32 KB of information from one flow to another. For more - * information, see Flow block: Set contact - * attributes in the Amazon Connect Administrator Guide.
- *The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can + * provide this field.
* @public */ - Attributes: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -5992,144 +5927,121 @@ export interface UpdateContactEvaluationRequest { InstanceId: string | undefined; /** - *A unique identifier for the contact evaluation.
+ *The identifier of the contact.
* @public */ - EvaluationId: string | undefined; + ContactId: string | undefined; /** - *A map of question identifiers to answer value.
+ *The identifier of the contact. This is the identifier of the contact associated with the + * first interaction with the contact center.
* @public */ - Answers?: RecordA map of question identifiers to note value.
+ *The type of recording being operated on.
* @public */ - Notes?: RecordA unique identifier for the contact evaluation.
- * @public - */ - EvaluationId: string | undefined; - - /** - *The Amazon Resource Name (ARN) for the contact evaluation resource.
- * @public - */ - EvaluationArn: string | undefined; -} +export interface StopContactRecordingResponse {} /** * @public */ -export interface UpdateContactFlowContentRequest { +export interface StopContactStreamingRequest { /** - *The identifier of the Amazon Connect instance.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** - *The identifier of the flow.
+ *The identifier of the contact. This is the identifier of the contact that is associated with + * the first interaction with the contact center.
* @public */ - ContactFlowId: string | undefined; + ContactId: string | undefined; /** - *The JSON string that represents the content of the flow. For an example, see Example - * flow in Amazon Connect Flow language.
- *Length Constraints: Minimum length of 1. Maximum length of 256000.
+ *The identifier of the streaming configuration enabled.
* @public */ - Content: string | undefined; + StreamingId: string | undefined; } /** * @public */ -export interface UpdateContactFlowContentResponse {} +export interface StopContactStreamingResponse {} /** + *Information about input answers for a contact evaluation.
* @public */ -export interface UpdateContactFlowMetadataRequest { +export interface EvaluationAnswerInput { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The value for an answer in a contact evaluation.
* @public */ - InstanceId: string | undefined; + Value?: EvaluationAnswerData | undefined; +} +/** + * @public + */ +export interface SubmitContactEvaluationRequest { /** - *The identifier of the flow.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - ContactFlowId: string | undefined; + InstanceId: string | undefined; /** - *The name of the flow.
+ *A unique identifier for the contact evaluation.
* @public */ - Name?: string | undefined; + EvaluationId: string | undefined; /** - *The description of the flow.
+ *A map of question identifiers to answer value.
* @public */ - Description?: string | undefined; + Answers?: RecordThe state of flow.
+ *A map of question identifiers to note value.
* @public */ - ContactFlowState?: ContactFlowState | undefined; + Notes?: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - +export interface SubmitContactEvaluationResponse { /** - *The identifier of the flow module.
+ *A unique identifier for the contact evaluation.
* @public */ - ContactFlowModuleId: string | undefined; + EvaluationId: string | undefined; /** - *The JSON string that represents the content of the flow. For an example, see Example - * flow in Amazon Connect Flow language.
+ *The Amazon Resource Name (ARN) for the contact evaluation resource.
* @public */ - Content: string | undefined; + EvaluationArn: string | undefined; } /** * @public */ -export interface UpdateContactFlowModuleContentResponse {} - -/** - * @public - */ -export interface UpdateContactFlowModuleMetadataRequest { +export interface SuspendContactRecordingRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6137,92 +6049,83 @@ export interface UpdateContactFlowModuleMetadataRequest { InstanceId: string | undefined; /** - *The identifier of the flow module.
- * @public - */ - ContactFlowModuleId: string | undefined; - - /** - *The name of the flow module.
+ *The identifier of the contact.
* @public */ - Name?: string | undefined; + ContactId: string | undefined; /** - *The description of the flow module.
+ *The identifier of the contact. This is the identifier of the contact associated with the + * first interaction with the contact center.
* @public */ - Description?: string | undefined; + InitialContactId: string | undefined; /** - *The state of flow module.
+ *The type of recording being operated on.
* @public */ - State?: ContactFlowModuleState | undefined; + ContactRecordingType?: ContactRecordingType | undefined; } /** * @public */ -export interface UpdateContactFlowModuleMetadataResponse {} +export interface SuspendContactRecordingResponse {} /** * @public */ -export interface UpdateContactFlowNameRequest { - /** - *The identifier of the Amazon Connect instance.
- * @public - */ - InstanceId: string | undefined; - +export interface TagContactRequest { /** - *The identifier of the flow.
+ *The identifier of the contact in this instance of Amazon Connect.
* @public */ - ContactFlowId: string | undefined; + ContactId: string | undefined; /** - *The name of the flow.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Name?: string | undefined; + InstanceId: string | undefined; /** - *The description of the flow.
+ *The tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1", + * "key2":"value2"\} \}.
+ *Authorization is not supported by this tag.
+ *Specify whether this routing criteria step should apply for only a limited amount of time, - * or if it should never expire.
* @public */ -export interface RoutingCriteriaInputStepExpiry { +export interface TagResourceRequest { /** - *The number of seconds that the contact will be routed only to agents matching this routing - * step, if expiry was configured for this routing step.
+ *The Amazon Resource Name (ARN) of the resource.
* @public */ - DurationInSeconds?: number | undefined; -} + resourceArn: string | undefined; -/** - * @public - */ -export interface UpdateContactRoutingDataResponse {} + /** + *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
+ * @public + */ + tags: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6230,105 +6133,106 @@ export interface UpdateContactScheduleRequest { InstanceId: string | undefined; /** - *The identifier of the contact.
+ *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId: string | undefined; /** - *The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
+ *The identifier for the queue.
* @public */ - ScheduledTime: Date | undefined; -} - -/** - * @public - */ -export interface UpdateContactScheduleResponse {} + QueueId?: string | undefined; -/** - * @public - */ -export interface UpdateEmailAddressMetadataRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The identifier for the user. This can be the ID or the ARN of the user.
* @public */ - InstanceId: string | undefined; + UserId?: string | undefined; /** - *The identifier of the email address.
+ *The identifier of the flow.
* @public */ - EmailAddressId: string | undefined; + ContactFlowId: string | undefined; /** - *The description of the email address.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - Description?: string | undefined; + ClientToken?: string | undefined; +} +/** + * @public + */ +export interface TransferContactResponse { /** - *The display name of email address.
+ *The identifier of the contact in this instance of Amazon Connect.
* @public */ - DisplayName?: string | undefined; + ContactId?: string | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *The Amazon Resource Name (ARN) of the contact.
* @public */ - ClientToken?: string | undefined; + ContactArn?: string | undefined; } /** * @public */ -export interface UpdateEmailAddressMetadataResponse { +export interface UntagContactRequest { /** - *The identifier of the email address.
+ *The identifier of the contact in this instance of Amazon Connect.
* @public */ - EmailAddressId?: string | undefined; + ContactId: string | undefined; /** - *The Amazon Resource Name (ARN) of the email address.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - EmailAddressArn?: string | undefined; + InstanceId: string | undefined; + + /** + *A list of tag keys. Existing tags on the contact whose keys are members of this list will be + * removed.
+ * @public + */ + TagKeys: string[] | undefined; } /** * @public */ -export interface UpdateEvaluationFormResponse { - /** - *The unique identifier for the evaluation form.
- * @public - */ - EvaluationFormId: string | undefined; +export interface UntagContactResponse {} +/** + * @public + */ +export interface UntagResourceRequest { /** - *The Amazon Resource Name (ARN) for the contact evaluation resource.
+ *The Amazon Resource Name (ARN) of the resource.
* @public */ - EvaluationFormArn: string | undefined; + resourceArn: string | undefined; /** - *The version of the updated evaluation form resource.
+ *The tag keys.
* @public */ - EvaluationFormVersion: number | undefined; + tagKeys: string[] | undefined; } /** * @public */ -export interface UpdateHoursOfOperationRequest { +export interface UpdateAgentStatusRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6336,282 +6240,281 @@ export interface UpdateHoursOfOperationRequest { InstanceId: string | undefined; /** - *The identifier of the hours of operation.
+ *The identifier of the agent status.
* @public */ - HoursOfOperationId: string | undefined; + AgentStatusId: string | undefined; /** - *The name of the hours of operation.
+ *The name of the agent status.
* @public */ Name?: string | undefined; /** - *The description of the hours of operation.
+ *The description of the agent status.
* @public */ Description?: string | undefined; /** - *The time zone of the hours of operation.
+ *The state of the agent status.
* @public */ - TimeZone?: string | undefined; + State?: AgentStatusState | undefined; /** - *Configuration information of the hours of operation.
+ *The display order of the agent status.
* @public */ - Config?: HoursOfOperationConfig[] | undefined; + DisplayOrder?: number | undefined; + + /** + *A number indicating the reset order of the agent status.
+ * @public + */ + ResetOrderNumber?: boolean | undefined; } /** * @public */ -export interface UpdateInstanceAttributeRequest { +export interface UpdateAuthenticationProfileRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *A unique identifier for the authentication profile.
* @public */ - InstanceId: string | undefined; + AuthenticationProfileId: string | undefined; /** - *The type of attribute.
- *Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, - * contact Amazon Web Services Support for allowlisting.
- *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - AttributeType: InstanceAttributeType | undefined; + InstanceId: string | undefined; /** - *The value for the attribute. Maximum character limit is 100.
+ *The name for the authentication profile.
* @public */ - Value: string | undefined; -} + Name?: string | undefined; -/** - * @public - */ -export interface UpdateInstanceStorageConfigRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The description for the authentication profile.
* @public */ - InstanceId: string | undefined; + Description?: string | undefined; /** - *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
+ *A list of IP address range strings that are allowed to access the instance. For more + * information on how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator + * Guide.
* @public */ - AssociationId: string | undefined; + AllowedIps?: string[] | undefined; /** - *A valid resource type.
+ *A list of IP address range strings that are blocked from accessing the instance. For more + * information on how to configure IP addresses, For more information on how to configure IP + * addresses, see Configure + * IP-based access control in the Amazon Connect Administrator + * Guide.
* @public */ - ResourceType: InstanceStorageResourceType | undefined; + BlockedIps?: string[] | undefined; /** - *The storage configuration for the instance.
+ *The short lived session duration configuration for users logged in to Amazon Connect, in + * minutes. This value determines the maximum possible time before an agent is authenticated. For + * more information, For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator + * Guide.
* @public */ - StorageConfig: InstanceStorageConfig | undefined; + PeriodicSessionDuration?: number | undefined; } /** - * @public - * @enum - */ -export const TimerEligibleParticipantRoles = { - AGENT: "AGENT", - CUSTOMER: "CUSTOMER", -} as const; - -/** + *Information about a queue.
* @public */ -export type TimerEligibleParticipantRoles = - (typeof TimerEligibleParticipantRoles)[keyof typeof TimerEligibleParticipantRoles]; +export interface QueueInfoInput { + /** + *The identifier of the queue.
+ * @public + */ + Id?: string | undefined; +} /** * @public - * @enum */ -export const ParticipantTimerType = { - DISCONNECT_NONCUSTOMER: "DISCONNECT_NONCUSTOMER", - IDLE: "IDLE", -} as const; +export interface UpdateContactResponse {} /** * @public */ -export type ParticipantTimerType = (typeof ParticipantTimerType)[keyof typeof ParticipantTimerType]; +export interface UpdateContactAttributesRequest { + /** + *The identifier of the contact. This is the identifier of the contact associated with the + * first interaction with the contact center.
+ * @public + */ + InitialContactId: string | undefined; -/** - * @public - * @enum - */ -export const ParticipantTimerAction = { - Unset: "Unset", -} as const; + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; -/** - * @public - */ -export type ParticipantTimerAction = (typeof ParticipantTimerAction)[keyof typeof ParticipantTimerAction]; + /** + *The Amazon Connect attributes. These attributes can be accessed in flows just like any + * other contact attributes.
+ *You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys + * can include only alphanumeric, dash, and underscore characters.
+ *When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch + * of the flow. As a mitigation, consider the following options:
+ *Remove unnecessary attributes by setting their values to empty.
+ *If the attributes are only used in one flow and don't need to be referred to outside of + * that flow (for example, by a Lambda or another flow), then use flow attributes. This way you + * aren't needlessly persisting the 32 KB of information from one flow to another. For more + * information, see Flow block: Set contact + * attributes in the Amazon Connect Administrator Guide.
+ *The value of the timer. Either the timer action (Unset
to delete the timer), or
- * the duration of the timer in minutes. Only one value can be set.
For more information about how chat timeouts work, see - * Set up chat timeouts for human participants.
* @public */ -export type ParticipantTimerValue = - | ParticipantTimerValue.ParticipantTimerActionMember - | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember - | ParticipantTimerValue.$UnknownMember; +export interface UpdateContactAttributesResponse {} /** * @public */ -export namespace ParticipantTimerValue { +export interface UpdateContactEvaluationRequest { /** - *The timer action. Currently only one value is allowed: Unset
. It deletes a
- * timer.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - export interface ParticipantTimerActionMember { - ParticipantTimerAction: ParticipantTimerAction; - ParticipantTimerDurationInMinutes?: never; - $unknown?: never; - } + InstanceId: string | undefined; /** - *The duration of a timer, in minutes.
+ *A unique identifier for the contact evaluation.
* @public */ - export interface ParticipantTimerDurationInMinutesMember { - ParticipantTimerAction?: never; - ParticipantTimerDurationInMinutes: number; - $unknown?: never; - } + EvaluationId: string | undefined; /** + *A map of question identifiers to answer value.
* @public */ - export interface $UnknownMember { - ParticipantTimerAction?: never; - ParticipantTimerDurationInMinutes?: never; - $unknown: [string, any]; - } - - export interface VisitorA map of question identifiers to note value.
+ * @public + */ + Notes?: RecordConfiguration information for the timer. After the timer configuration is set, it persists - * for the duration of the chat. It persists across new contacts in the chain, for example, transfer - * contacts.
- *For more information about how chat timeouts work, see - * Set up chat timeouts for human participants.
* @public */ -export interface ParticipantTimerConfiguration { - /** - *The role of the participant in the chat conversation.
- * @public - */ - ParticipantRole: TimerEligibleParticipantRoles | undefined; - +export interface UpdateContactEvaluationResponse { /** - *The type of timer. IDLE
indicates the timer applies for considering a human
- * chat participant as idle. DISCONNECT_NONCUSTOMER
indicates the timer applies to
- * automatically disconnecting a chat participant due to idleness.
A unique identifier for the contact evaluation.
* @public */ - TimerType: ParticipantTimerType | undefined; + EvaluationId: string | undefined; /** - *The value of the timer. Either the timer action (Unset to delete the timer), or the duration - * of the timer in minutes. Only one value can be set.
+ *The Amazon Resource Name (ARN) for the contact evaluation resource.
* @public */ - TimerValue: ParticipantTimerValue | undefined; + EvaluationArn: string | undefined; } /** - *Configuration information for the chat participant role.
* @public */ -export interface ChatParticipantRoleConfig { +export interface UpdateContactFlowContentRequest { /** - *A list of participant timers. You can specify any unique combination of role and timer type. - * Duplicate entries error out the request with a 400.
+ *The identifier of the Amazon Connect instance.
* @public */ - ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined; + InstanceId: string | undefined; + + /** + *The identifier of the flow.
+ * @public + */ + ContactFlowId: string | undefined; + + /** + *The JSON string that represents the content of the flow. For an example, see Example + * flow in Amazon Connect Flow language.
+ *Length Constraints: Minimum length of 1. Maximum length of 256000.
+ * @public + */ + Content: string | undefined; } /** - *Configuration information for the chat participant role.
* @public */ -export type UpdateParticipantRoleConfigChannelInfo = - | UpdateParticipantRoleConfigChannelInfo.ChatMember - | UpdateParticipantRoleConfigChannelInfo.$UnknownMember; +export interface UpdateContactFlowContentResponse {} /** * @public */ -export namespace UpdateParticipantRoleConfigChannelInfo { +export interface UpdateContactFlowMetadataRequest { /** - *Configuration information for the chat participant role.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - export interface ChatMember { - Chat: ChatParticipantRoleConfig; - $unknown?: never; - } + InstanceId: string | undefined; /** + *The identifier of the flow.
* @public */ - export interface $UnknownMember { - Chat?: never; - $unknown: [string, any]; - } + ContactFlowId: string | undefined; - export interface VisitorThe name of the flow.
+ * @public + */ + Name?: string | undefined; - export const visit =The description of the flow.
+ * @public + */ + Description?: string | undefined; + + /** + *The state of flow.
+ * @public + */ + ContactFlowState?: ContactFlowState | undefined; } /** * @public */ -export interface UpdateParticipantRoleConfigRequest { +export interface UpdateContactFlowMetadataResponse {} + +/** + * @public + */ +export interface UpdateContactFlowModuleContentRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6619,128 +6522,149 @@ export interface UpdateParticipantRoleConfigRequest { InstanceId: string | undefined; /** - *The identifier of the contact in this instance of Amazon Connect.
+ *The identifier of the flow module.
* @public */ - ContactId: string | undefined; + ContactFlowModuleId: string | undefined; /** - *The Amazon Connect channel you want to configure.
+ *The JSON string that represents the content of the flow. For an example, see Example + * flow in Amazon Connect Flow language.
* @public */ - ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined; + Content: string | undefined; } /** * @public */ -export interface UpdateParticipantRoleConfigResponse {} +export interface UpdateContactFlowModuleContentResponse {} /** * @public */ -export interface UpdatePhoneNumberRequest { +export interface UpdateContactFlowModuleMetadataRequest { /** - *A unique identifier for the phone number.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - PhoneNumberId: string | undefined; + InstanceId: string | undefined; /** - *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The identifier of the flow module.
* @public */ - TargetArn?: string | undefined; + ContactFlowModuleId: string | undefined; /** - *The identifier of the Amazon Connect instance that phone numbers are claimed to. You
- * can find the
- * instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The name of the flow module.
* @public */ - InstanceId?: string | undefined; + Name?: string | undefined; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *The description of the flow module.
* @public */ - ClientToken?: string | undefined; + Description?: string | undefined; + + /** + *The state of flow module.
+ * @public + */ + State?: ContactFlowModuleState | undefined; } /** * @public */ -export interface UpdatePhoneNumberResponse { +export interface UpdateContactFlowModuleMetadataResponse {} + +/** + * @public + */ +export interface UpdateContactFlowNameRequest { /** - *A unique identifier for the phone number.
+ *The identifier of the Amazon Connect instance.
* @public */ - PhoneNumberId?: string | undefined; + InstanceId: string | undefined; /** - *The Amazon Resource Name (ARN) of the phone number.
+ *The identifier of the flow.
* @public */ - PhoneNumberArn?: string | undefined; -} + ContactFlowId: string | undefined; -/** - * @public - */ -export interface UpdatePhoneNumberMetadataRequest { /** - *The Amazon Resource Name (ARN) or resource ID of the phone number.
+ *The name of the flow.
* @public */ - PhoneNumberId: string | undefined; + Name?: string | undefined; /** - *The description of the phone number.
+ *The description of the flow.
* @public */ - PhoneNumberDescription?: string | undefined; + Description?: string | undefined; +} + +/** + * @public + */ +export interface UpdateContactFlowNameResponse {} +/** + *Specify whether this routing criteria step should apply for only a limited amount of time, + * or if it should never expire.
+ * @public + */ +export interface RoutingCriteriaInputStepExpiry { /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the Amazon Web Services - * SDK populates this field. For more information about idempotency, see - * Making retries safe with idempotent APIs.
+ *The number of seconds that the contact will be routed only to agents matching this routing + * step, if expiry was configured for this routing step.
* @public */ - ClientToken?: string | undefined; + DurationInSeconds?: number | undefined; } /** * @public */ -export interface UpdatePredefinedAttributeRequest { +export interface UpdateContactRoutingDataResponse {} + +/** + * @public + */ +export interface UpdateContactScheduleRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource - * Name (ARN) of the instance.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** - *The name of the predefined attribute.
+ *The identifier of the contact.
* @public */ - Name: string | undefined; + ContactId: string | undefined; /** - *The values of the predefined attribute.
+ *The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
* @public */ - Values?: PredefinedAttributeValues | undefined; + ScheduledTime: Date | undefined; } /** * @public */ -export interface UpdatePromptRequest { +export interface UpdateContactScheduleResponse {} + +/** + * @public + */ +export interface UpdateEmailAddressMetadataRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6748,99 +6672,77 @@ export interface UpdatePromptRequest { InstanceId: string | undefined; /** - *A unique identifier for the prompt.
- * @public - */ - PromptId: string | undefined; - - /** - *The name of the prompt.
+ *The identifier of the email address.
* @public */ - Name?: string | undefined; + EmailAddressId: string | undefined; /** - *A description of the prompt.
+ *The description of the email address.
* @public */ Description?: string | undefined; /** - *The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the - * GetPromptFile - * API instead of providing S3 URIs.
- * @public - */ - S3Uri?: string | undefined; -} - -/** - * @public - */ -export interface UpdatePromptResponse { - /** - *The Amazon Resource Name (ARN) of the prompt.
+ *The display name of email address.
* @public */ - PromptARN?: string | undefined; + DisplayName?: string | undefined; /** - *A unique identifier for the prompt.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - PromptId?: string | undefined; + ClientToken?: string | undefined; } /** * @public */ -export interface UpdateQueueHoursOfOperationRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - +export interface UpdateEmailAddressMetadataResponse { /** - *The identifier for the queue.
+ *The identifier of the email address.
* @public */ - QueueId: string | undefined; + EmailAddressId?: string | undefined; /** - *The identifier for the hours of operation.
+ *The Amazon Resource Name (ARN) of the email address.
* @public */ - HoursOfOperationId: string | undefined; + EmailAddressArn?: string | undefined; } /** * @public */ -export interface UpdateQueueMaxContactsRequest { +export interface UpdateEvaluationFormResponse { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The unique identifier for the evaluation form.
* @public */ - InstanceId: string | undefined; + EvaluationFormId: string | undefined; /** - *The identifier for the queue.
+ *The Amazon Resource Name (ARN) for the contact evaluation resource.
* @public */ - QueueId: string | undefined; + EvaluationFormArn: string | undefined; /** - *The maximum number of contacts that can be in the queue before it is considered full.
+ *The version of the updated evaluation form resource.
* @public */ - MaxContacts?: number | undefined; + EvaluationFormVersion: number | undefined; } /** * @public */ -export interface UpdateQueueNameRequest { +export interface UpdateHoursOfOperationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6848,49 +6750,38 @@ export interface UpdateQueueNameRequest { InstanceId: string | undefined; /** - *The identifier for the queue.
+ *The identifier of the hours of operation.
* @public */ - QueueId: string | undefined; + HoursOfOperationId: string | undefined; /** - *The name of the queue.
+ *The name of the hours of operation.
* @public */ Name?: string | undefined; /** - *The description of the queue.
+ *The description of the hours of operation.
* @public */ Description?: string | undefined; -} - -/** - * @public - */ -export interface UpdateQueueOutboundCallerConfigRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; /** - *The identifier for the queue.
+ *The time zone of the hours of operation.
* @public */ - QueueId: string | undefined; + TimeZone?: string | undefined; /** - *The outbound caller ID name, number, and outbound whisper flow.
+ *Configuration information of the hours of operation.
* @public */ - OutboundCallerConfig: OutboundCallerConfig | undefined; + Config?: HoursOfOperationConfig[] | undefined; } /** - *A conditional check failed.
+ *Request processing failed because dependent condition failed.
* @public */ export class ConditionalOperationFailedException extends __BaseException { @@ -6914,53 +6805,61 @@ export class ConditionalOperationFailedException extends __BaseException { /** * @public */ -export interface UpdateQueueOutboundEmailConfigRequest { +export interface UpdateHoursOfOperationOverrideRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** - *The identifier for the queue.
+ *The identifier for the hours of operation.
* @public */ - QueueId: string | undefined; + HoursOfOperationId: string | undefined; /** - *The outbound email address ID for a specified queue.
+ *The identifier for the hours of operation override.
* @public */ - OutboundEmailConfig: OutboundEmailConfig | undefined; -} + HoursOfOperationOverrideId: string | undefined; -/** - * @public - */ -export interface UpdateQueueStatusRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The name of the hours of operation override.
* @public */ - InstanceId: string | undefined; + Name?: string | undefined; /** - *The identifier for the queue.
+ *The description of the hours of operation override.
* @public */ - QueueId: string | undefined; + Description?: string | undefined; /** - *The status of the queue.
+ *Configuration information for the hours of operation override: day, start time, and end + * time.
* @public */ - Status: QueueStatus | undefined; + Config?: HoursOfOperationOverrideConfig[] | undefined; + + /** + *The date from when the hours of operation override would be effective.
+ * @public + */ + EffectiveFrom?: string | undefined; + + /** + *The date till when the hours of operation override would be effective.
+ * @public + */ + EffectiveTill?: string | undefined; } /** * @public */ -export interface UpdateQuickConnectConfigRequest { +export interface UpdateInstanceAttributeRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6968,22 +6867,26 @@ export interface UpdateQuickConnectConfigRequest { InstanceId: string | undefined; /** - *The identifier for the quick connect.
+ *The type of attribute.
+ *Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, + * contact Amazon Web Services Support for allowlisting.
+ *Information about the configuration settings for the quick connect.
+ *The value for the attribute. Maximum character limit is 100.
* @public */ - QuickConnectConfig: QuickConnectConfig | undefined; + Value: string | undefined; } /** * @public */ -export interface UpdateQuickConnectNameRequest { +export interface UpdateInstanceStorageConfigRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -6991,128 +6894,214 @@ export interface UpdateQuickConnectNameRequest { InstanceId: string | undefined; /** - *The identifier for the quick connect.
+ *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
* @public */ - QuickConnectId: string | undefined; + AssociationId: string | undefined; /** - *The name of the quick connect.
+ *A valid resource type.
* @public */ - Name?: string | undefined; + ResourceType: InstanceStorageResourceType | undefined; /** - *The description of the quick connect.
+ *The storage configuration for the instance.
* @public */ - Description?: string | undefined; + StorageConfig: InstanceStorageConfig | undefined; } /** * @public + * @enum */ -export interface UpdateRoutingProfileAgentAvailabilityTimerRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; +export const TimerEligibleParticipantRoles = { + AGENT: "AGENT", + CUSTOMER: "CUSTOMER", +} as const; - /** - *The identifier of the routing profile.
- * @public - */ - RoutingProfileId: string | undefined; +/** + * @public + */ +export type TimerEligibleParticipantRoles = + (typeof TimerEligibleParticipantRoles)[keyof typeof TimerEligibleParticipantRoles]; - /** - *Whether agents with this routing profile will have their routing order calculated based on - * time since their last inbound contact or longest idle - * time.
- * @public - */ - AgentAvailabilityTimer: AgentAvailabilityTimer | undefined; -} +/** + * @public + * @enum + */ +export const ParticipantTimerType = { + DISCONNECT_NONCUSTOMER: "DISCONNECT_NONCUSTOMER", + IDLE: "IDLE", +} as const; /** * @public */ -export interface UpdateRoutingProfileConcurrencyRequest { +export type ParticipantTimerType = (typeof ParticipantTimerType)[keyof typeof ParticipantTimerType]; + +/** + * @public + * @enum + */ +export const ParticipantTimerAction = { + Unset: "Unset", +} as const; + +/** + * @public + */ +export type ParticipantTimerAction = (typeof ParticipantTimerAction)[keyof typeof ParticipantTimerAction]; + +/** + *The value of the timer. Either the timer action (Unset
to delete the timer), or
+ * the duration of the timer in minutes. Only one value can be set.
For more information about how chat timeouts work, see + * Set up chat timeouts for human participants.
+ * @public + */ +export type ParticipantTimerValue = + | ParticipantTimerValue.ParticipantTimerActionMember + | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember + | ParticipantTimerValue.$UnknownMember; + +/** + * @public + */ +export namespace ParticipantTimerValue { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The timer action. Currently only one value is allowed: Unset
. It deletes a
+ * timer.
The identifier of the routing profile.
+ *The duration of a timer, in minutes.
* @public */ - RoutingProfileId: string | undefined; + export interface ParticipantTimerDurationInMinutesMember { + ParticipantTimerAction?: never; + ParticipantTimerDurationInMinutes: number; + $unknown?: never; + } /** - *The channels that agents can handle in the Contact Control Panel (CCP).
* @public */ - MediaConcurrencies: MediaConcurrency[] | undefined; + export interface $UnknownMember { + ParticipantTimerAction?: never; + ParticipantTimerDurationInMinutes?: never; + $unknown: [string, any]; + } + + export interface VisitorConfiguration information for the timer. After the timer configuration is set, it persists + * for the duration of the chat. It persists across new contacts in the chain, for example, transfer + * contacts.
+ *For more information about how chat timeouts work, see + * Set up chat timeouts for human participants.
* @public */ -export interface UpdateRoutingProfileDefaultOutboundQueueRequest { +export interface ParticipantTimerConfiguration { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The role of the participant in the chat conversation.
* @public */ - InstanceId: string | undefined; + ParticipantRole: TimerEligibleParticipantRoles | undefined; /** - *The identifier of the routing profile.
+ *The type of timer. IDLE
indicates the timer applies for considering a human
+ * chat participant as idle. DISCONNECT_NONCUSTOMER
indicates the timer applies to
+ * automatically disconnecting a chat participant due to idleness.
The identifier for the default outbound queue.
+ *The value of the timer. Either the timer action (Unset to delete the timer), or the duration + * of the timer in minutes. Only one value can be set.
* @public */ - DefaultOutboundQueueId: string | undefined; + TimerValue: ParticipantTimerValue | undefined; } /** + *Configuration information for the chat participant role.
* @public */ -export interface UpdateRoutingProfileNameRequest { +export interface ChatParticipantRoleConfig { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *A list of participant timers. You can specify any unique combination of role and timer type. + * Duplicate entries error out the request with a 400.
* @public */ - InstanceId: string | undefined; + ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined; +} + +/** + *Configuration information for the chat participant role.
+ * @public + */ +export type UpdateParticipantRoleConfigChannelInfo = + | UpdateParticipantRoleConfigChannelInfo.ChatMember + | UpdateParticipantRoleConfigChannelInfo.$UnknownMember; +/** + * @public + */ +export namespace UpdateParticipantRoleConfigChannelInfo { /** - *The identifier of the routing profile.
+ *Configuration information for the chat participant role.
* @public */ - RoutingProfileId: string | undefined; + export interface ChatMember { + Chat: ChatParticipantRoleConfig; + $unknown?: never; + } /** - *The name of the routing profile. Must not be more than 127 characters.
* @public */ - Name?: string | undefined; + export interface $UnknownMember { + Chat?: never; + $unknown: [string, any]; + } + + export interface VisitorThe description of the routing profile. Must not be more than 250 characters.
- * @public - */ - Description?: string | undefined; + export const visit =The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public @@ -7120,706 +7109,670 @@ export interface UpdateRoutingProfileQueuesRequest { InstanceId: string | undefined; /** - *The identifier of the routing profile.
+ *The identifier of the contact in this instance of Amazon Connect.
* @public */ - RoutingProfileId: string | undefined; + ContactId: string | undefined; /** - *The queues to be updated for this routing profile. - * Queues must first be associated to the routing - * profile. You can do this using AssociateRoutingProfileQueues.
+ *The Amazon Connect channel you want to configure.
* @public */ - QueueConfigs: RoutingProfileQueueConfig[] | undefined; + ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined; } /** * @public */ -export interface UpdateRuleRequest { - /** - *A unique identifier for the rule.
- * @public - */ - RuleId: string | undefined; - - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; +export interface UpdateParticipantRoleConfigResponse {} +/** + * @public + */ +export interface UpdatePhoneNumberRequest { /** - *The name of the rule. You can change the name only if TriggerEventSource
is one
- * of the following values: OnZendeskTicketCreate
|
- * OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
- *
A unique identifier for the phone number.
* @public */ - Name: string | undefined; + PhoneNumberId: string | undefined; /** - *The conditions of the rule.
+ *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
A list of actions to be run when the rule is triggered.
+ *The identifier of the Amazon Connect instance that phone numbers are claimed to. You
+ * can find the
+ * instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The publish status of the rule.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - PublishStatus: RulePublishStatus | undefined; + ClientToken?: string | undefined; } /** * @public */ -export interface UpdateSecurityProfileRequest { - /** - *The description of the security profile.
- * @public - */ - Description?: string | undefined; - +export interface UpdatePhoneNumberResponse { /** - *The permissions granted to a security profile. For a list of valid permissions, see List of security - * profile permissions.
+ *A unique identifier for the phone number.
* @public */ - Permissions?: string[] | undefined; + PhoneNumberId?: string | undefined; /** - *The identifier for the security profle.
+ *The Amazon Resource Name (ARN) of the phone number.
* @public */ - SecurityProfileId: string | undefined; + PhoneNumberArn?: string | undefined; +} +/** + * @public + */ +export interface UpdatePhoneNumberMetadataRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The Amazon Resource Name (ARN) or resource ID of the phone number.
* @public */ - InstanceId: string | undefined; + PhoneNumberId: string | undefined; /** - *The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
+ *The description of the phone number.
* @public */ - AllowedAccessControlTags?: RecordThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
* @public */ - TagRestrictedResources?: string[] | undefined; + ClientToken?: string | undefined; +} +/** + * @public + */ +export interface UpdatePredefinedAttributeRequest { /** - *A list of the third-party application's metadata.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource + * Name (ARN) of the instance.
* @public */ - Applications?: Application[] | undefined; + InstanceId: string | undefined; /** - *The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
The name of the predefined attribute.
* @public */ - HierarchyRestrictedResources?: string[] | undefined; + Name: string | undefined; /** - *The identifier of the hierarchy group that a security profile uses to restrict access to - * resources in Amazon Connect.
+ *The values of the predefined attribute.
* @public */ - AllowedAccessControlHierarchyGroupId?: string | undefined; + Values?: PredefinedAttributeValues | undefined; } /** * @public */ -export interface UpdateTaskTemplateRequest { +export interface UpdatePromptRequest { /** - *A unique identifier for the task template.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - TaskTemplateId: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *A unique identifier for the prompt.
* @public */ - InstanceId: string | undefined; + PromptId: string | undefined; /** - *The name of the task template.
+ *The name of the prompt.
* @public */ Name?: string | undefined; /** - *The description of the task template.
+ *A description of the prompt.
* @public */ Description?: string | undefined; /** - *The identifier of the flow that runs by default when a task is created by referencing this template.
+ *The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the + * GetPromptFile + * API instead of providing S3 URIs.
* @public */ - ContactFlowId?: string | undefined; + S3Uri?: string | undefined; +} +/** + * @public + */ +export interface UpdatePromptResponse { /** - *The ContactFlowId for the flow that will be run if this template is used to create a - * self-assigned task.
+ *The Amazon Resource Name (ARN) of the prompt.
* @public */ - SelfAssignFlowId?: string | undefined; + PromptARN?: string | undefined; /** - *Constraints that are applicable to the fields listed.
+ *A unique identifier for the prompt.
* @public */ - Constraints?: TaskTemplateConstraints | undefined; + PromptId?: string | undefined; +} +/** + * @public + */ +export interface UpdateQueueHoursOfOperationRequest { /** - *The default values for fields when a task is created by referencing this template.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Defaults?: TaskTemplateDefaults | undefined; + InstanceId: string | undefined; /** - *Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
- * Tasks can only be created from ACTIVE
templates.
- * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The identifier for the queue.
* @public */ - Status?: TaskTemplateStatus | undefined; + QueueId: string | undefined; /** - *Fields that are part of the template.
+ *The identifier for the hours of operation.
* @public */ - Fields?: TaskTemplateField[] | undefined; + HoursOfOperationId: string | undefined; } /** * @public */ -export interface UpdateTaskTemplateResponse { +export interface UpdateQueueMaxContactsRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - InstanceId?: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the task template resource.
+ *The identifier for the queue.
* @public */ - Id?: string | undefined; + QueueId: string | undefined; /** - *The Amazon Resource Name (ARN) for the task template resource.
+ *The maximum number of contacts that can be in the queue before it is considered full.
* @public */ - Arn?: string | undefined; + MaxContacts?: number | undefined; +} +/** + * @public + */ +export interface UpdateQueueNameRequest { /** - *The name of the task template.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Name?: string | undefined; + InstanceId: string | undefined; /** - *The description of the task template.
+ *The identifier for the queue.
* @public */ - Description?: string | undefined; + QueueId: string | undefined; /** - *The identifier of the flow that runs by default when a task is created by referencing this template.
+ *The name of the queue.
* @public */ - ContactFlowId?: string | undefined; + Name?: string | undefined; /** - *The ContactFlowId for the flow that will be run if this template is used to create a - * self-assigned task.
+ *The description of the queue.
* @public */ - SelfAssignFlowId?: string | undefined; + Description?: string | undefined; +} +/** + * @public + */ +export interface UpdateQueueOutboundCallerConfigRequest { /** - *Constraints that are applicable to the fields listed.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Constraints?: TaskTemplateConstraints | undefined; + InstanceId: string | undefined; /** - *The default values for fields when a task is created by referencing this template.
+ *The identifier for the queue.
* @public */ - Defaults?: TaskTemplateDefaults | undefined; + QueueId: string | undefined; /** - *Fields that are part of the template.
+ *The outbound caller ID name, number, and outbound whisper flow.
* @public */ - Fields?: TaskTemplateField[] | undefined; + OutboundCallerConfig: OutboundCallerConfig | undefined; +} +/** + * @public + */ +export interface UpdateQueueOutboundEmailConfigRequest { /** - *Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
- * Tasks can only be created from ACTIVE
templates.
- * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Status?: TaskTemplateStatus | undefined; + InstanceId: string | undefined; /** - *The timestamp when the task template was last modified.
+ *The identifier for the queue.
* @public */ - LastModifiedTime?: Date | undefined; + QueueId: string | undefined; /** - *The timestamp when the task template was created.
+ *The outbound email address ID for a specified queue.
* @public */ - CreatedTime?: Date | undefined; + OutboundEmailConfig: OutboundEmailConfig | undefined; } /** * @public */ -export interface UpdateTrafficDistributionRequest { +export interface UpdateQueueStatusRequest { /** - *The identifier of the traffic distribution group. - * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. - * The ARN must be provided if the call is from the replicated Region.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Id: string | undefined; + InstanceId: string | undefined; + + /** + *The identifier for the queue.
+ * @public + */ + QueueId: string | undefined; + + /** + *The status of the queue.
+ * @public + */ + Status: QueueStatus | undefined; +} +/** + * @public + */ +export interface UpdateQuickConnectConfigRequest { /** - *The distribution of traffic between the instance and its replica(s).
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - TelephonyConfig?: TelephonyConfig | undefined; + InstanceId: string | undefined; /** - *The distribution that determines which Amazon Web Services Regions should be used to sign in - * agents in to both the instance and its replica(s).
+ *The identifier for the quick connect.
* @public */ - SignInConfig?: SignInConfig | undefined; + QuickConnectId: string | undefined; /** - *The distribution of agents between the instance and its replica(s).
+ *Information about the configuration settings for the quick connect.
* @public */ - AgentConfig?: AgentConfig | undefined; + QuickConnectConfig: QuickConnectConfig | undefined; } /** * @public */ -export interface UpdateTrafficDistributionResponse {} +export interface UpdateQuickConnectNameRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; -/** - * @public - */ -export interface UpdateUserHierarchyRequest { /** - *The identifier of the hierarchy group.
+ *The identifier for the quick connect.
* @public */ - HierarchyGroupId?: string | undefined; + QuickConnectId: string | undefined; /** - *The identifier of the user account.
+ *The name of the quick connect.
* @public */ - UserId: string | undefined; + Name?: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The description of the quick connect.
* @public */ - InstanceId: string | undefined; + Description?: string | undefined; } /** * @public */ -export interface UpdateUserHierarchyGroupNameRequest { +export interface UpdateRoutingProfileAgentAvailabilityTimerRequest { /** - *The name of the hierarchy group. Must not be more than 100 characters.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Name: string | undefined; + InstanceId: string | undefined; /** - *The identifier of the hierarchy group.
+ *The identifier of the routing profile.
* @public */ - HierarchyGroupId: string | undefined; + RoutingProfileId: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *Whether agents with this routing profile will have their routing order calculated based on + * time since their last inbound contact or longest idle + * time.
* @public */ - InstanceId: string | undefined; + AgentAvailabilityTimer: AgentAvailabilityTimer | undefined; } /** - *Contains information about the hierarchy level to update.
* @public */ -export interface HierarchyLevelUpdate { +export interface UpdateRoutingProfileConcurrencyRequest { /** - *The name of the user hierarchy level. Must not be more than 50 characters.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - Name: string | undefined; -} + InstanceId: string | undefined; -/** - *Contains information about the level hierarchy to update.
- * @public - */ -export interface HierarchyStructureUpdate { /** - *The - * update - * for level one.
+ *The identifier of the routing profile.
* @public */ - LevelOne?: HierarchyLevelUpdate | undefined; + RoutingProfileId: string | undefined; /** - *The update for level two.
+ *The channels that agents can handle in the Contact Control Panel (CCP).
* @public */ - LevelTwo?: HierarchyLevelUpdate | undefined; + MediaConcurrencies: MediaConcurrency[] | undefined; +} +/** + * @public + */ +export interface UpdateRoutingProfileDefaultOutboundQueueRequest { /** - *The update for level three.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - LevelThree?: HierarchyLevelUpdate | undefined; + InstanceId: string | undefined; /** - *The update for level four.
+ *The identifier of the routing profile.
* @public */ - LevelFour?: HierarchyLevelUpdate | undefined; + RoutingProfileId: string | undefined; /** - *The update for level five.
+ *The identifier for the default outbound queue.
* @public */ - LevelFive?: HierarchyLevelUpdate | undefined; + DefaultOutboundQueueId: string | undefined; } /** * @public */ -export interface UpdateUserHierarchyStructureRequest { - /** - *The hierarchy levels to update.
- * @public - */ - HierarchyStructure: HierarchyStructureUpdate | undefined; - +export interface UpdateRoutingProfileNameRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; -} -/** - * @public - */ -export interface UpdateUserIdentityInfoRequest { /** - *The identity information for the user.
+ *The identifier of the routing profile.
* @public */ - IdentityInfo: UserIdentityInfo | undefined; + RoutingProfileId: string | undefined; /** - *The identifier of the user account.
+ *The name of the routing profile. Must not be more than 127 characters.
* @public */ - UserId: string | undefined; + Name?: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The description of the routing profile. Must not be more than 250 characters.
* @public */ - InstanceId: string | undefined; + Description?: string | undefined; } /** * @public */ -export interface UpdateUserPhoneConfigRequest { +export interface UpdateRoutingProfileQueuesRequest { /** - *Information about phone configuration settings for the user.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - PhoneConfig: UserPhoneConfig | undefined; + InstanceId: string | undefined; /** - *The identifier of the user account.
+ *The identifier of the routing profile.
* @public */ - UserId: string | undefined; + RoutingProfileId: string | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The queues to be updated for this routing profile. + * Queues must first be associated to the routing + * profile. You can do this using AssociateRoutingProfileQueues.
* @public */ - InstanceId: string | undefined; + QueueConfigs: RoutingProfileQueueConfig[] | undefined; } /** * @public */ -export interface UpdateUserProficienciesRequest { +export interface UpdateRuleRequest { /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource - * Name (ARN) of the instance.
+ *A unique identifier for the rule.
* @public */ - InstanceId: string | undefined; + RuleId: string | undefined; /** - *The identifier of the user account.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - UserId: string | undefined; + InstanceId: string | undefined; /** - *The proficiencies to be updated for the user. Proficiencies must first be associated to the - * user. You can do this using AssociateUserProficiencies API.
+ *The name of the rule. You can change the name only if TriggerEventSource
is one
+ * of the following values: OnZendeskTicketCreate
|
+ * OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
+ *
The identifier of the routing profile for the user.
+ *The conditions of the rule.
* @public */ - RoutingProfileId: string | undefined; + Function: string | undefined; /** - *The identifier of the user account.
+ *A list of actions to be run when the rule is triggered.
* @public */ - UserId: string | undefined; + Actions: RuleAction[] | undefined; /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *The publish status of the rule.
* @public */ - InstanceId: string | undefined; + PublishStatus: RulePublishStatus | undefined; } /** * @public */ -export interface UpdateUserSecurityProfilesRequest { +export interface UpdateSecurityProfileRequest { /** - *The identifiers of the security profiles for the user.
+ *The description of the security profile.
* @public */ - SecurityProfileIds: string[] | undefined; + Description?: string | undefined; /** - *The identifier of the user account.
+ *The permissions granted to a security profile. For a list of valid permissions, see List of security + * profile permissions.
* @public */ - UserId: string | undefined; + Permissions?: string[] | undefined; + + /** + *The identifier for the security profle.
+ * @public + */ + SecurityProfileId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; -} -/** - * @public - */ -export interface UpdateViewContentRequest { /** - *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of - * the instance.
+ *The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
* @public */ - InstanceId: string | undefined; + AllowedAccessControlTags?: RecordThe identifier of the view. Both ViewArn
and ViewId
can be
- * used.
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
* @public */ - ViewId: string | undefined; + TagRestrictedResources?: string[] | undefined; /** - *Indicates the view status as either SAVED
or PUBLISHED
. The
- * PUBLISHED
status will initiate validation on the content.
A list of the third-party application's metadata.
* @public */ - Status: ViewStatus | undefined; + Applications?: Application[] | undefined; /** - *View content containing all content necessary to render a view except for runtime input data - * and the runtime input schema, which is auto-generated by this operation.
- *The total uncompressed content has a maximum file size of 400kB.
+ *The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
A view resource object. Contains metadata and content necessary to render the view.
+ *The identifier of the hierarchy group that a security profile uses to restrict access to + * resources in Amazon Connect.
* @public */ - View?: View | undefined; + AllowedAccessControlHierarchyGroupId?: string | undefined; } /** * @public */ -export interface UpdateViewMetadataRequest { +export interface UpdateTaskTemplateRequest { /** - *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of - * the instance.
+ *A unique identifier for the task template.
* @public */ - InstanceId: string | undefined; + TaskTemplateId: string | undefined; /** - *The identifier of the view. Both ViewArn
and ViewId
can be
- * used.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ - ViewId: string | undefined; + InstanceId: string | undefined; /** - *The name of the view.
+ *The name of the task template.
* @public */ Name?: string | undefined; /** - *The description of the view.
+ *The description of the task template.
* @public */ Description?: string | undefined; -} - -/** - * @public - */ -export interface UpdateViewMetadataResponse {} -/** - *A value for a segment attribute. This is structured as a map where the key is
- * valueString
and the value is a string.
The value of a segment attribute.
+ *The identifier of the flow that runs by default when a task is created by referencing this template.
* @public */ - ValueString?: string | undefined; + ContactFlowId?: string | undefined; /** - *The value of a segment attribute.
+ *The ContactFlowId for the flow that will be run if this template is used to create a + * self-assigned task.
* @public */ - ValueMap?: RecordThe value of a segment attribute.
+ *Constraints that are applicable to the fields listed.
* @public */ - ValueInteger?: number | undefined; -} - -/** - *Information about an item from an evaluation form. The item must be either a section or a - * question.
- * @public - */ -export type EvaluationFormItem = - | EvaluationFormItem.QuestionMember - | EvaluationFormItem.SectionMember - | EvaluationFormItem.$UnknownMember; + Constraints?: TaskTemplateConstraints | undefined; -/** - * @public - */ -export namespace EvaluationFormItem { /** - *The information of the section.
+ *The default values for fields when a task is created by referencing this template.
* @public */ - export interface SectionMember { - Section: EvaluationFormSection; - Question?: never; - $unknown?: never; - } + Defaults?: TaskTemplateDefaults | undefined; /** - *The information of the question.
+ *Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
+ * Tasks can only be created from ACTIVE
templates.
+ * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Fields that are part of the template.
* @public */ - export interface $UnknownMember { - Section?: never; - Question?: never; - $unknown: [string, any]; - } - - export interface VisitorThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId?: string | undefined; + + /** + *The identifier of the task template resource.
+ * @public + */ + Id?: string | undefined; + + /** + *The Amazon Resource Name (ARN) for the task template resource.
+ * @public + */ + Arn?: string | undefined; + + /** + *The name of the task template.
+ * @public + */ + Name?: string | undefined; + + /** + *The description of the task template.
+ * @public + */ + Description?: string | undefined; + + /** + *The identifier of the flow that runs by default when a task is created by referencing this template.
+ * @public + */ + ContactFlowId?: string | undefined; + + /** + *The ContactFlowId for the flow that will be run if this template is used to create a + * self-assigned task.
+ * @public + */ + SelfAssignFlowId?: string | undefined; + + /** + *Constraints that are applicable to the fields listed.
+ * @public + */ + Constraints?: TaskTemplateConstraints | undefined; + + /** + *The default values for fields when a task is created by referencing this template.
+ * @public + */ + Defaults?: TaskTemplateDefaults | undefined; + + /** + *Fields that are part of the template.
+ * @public + */ + Fields?: TaskTemplateField[] | undefined; + + /** + *Marks a template as ACTIVE
or INACTIVE
for a task to refer to it.
+ * Tasks can only be created from ACTIVE
templates.
+ * If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The timestamp when the task template was last modified.
+ * @public + */ + LastModifiedTime?: Date | undefined; + + /** + *The timestamp when the task template was created.
+ * @public + */ + CreatedTime?: Date | undefined; +} + +/** + * @public + */ +export interface UpdateTrafficDistributionRequest { + /** + *The identifier of the traffic distribution group. + * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. + * The ARN must be provided if the call is from the replicated Region.
+ * @public + */ + Id: string | undefined; + + /** + *The distribution of traffic between the instance and its replica(s).
+ * @public + */ + TelephonyConfig?: TelephonyConfig | undefined; + + /** + *The distribution that determines which Amazon Web Services Regions should be used to sign in + * agents in to both the instance and its replica(s).
+ * @public + */ + SignInConfig?: SignInConfig | undefined; + + /** + *The distribution of agents between the instance and its replica(s).
+ * @public + */ + AgentConfig?: AgentConfig | undefined; +} + +/** + * @public + */ +export interface UpdateTrafficDistributionResponse {} + +/** + * @public + */ +export interface UpdateUserHierarchyRequest { + /** + *The identifier of the hierarchy group.
+ * @public + */ + HierarchyGroupId?: string | undefined; + + /** + *The identifier of the user account.
+ * @public + */ + UserId: string | undefined; + + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserHierarchyGroupNameRequest { + /** + *The name of the hierarchy group. Must not be more than 100 characters.
+ * @public + */ + Name: string | undefined; + + /** + *The identifier of the hierarchy group.
+ * @public + */ + HierarchyGroupId: string | undefined; + + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; +} + +/** + *Contains information about the hierarchy level to update.
+ * @public + */ +export interface HierarchyLevelUpdate { + /** + *The name of the user hierarchy level. Must not be more than 50 characters.
+ * @public + */ + Name: string | undefined; +} + +/** + *Contains information about the level hierarchy to update.
+ * @public + */ +export interface HierarchyStructureUpdate { + /** + *The + * update + * for level one.
+ * @public + */ + LevelOne?: HierarchyLevelUpdate | undefined; + + /** + *The update for level two.
+ * @public + */ + LevelTwo?: HierarchyLevelUpdate | undefined; + + /** + *The update for level three.
+ * @public + */ + LevelThree?: HierarchyLevelUpdate | undefined; + + /** + *The update for level four.
+ * @public + */ + LevelFour?: HierarchyLevelUpdate | undefined; + + /** + *The update for level five.
+ * @public + */ + LevelFive?: HierarchyLevelUpdate | undefined; +} + +/** + * @public + */ +export interface UpdateUserHierarchyStructureRequest { + /** + *The hierarchy levels to update.
+ * @public + */ + HierarchyStructure: HierarchyStructureUpdate | undefined; + + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserIdentityInfoRequest { + /** + *The identity information for the user.
+ * @public + */ + IdentityInfo: UserIdentityInfo | undefined; + + /** + *The identifier of the user account.
+ * @public + */ + UserId: string | undefined; + + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserPhoneConfigRequest { + /** + *Information about phone configuration settings for the user.
+ * @public + */ + PhoneConfig: UserPhoneConfig | undefined; + + /** + *The identifier of the user account.
+ * @public + */ + UserId: string | undefined; + + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserProficienciesRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource + * Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier of the user account.
+ * @public + */ + UserId: string | undefined; + + /** + *The proficiencies to be updated for the user. Proficiencies must first be associated to the + * user. You can do this using AssociateUserProficiencies API.
+ * @public + */ + UserProficiencies: UserProficiency[] | undefined; +} + +/** + * @public + */ +export interface UpdateUserRoutingProfileRequest { + /** + *The identifier of the routing profile for the user.
+ * @public + */ + RoutingProfileId: string | undefined; + + /** + *The identifier of the user account.
+ * @public + */ + UserId: string | undefined; + + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserSecurityProfilesRequest { + /** + *The identifiers of the security profiles for the user.
+ * @public + */ + SecurityProfileIds: string[] | undefined; + + /** + *The identifier of the user account.
+ * @public + */ + UserId: string | undefined; + + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateViewContentRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier of the view. Both ViewArn
and ViewId
can be
+ * used.
Indicates the view status as either SAVED
or PUBLISHED
. The
+ * PUBLISHED
status will initiate validation on the content.
View content containing all content necessary to render a view except for runtime input data + * and the runtime input schema, which is auto-generated by this operation.
+ *The total uncompressed content has a maximum file size of 400kB.
+ * @public + */ + Content: ViewInputContent | undefined; +} + +/** + * @public + */ +export interface UpdateViewContentResponse { + /** + *A view resource object. Contains metadata and content necessary to render the view.
+ * @public + */ + View?: View | undefined; +} + +/** + * @public + */ +export interface UpdateViewMetadataRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier of the view. Both ViewArn
and ViewId
can be
+ * used.
The name of the view.
+ * @public + */ + Name?: string | undefined; + + /** + *The description of the view.
+ * @public + */ + Description?: string | undefined; +} + +/** + * @public + */ +export interface UpdateViewMetadataResponse {} + +/** + *A value for a segment attribute. This is structured as a map where the key is
+ * valueString
and the value is a string.
The value of a segment attribute.
+ * @public + */ + ValueString?: string | undefined; + + /** + *The value of a segment attribute.
+ * @public + */ + ValueMap?: RecordThe value of a segment attribute.
+ * @public + */ + ValueInteger?: number | undefined; +} + +/** + *Information about an item from an evaluation form. The item must be either a section or a + * question.
+ * @public + */ +export type EvaluationFormItem = + | EvaluationFormItem.QuestionMember + | EvaluationFormItem.SectionMember + | EvaluationFormItem.$UnknownMember; + +/** + * @public + */ +export namespace EvaluationFormItem { + /** + *The information of the section.
+ * @public + */ + export interface SectionMember { + Section: EvaluationFormSection; + Question?: never; + $unknown?: never; + } + + /** + *The information of the question.
+ * @public + */ + export interface QuestionMember { + Section?: never; + Question: EvaluationFormQuestion; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + Section?: never; + Question?: never; + $unknown: [string, any]; + } + + export interface VisitorInformation about a section from an evaluation form. A section can contain sections and/or * questions. Evaluation forms can only contain sections and subsections (two level nesting).
@@ -163,6 +696,18 @@ export interface ContactFlowModuleSearchCriteria { * @public */ StringCondition?: StringCondition | undefined; + + /** + *The state of the flow.
+ * @public + */ + StateCondition?: ContactFlowModuleState | undefined; + + /** + *The status of the flow.
+ * @public + */ + StatusCondition?: ContactFlowModuleStatus | undefined; } /** @@ -539,6 +1084,36 @@ export interface Expression { OrExpression?: Expression[] | undefined; } +/** + *The search criteria to be used to return hours of operations overrides.
+ * @public + */ +export interface HoursOfOperationOverrideSearchCriteria { + /** + *A list of conditions which would be applied together with an OR condition.
+ * @public + */ + OrConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined; + + /** + *A list of conditions which would be applied together with an AND condition.
+ * @public + */ + AndConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined; + + /** + *A leaf node condition which can be used to specify a string condition.
+ * @public + */ + StringCondition?: StringCondition | undefined; + + /** + *A leaf node condition which can be used to specify a date condition.
+ * @public + */ + DateCondition?: DateCondition | undefined; +} + /** *The search criteria to be used to return hours of operations.
* @public @@ -1682,6 +2257,44 @@ export interface SearchEmailAddressesRequest { SearchFilter?: EmailAddressSearchFilter | undefined; } +/** + * @public + */ +export interface SearchHoursOfOperationOverridesRequest { + /** + *The identifier of the Amazon Connect instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *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. Length Constraints: Minimum length of 1. + * Maximum length of 2500.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum + * value of 100.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *Filters to be applied to search results.
+ * @public + */ + SearchFilter?: HoursOfOperationSearchFilter | undefined; + + /** + *The search criteria to be used to return hours of operations overrides.
+ * @public + */ + SearchCriteria?: HoursOfOperationOverrideSearchCriteria | undefined; +} + /** * @public */ @@ -2394,6 +3007,38 @@ export interface DescribeContactResponse { Contact?: Contact | undefined; } +/** + * @internal + */ +export const UpdateUserIdentityInfoRequestFilterSensitiveLog = (obj: UpdateUserIdentityInfoRequest): any => ({ + ...obj, + ...(obj.IdentityInfo && { IdentityInfo: UserIdentityInfoFilterSensitiveLog(obj.IdentityInfo) }), +}); + +/** + * @internal + */ +export const UpdateViewContentRequestFilterSensitiveLog = (obj: UpdateViewContentRequest): any => ({ + ...obj, + ...(obj.Content && { Content: ViewInputContentFilterSensitiveLog(obj.Content) }), +}); + +/** + * @internal + */ +export const UpdateViewContentResponseFilterSensitiveLog = (obj: UpdateViewContentResponse): any => ({ + ...obj, + ...(obj.View && { View: ViewFilterSensitiveLog(obj.View) }), +}); + +/** + * @internal + */ +export const UpdateViewMetadataRequestFilterSensitiveLog = (obj: UpdateViewMetadataRequest): any => ({ + ...obj, + ...(obj.Name && { Name: SENSITIVE_STRING }), +}); + /** * @internal */ diff --git a/clients/client-connect/src/pagination/ListHoursOfOperationOverridesPaginator.ts b/clients/client-connect/src/pagination/ListHoursOfOperationOverridesPaginator.ts new file mode 100644 index 000000000000..2649403bddeb --- /dev/null +++ b/clients/client-connect/src/pagination/ListHoursOfOperationOverridesPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListHoursOfOperationOverridesCommand, + ListHoursOfOperationOverridesCommandInput, + ListHoursOfOperationOverridesCommandOutput, +} from "../commands/ListHoursOfOperationOverridesCommand"; +import { ConnectClient } from "../ConnectClient"; +import { ConnectPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListHoursOfOperationOverrides: ( + config: ConnectPaginationConfiguration, + input: ListHoursOfOperationOverridesCommandInput, + ...rest: any[] +) => PaginatorA conditional check failed.
", + "smithy.api#documentation": "Request processing failed because dependent condition failed.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -5742,7 +5775,7 @@ "ParticipantRole": { "target": "com.amazonaws.connect#ParticipantRole", "traits": { - "smithy.api#documentation": "The role of the participant in the chat conversation.
" + "smithy.api#documentation": "The role of the participant in the chat conversation.
\nOnly CUSTOMER
is currently supported. Any other values other than\n CUSTOMER
will result in an exception (4xx error).
The state of the flow.
" + } + }, + "StatusCondition": { + "target": "com.amazonaws.connect#ContactFlowModuleStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
" + } } }, "traits": { @@ -7816,6 +7861,118 @@ } } }, + "com.amazonaws.connect#CreateHoursOfOperationOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateHoursOfOperationOverrideRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateHoursOfOperationOverrideResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an hours of operation override in an Amazon Connect hours of operation\n resource
", + "smithy.api#http": { + "method": "PUT", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateHoursOfOperationOverrideRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonHumanReadableName", + "traits": { + "smithy.api#documentation": "The name of the hours of operation override.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#CommonHumanReadableDescription", + "traits": { + "smithy.api#documentation": "The description of the hours of operation override.
" + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideConfigList", + "traits": { + "smithy.api#documentation": "Configuration information for the hours of operation override: day, start time, and end\n time.
", + "smithy.api#required": {} + } + }, + "EffectiveFrom": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The date from when the hours of operation override would be effective.
", + "smithy.api#required": {} + } + }, + "EffectiveTill": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The date until when the hours of operation override would be effective.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#CreateHoursOfOperationOverrideResponse": { + "type": "structure", + "members": { + "HoursOfOperationOverrideId": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation override.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#CreateHoursOfOperationRequest": { "type": "structure", "members": { @@ -8589,7 +8746,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nCreates a new queue for the specified Amazon Connect instance.
\nIf the phone number is claimed to a traffic distribution group that was created in the\n same Region as the Amazon Connect instance where you are calling this API, then you can use a\n full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed\n to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a\n UUID is provided in this scenario, you will receive a\n ResourceNotFoundException
.
Only use the phone number ARN format that doesn't contain instance
in the\n path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This\n is the same ARN format that is returned when you call the ListPhoneNumbersV2\n API.
If you plan to use IAM policies to allow/deny access to this API for phone\n number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
\nCreates a new queue for the specified Amazon Connect instance.
\nIf the phone number is claimed to a traffic distribution group that was created in the\n same Region as the Amazon Connect instance where you are calling this API, then you can use a\n full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed\n to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a\n UUID is provided in this scenario, you will receive a\n ResourceNotFoundException
.
Only use the phone number ARN format that doesn't contain instance
in the\n path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This\n is the same ARN format that is returned when you call the ListPhoneNumbersV2\n API.
If you plan to use IAM policies to allow/deny access to this API for phone\n number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
\nAn object to specify the hours of operation override date field.
" + } + }, + "Value": { + "target": "com.amazonaws.connect#DateYearMonthDayFormat", + "traits": { + "smithy.api#documentation": "An object to specify the hours of operation override date value.
" + } + }, + "ComparisonType": { + "target": "com.amazonaws.connect#DateComparisonType", + "traits": { + "smithy.api#documentation": "An object to specify the hours of operation override date condition\n comparisonType
.
An object to specify the hours of operation override date condition.
" + } + }, "com.amazonaws.connect#DateReference": { "type": "structure", "members": { @@ -10404,6 +10622,12 @@ "smithy.api#documentation": "Information about a reference when the referenceType
is DATE
.\n Otherwise, null.
Deletes an hours of operation override in an Amazon Connect hours of operation\n resource
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteHoursOfOperationOverrideRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationOverrideId": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation override.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.connect#DeleteHoursOfOperationRequest": { "type": "structure", "members": { @@ -12829,6 +13119,86 @@ } } }, + "com.amazonaws.connect#DescribeHoursOfOperationOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeHoursOfOperationOverrideRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeHoursOfOperationOverrideResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the hours of operation override.
", + "smithy.api#http": { + "method": "GET", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeHoursOfOperationOverrideRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationOverrideId": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation override.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DescribeHoursOfOperationOverrideResponse": { + "type": "structure", + "members": { + "HoursOfOperationOverride": { + "target": "com.amazonaws.connect#HoursOfOperationOverride", + "traits": { + "smithy.api#documentation": "Information about the hours of operations override.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#DescribeHoursOfOperationRequest": { "type": "structure", "members": { @@ -15284,6 +15654,32 @@ "com.amazonaws.connect#DurationInSeconds": { "type": "integer" }, + "com.amazonaws.connect#EffectiveHoursOfOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#EffectiveHoursOfOperations" + } + }, + "com.amazonaws.connect#EffectiveHoursOfOperations": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The date that the hours of operation or overrides applies to.
" + } + }, + "OperationalHours": { + "target": "com.amazonaws.connect#OperationalHours", + "traits": { + "smithy.api#documentation": "Information about the hours of operations with the effective override applied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the hours of operations with the effective override applied.
" + } + }, "com.amazonaws.connect#Email": { "type": "string", "traits": { @@ -18110,6 +18506,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#GetEffectiveHoursOfOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetEffectiveHoursOfOperationsRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetEffectiveHoursOfOperationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get the hours of operations with the effective override applied.
", + "smithy.api#http": { + "method": "GET", + "uri": "/effective-hours-of-operations/{InstanceId}/{HoursOfOperationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetEffectiveHoursOfOperationsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FromDate": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The Date from when the hours of operation are listed.
", + "smithy.api#httpQuery": "fromDate", + "smithy.api#required": {} + } + }, + "ToDate": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The Date until when the hours of operation are listed.
", + "smithy.api#httpQuery": "toDate", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#GetEffectiveHoursOfOperationsResponse": { + "type": "structure", + "members": { + "EffectiveHoursOfOperationList": { + "target": "com.amazonaws.connect#EffectiveHoursOfOperationList", + "traits": { + "smithy.api#documentation": "Information about the effective hours of operations
" + } + }, + "TimeZone": { + "target": "com.amazonaws.connect#TimeZone", + "traits": { + "smithy.api#documentation": "The time zone for the hours of operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#GetFederationToken": { "type": "operation", "input": { @@ -19812,6 +20302,156 @@ "com.amazonaws.connect#HoursOfOperationName": { "type": "string" }, + "com.amazonaws.connect#HoursOfOperationOverride": { + "type": "structure", + "members": { + "HoursOfOperationOverrideId": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation override.
" + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation.
" + } + }, + "HoursOfOperationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the hours of operation.
" + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonHumanReadableName", + "traits": { + "smithy.api#documentation": "The name of the hours of operation override.
" + } + }, + "Description": { + "target": "com.amazonaws.connect#CommonHumanReadableDescription", + "traits": { + "smithy.api#documentation": "The description of the hours of operation override.
" + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideConfigList", + "traits": { + "smithy.api#documentation": "Configuration information for the hours of operation override: day, start time, and end\n time.
" + } + }, + "EffectiveFrom": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The date from which the hours of operation override would be effective.
" + } + }, + "EffectiveTill": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The date till which the hours of operation override would be effective.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the hours of operations override.
" + } + }, + "com.amazonaws.connect#HoursOfOperationOverrideConfig": { + "type": "structure", + "members": { + "Day": { + "target": "com.amazonaws.connect#OverrideDays", + "traits": { + "smithy.api#documentation": "The day that the hours of operation override applies to.
" + } + }, + "StartTime": { + "target": "com.amazonaws.connect#OverrideTimeSlice", + "traits": { + "smithy.api#documentation": "The start time when your contact center opens if overrides are applied.
" + } + }, + "EndTime": { + "target": "com.amazonaws.connect#OverrideTimeSlice", + "traits": { + "smithy.api#documentation": "The end time that your contact center closes if overrides are applied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the hours of operation override config: day, start time, and end\n time.
" + } + }, + "com.amazonaws.connect#HoursOfOperationOverrideConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.connect#HoursOfOperationOverrideId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.connect#HoursOfOperationOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HoursOfOperationOverride" + } + }, + "com.amazonaws.connect#HoursOfOperationOverrideSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideSearchCriteria" + } + }, + "com.amazonaws.connect#HoursOfOperationOverrideSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR condition.
" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + }, + "DateCondition": { + "target": "com.amazonaws.connect#DateCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a date condition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The search criteria to be used to return hours of operations overrides.
" + } + }, + "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{4}-\\d{2}-\\d{2}$" + } + }, "com.amazonaws.connect#HoursOfOperationSearchConditionList": { "type": "list", "member": { @@ -22678,6 +23318,116 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#ListHoursOfOperationOverrides": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListHoursOfOperationOverridesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListHoursOfOperationOverridesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "List the hours of operation overrides.
", + "smithy.api#http": { + "method": "GET", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HoursOfOperationOverrideList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListHoursOfOperationOverridesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page. The default MaxResult size is 100. Valid\n Range: Minimum value of 1. Maximum value of 1000.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListHoursOfOperationOverridesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" + } + }, + "HoursOfOperationOverrideList": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideList", + "traits": { + "smithy.api#documentation": "Information about the hours of operation override.
" + } + }, + "LastModifiedRegion": { + "target": "com.amazonaws.connect#RegionName", + "traits": { + "smithy.api#documentation": "The AWS Region where this resource was last modified.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when this resource was last modified.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListHoursOfOperations": { "type": "operation", "input": { @@ -26723,6 +27473,32 @@ } } }, + "com.amazonaws.connect#OperationalHour": { + "type": "structure", + "members": { + "Start": { + "target": "com.amazonaws.connect#OverrideTimeSlice", + "traits": { + "smithy.api#documentation": "The start time that your contact center opens.
" + } + }, + "End": { + "target": "com.amazonaws.connect#OverrideTimeSlice", + "traits": { + "smithy.api#documentation": "The end time that your contact center closes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the hours of operations with the effective override applied.
" + } + }, + "com.amazonaws.connect#OperationalHours": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#OperationalHour" + } + }, "com.amazonaws.connect#Origin": { "type": "string", "traits": { @@ -26929,6 +27705,77 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.connect#OverrideDays": { + "type": "enum", + "members": { + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + } + } + }, + "com.amazonaws.connect#OverrideTimeSlice": { + "type": "structure", + "members": { + "Hours": { + "target": "com.amazonaws.connect#Hours24Format", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The hours.
", + "smithy.api#required": {} + } + }, + "Minutes": { + "target": "com.amazonaws.connect#MinutesLimit60", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The minutes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The start time or end time for an hours of operation override.
" + } + }, "com.amazonaws.connect#PEM": { "type": "string", "traits": { @@ -33469,6 +34316,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#SearchHoursOfOperationOverrides": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchHoursOfOperationOverridesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchHoursOfOperationOverridesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Searches the hours of operation overrides.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-hours-of-operation-overrides", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HoursOfOperationOverrides", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchHoursOfOperationOverridesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results. Length Constraints: Minimum length of 1.\n Maximum length of 2500.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum\n value of 100.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#HoursOfOperationSearchFilter" + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return hours of operations overrides.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchHoursOfOperationOverridesResponse": { + "type": "structure", + "members": { + "HoursOfOperationOverrides": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideList", + "traits": { + "smithy.api#documentation": "Information about the hours of operations overrides.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results. Length Constraints: Minimum length of 1.\n Maximum length of 2500.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of hours of operations which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchHoursOfOperations": { "type": "operation", "input": { @@ -40578,6 +41527,108 @@ } } }, + "com.amazonaws.connect#UpdateHoursOfOperationOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateHoursOfOperationOverrideRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#ConditionalOperationFailedException" + }, + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Update the hours of operation override.
", + "smithy.api#http": { + "method": "POST", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateHoursOfOperationOverrideRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationOverrideId": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideId", + "traits": { + "smithy.api#documentation": "The identifier for the hours of operation override.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonHumanReadableName", + "traits": { + "smithy.api#documentation": "The name of the hours of operation override.
" + } + }, + "Description": { + "target": "com.amazonaws.connect#CommonHumanReadableDescription", + "traits": { + "smithy.api#documentation": "The description of the hours of operation override.
" + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideConfigList", + "traits": { + "smithy.api#documentation": "Configuration information for the hours of operation override: day, start time, and end\n time.
" + } + }, + "EffectiveFrom": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The date from when the hours of operation override would be effective.
" + } + }, + "EffectiveTill": { + "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", + "traits": { + "smithy.api#documentation": "The date till when the hours of operation override would be effective.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.connect#UpdateHoursOfOperationRequest": { "type": "structure", "members": { @@ -43616,13 +44667,13 @@ "FirstName": { "target": "com.amazonaws.connect#AgentFirstName", "traits": { - "smithy.api#documentation": "The first name. This is required if you are using Amazon Connect or SAML for identity\n management.
" + "smithy.api#documentation": "The first name. This is required if you are using Amazon Connect or SAML for identity\n management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a\n non-NFC form (for example, decomposed characters or combining marks) are not accepted.
" } }, "LastName": { "target": "com.amazonaws.connect#AgentLastName", "traits": { - "smithy.api#documentation": "The last name. This is required if you are using Amazon Connect or SAML for identity\n management.
" + "smithy.api#documentation": "The last name. This is required if you are using Amazon Connect or SAML for identity\n management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a\n non-NFC form (for example, decomposed characters or combining marks) are not accepted.
" } }, "Email": { From 8d22e42b6f475b3bccce9bd2fa2266d4899c848e Mon Sep 17 00:00:00 2001 From: awstoolsBase exception class for all service exceptions from Artifact service.
* * @public + * @example Invoke ListCustomerAgreements operation + * ```javascript + * // The ListCustomerAgreements operation returns a collection of customer-agreement resources in the ACTIVE state for the calling credential. + * const input = {}; + * const command = new ListCustomerAgreementsCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "customerAgreements": [ + * { + * "name": "Name of agreement", + * "type": "DEFAULT", + * "acceptanceTerms": [ + * "terms acknowledged when agreement was accepted" + * ], + * "agreementArn": "arn:aws:artifact:::agreement/agreement-abcdef0123456789", + * "arn": "arn:aws:artifact::111111111111:customer-agreement/customer-agreement-abcdef0123456789", + * "awsAccountId": "111111111111", + * "description": "Description of agreement", + * "effectiveStart": "2022-04-01T20:32:04Z", + * "id": "customer-agreement-abcdef0123456789", + * "state": "ACTIVE", + * "terminateTerms": [ + * "terms that must be acknowledged to terminate this agreement" + * ] + * } + * ], + * "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7" + * } + * *\/ + * // example id: example-1 + * ``` + * */ export class ListCustomerAgreementsCommand extends $Command .classBuilder< diff --git a/clients/client-connect/CHANGELOG.md b/clients/client-connect/CHANGELOG.md index 18f2a4f70b4c..9198f57da611 100644 --- a/clients/client-connect/CHANGELOG.md +++ b/clients/client-connect/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.711.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.710.0...v3.711.0) (2024-12-12) + + +### Features + +* **client-connect:** Configure holidays and other overrides to hours of operation in advance. During contact handling, Amazon Connect automatically checks for overrides and provides customers with an appropriate flow path. After an override period passes call center automatically reverts to standard hours of operation. ([6398b6f](https://github.com/aws/aws-sdk-js-v3/commit/6398b6f3ba711532872e39c5affd5b07ffb5ec80)) + + + + + # [3.709.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.708.0...v3.709.0) (2024-12-10) diff --git a/clients/client-connect/package.json b/clients/client-connect/package.json index 7e7f86a9b082..f3168a8ffacf 100644 --- a/clients/client-connect/package.json +++ b/clients/client-connect/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-connect", "description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native", - "version": "3.709.0", + "version": "3.711.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-connect", diff --git a/clients/client-database-migration-service/CHANGELOG.md b/clients/client-database-migration-service/CHANGELOG.md index c97791d61a74..b7827342a0d8 100644 --- a/clients/client-database-migration-service/CHANGELOG.md +++ b/clients/client-database-migration-service/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.711.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.710.0...v3.711.0) (2024-12-12) + + +### Features + +* **client-database-migration-service:** Add parameters to support for kerberos authentication. Add parameter for disabling the Unicode source filter with PostgreSQL settings. Add parameter to use large integer value with Kinesis/Kafka settings. ([97520fc](https://github.com/aws/aws-sdk-js-v3/commit/97520fc08adb83d5bf6c73c253b3b378762fe5dc)) + + + + + # [3.709.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.708.0...v3.709.0) (2024-12-10) **Note:** Version bump only for package @aws-sdk/client-database-migration-service diff --git a/clients/client-database-migration-service/package.json b/clients/client-database-migration-service/package.json index 8b862fb9f0c4..9d2f2b1a8b38 100644 --- a/clients/client-database-migration-service/package.json +++ b/clients/client-database-migration-service/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-database-migration-service", "description": "AWS SDK for JavaScript Database Migration Service Client for Node.js, Browser and React Native", - "version": "3.709.0", + "version": "3.711.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-database-migration-service", diff --git a/clients/client-glue/CHANGELOG.md b/clients/client-glue/CHANGELOG.md index d197b63a45b0..fd6d7d2fb019 100644 --- a/clients/client-glue/CHANGELOG.md +++ b/clients/client-glue/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.711.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.710.0...v3.711.0) (2024-12-12) + + +### Features + +* **client-glue:** To support customer-managed encryption in Data Quality to allow customers encrypt data with their own KMS key, we will add a DataQualityEncryption field to the SecurityConfiguration API where customers can provide their KMS keys. ([6d74002](https://github.com/aws/aws-sdk-js-v3/commit/6d74002aebb817c6abecd77b3318b40a46cc8072)) + + + + + # [3.709.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.708.0...v3.709.0) (2024-12-10) **Note:** Version bump only for package @aws-sdk/client-glue diff --git a/clients/client-glue/package.json b/clients/client-glue/package.json index 437045912278..7737db737309 100644 --- a/clients/client-glue/package.json +++ b/clients/client-glue/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-glue", "description": "AWS SDK for JavaScript Glue Client for Node.js, Browser and React Native", - "version": "3.709.0", + "version": "3.711.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-glue", diff --git a/clients/client-guardduty/CHANGELOG.md b/clients/client-guardduty/CHANGELOG.md index b5a283e1ef68..3d3db21d6ecd 100644 --- a/clients/client-guardduty/CHANGELOG.md +++ b/clients/client-guardduty/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.711.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.710.0...v3.711.0) (2024-12-12) + +**Note:** Version bump only for package @aws-sdk/client-guardduty + + + + + # [3.709.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.708.0...v3.709.0) (2024-12-10) **Note:** Version bump only for package @aws-sdk/client-guardduty diff --git a/clients/client-guardduty/package.json b/clients/client-guardduty/package.json index 6027ed4f0a5c..6ef42f242fb9 100644 --- a/clients/client-guardduty/package.json +++ b/clients/client-guardduty/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-guardduty", "description": "AWS SDK for JavaScript Guardduty Client for Node.js, Browser and React Native", - "version": "3.709.0", + "version": "3.711.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-guardduty", diff --git a/clients/client-route-53-domains/CHANGELOG.md b/clients/client-route-53-domains/CHANGELOG.md index ed23024b4bb6..4f93cd384d13 100644 --- a/clients/client-route-53-domains/CHANGELOG.md +++ b/clients/client-route-53-domains/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.711.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.710.0...v3.711.0) (2024-12-12) + + +### Features + +* **client-route-53-domains:** This release includes the following API updates: added the enumeration type RESTORE_DOMAIN to the OperationType; constrained the Price attribute to non-negative values; updated the LangCode to allow 2 or 3 alphabetical characters. ([c149c7a](https://github.com/aws/aws-sdk-js-v3/commit/c149c7ab089bc5be94512c19820ed6545bdd89dc)) + + + + + # [3.709.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.708.0...v3.709.0) (2024-12-10) **Note:** Version bump only for package @aws-sdk/client-route-53-domains diff --git a/clients/client-route-53-domains/package.json b/clients/client-route-53-domains/package.json index 2c3390c30133..a8ac7ec36454 100644 --- a/clients/client-route-53-domains/package.json +++ b/clients/client-route-53-domains/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-route-53-domains", "description": "AWS SDK for JavaScript Route 53 Domains Client for Node.js, Browser and React Native", - "version": "3.709.0", + "version": "3.711.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-route-53-domains", diff --git a/lerna.json b/lerna.json index fc767bc6a522..f3926f035898 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "3.710.0", + "version": "3.711.0", "npmClient": "yarn", "useWorkspaces": true, "command": { From 718151ab64c7c40740231463339bc8b09419b625 Mon Sep 17 00:00:00 2001 From: sid <48153483+siddsriv@users.noreply.github.com> Date: Fri, 13 Dec 2024 12:09:08 -0500 Subject: [PATCH 18/27] fix(util-user-agent-node): appId config file name correction (#6729) * chore(util-user-agent-node): appId config file name correction * chore(util-user-agent-node): add deprecated name * chore(util-user-agent-node): deprecated annotation * chore(util-user-agent-node): remove export --- .../src/nodeAppIdConfigOptions.ts | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/packages/util-user-agent-node/src/nodeAppIdConfigOptions.ts b/packages/util-user-agent-node/src/nodeAppIdConfigOptions.ts index 95255eafffba..bf570d2151a5 100644 --- a/packages/util-user-agent-node/src/nodeAppIdConfigOptions.ts +++ b/packages/util-user-agent-node/src/nodeAppIdConfigOptions.ts @@ -1,6 +1,5 @@ -import { LoadedConfigSelectors } from "@smithy/node-config-provider"; import { DEFAULT_UA_APP_ID } from "@aws-sdk/middleware-user-agent"; - +import { LoadedConfigSelectors } from "@smithy/node-config-provider"; /** * @internal @@ -10,13 +9,18 @@ export const UA_APP_ID_ENV_NAME = "AWS_SDK_UA_APP_ID"; /** * @internal */ -export const UA_APP_ID_INI_NAME = "sdk-ua-app-id"; +export const UA_APP_ID_INI_NAME = "sdk_ua_app_id"; + +/** + * @deprecated + */ +const UA_APP_ID_INI_NAME_DEPRECATED = "sdk-ua-app-id"; /** * @internal */ export const NODE_APP_ID_CONFIG_OPTIONS: LoadedConfigSelectorsThe request was rejected because it is not a valid request.
* + * @throws {@link CloudHsmResourceLimitExceededException} (client fault) + *The request was rejected because it exceeds an CloudHSM limit.
+ * * @throws {@link CloudHsmResourceNotFoundException} (client fault) *The request was rejected because it refers to a resource that cannot be * found.
diff --git a/clients/client-cloudhsm-v2/src/models/models_0.ts b/clients/client-cloudhsm-v2/src/models/models_0.ts index b7ceee8eb93b..f37d165d9ab0 100644 --- a/clients/client-cloudhsm-v2/src/models/models_0.ts +++ b/clients/client-cloudhsm-v2/src/models/models_0.ts @@ -399,6 +399,20 @@ export interface CopyBackupToRegionResponse { DestinationBackup?: DestinationBackup | undefined; } +/** + * @public + * @enum + */ +export const NetworkType = { + DUALSTACK: "DUALSTACK", + IPV4: "IPV4", +} as const; + +/** + * @public + */ +export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType]; + /** * @public */ @@ -440,6 +454,14 @@ export interface CreateClusterRequest { */ SubnetIds: string[] | undefined; + /** + *The NetworkType to create a cluster with. The allowed values are
+ * IPV4
and DUALSTACK
.
+ *
Tags to apply to the CloudHSM cluster during creation.
* @public @@ -545,6 +567,12 @@ export interface Hsm { */ EniIp?: string | undefined; + /** + *The IPv6 address (if any) of the HSM's elastic network interface (ENI).
+ * @public + */ + EniIpV6?: string | undefined; + /** *The HSM's identifier (ID).
* @public @@ -576,6 +604,8 @@ export const ClusterState = { DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS", INITIALIZED: "INITIALIZED", INITIALIZE_IN_PROGRESS: "INITIALIZE_IN_PROGRESS", + MODIFY_IN_PROGRESS: "MODIFY_IN_PROGRESS", + ROLLBACK_IN_PROGRESS: "ROLLBACK_IN_PROGRESS", UNINITIALIZED: "UNINITIALIZED", UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS", } as const; @@ -670,6 +700,16 @@ export interface Cluster { */ VpcId?: string | undefined; + /** + *The cluster's NetworkType can be set to either IPV4 (which is the default) or DUALSTACK. + * When set to IPV4, communication between your application and the Hardware Security Modules (HSMs) is restricted to the IPv4 protocol only. + * In contrast, the DUALSTACK network type enables communication over both the IPv4 and IPv6 protocols. + * To use the DUALSTACK option, you'll need to configure your Virtual Private Cloud (VPC) and subnets to support both IPv4 and IPv6. This involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. + * The choice between IPV4 and DUALSTACK network types determines the flexibility of the network addressing setup for your cluster. The DUALSTACK option provides more flexibility by allowing both IPv4 and IPv6 communication.
+ * @public + */ + NetworkType?: NetworkType | undefined; + /** *Contains one or more certificates or a certificate signing request (CSR).
* @public @@ -1210,6 +1250,28 @@ export interface RestoreBackupResponse { Backup?: Backup | undefined; } +/** + *The request was rejected because it exceeds an CloudHSM limit.
+ * @public + */ +export class CloudHsmResourceLimitExceededException extends __BaseException { + readonly name: "CloudHsmResourceLimitExceededException" = "CloudHsmResourceLimitExceededException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was rejected because it exceeds an CloudHSM limit.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException": { "type": "structure", "members": { @@ -1467,6 +1479,12 @@ "smithy.api#documentation": "The identifier (ID) of the virtual private cloud (VPC) that contains the\n cluster.
" } }, + "NetworkType": { + "target": "com.amazonaws.cloudhsmv2#NetworkType", + "traits": { + "smithy.api#documentation": "The cluster's NetworkType can be set to either IPV4 (which is the default) or DUALSTACK.\n When set to IPV4, communication between your application and the Hardware Security Modules (HSMs) is restricted to the IPv4 protocol only.\n In contrast, the DUALSTACK network type enables communication over both the IPv4 and IPv6 protocols.\n To use the DUALSTACK option, you'll need to configure your Virtual Private Cloud (VPC) and subnets to support both IPv4 and IPv6. This involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets.\n The choice between IPV4 and DUALSTACK network types determines the flexibility of the network addressing setup for your cluster. The DUALSTACK option provides more flexibility by allowing both IPv4 and IPv6 communication.
" + } + }, "Certificates": { "target": "com.amazonaws.cloudhsmv2#Certificates", "traits": { @@ -1552,6 +1570,18 @@ "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } }, + "MODIFY_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFY_IN_PROGRESS" + } + }, + "ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" + } + }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { @@ -1722,6 +1752,12 @@ "smithy.api#required": {} } }, + "NetworkType": { + "target": "com.amazonaws.cloudhsmv2#NetworkType", + "traits": { + "smithy.api#documentation": "The NetworkType to create a cluster with. The allowed values are\n IPV4
and DUALSTACK
.\n
The IP address of the HSM's elastic network interface (ENI).
" } }, + "EniIpV6": { + "target": "com.amazonaws.cloudhsmv2#IpV6Address", + "traits": { + "smithy.api#documentation": "The IPv6 address (if any) of the HSM's elastic network interface (ENI).
" + } + }, "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { @@ -2586,6 +2641,15 @@ "smithy.api#pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$" } }, + "com.amazonaws.cloudhsmv2#IpV6Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.cloudhsmv2#ListTags": { "type": "operation", "input": { @@ -2804,6 +2868,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudhsmv2#NetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "DUALSTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUALSTACK" + } + } + } + }, "com.amazonaws.cloudhsmv2#NextToken": { "type": "string", "traits": { @@ -3088,6 +3169,9 @@ { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceLimitExceededException" + }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, From 537aeca538d1256bb1583fc2a7574b7729fed159 Mon Sep 17 00:00:00 2001 From: awstoolsDeletes a security group.
@@ -45,7 +45,10 @@ export interface DeleteSecurityGroupCommandOutput extends __MetadataBearer {} * }; * const command = new DeleteSecurityGroupCommand(input); * const response = await client.send(command); - * // {}; + * // { // DeleteSecurityGroupResult + * // Return: true || false, + * // GroupId: "STRING_VALUE", + * // }; * * ``` * @@ -96,7 +99,7 @@ export class DeleteSecurityGroupCommand extends $Command protected declare static __types: { api: { input: DeleteSecurityGroupRequest; - output: {}; + output: DeleteSecurityGroupResult; }; sdk: { input: DeleteSecurityGroupCommandInput; diff --git a/clients/client-ec2/src/commands/DescribeFleetInstancesCommand.ts b/clients/client-ec2/src/commands/DescribeFleetInstancesCommand.ts index a62a35ca1de0..57be3c6d6849 100644 --- a/clients/client-ec2/src/commands/DescribeFleetInstancesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeFleetInstancesCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeFleetInstancesRequest } from "../models/models_3"; -import { DescribeFleetInstancesResult } from "../models/models_4"; +import { DescribeFleetInstancesRequest, DescribeFleetInstancesResult } from "../models/models_4"; import { de_DescribeFleetInstancesCommand, se_DescribeFleetInstancesCommand } from "../protocols/Aws_ec2"; /** diff --git a/clients/client-ec2/src/commands/DescribeReservedInstancesCommand.ts b/clients/client-ec2/src/commands/DescribeReservedInstancesCommand.ts index 74077166eadb..cde7e78522da 100644 --- a/clients/client-ec2/src/commands/DescribeReservedInstancesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeReservedInstancesCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeReservedInstancesRequest } from "../models/models_4"; -import { DescribeReservedInstancesResult } from "../models/models_5"; +import { DescribeReservedInstancesRequest, DescribeReservedInstancesResult } from "../models/models_5"; import { de_DescribeReservedInstancesCommand, se_DescribeReservedInstancesCommand } from "../protocols/Aws_ec2"; /** diff --git a/clients/client-ec2/src/commands/EnableAllowedImagesSettingsCommand.ts b/clients/client-ec2/src/commands/EnableAllowedImagesSettingsCommand.ts index 2140b29b34af..9c7858961faa 100644 --- a/clients/client-ec2/src/commands/EnableAllowedImagesSettingsCommand.ts +++ b/clients/client-ec2/src/commands/EnableAllowedImagesSettingsCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { EnableAllowedImagesSettingsRequest } from "../models/models_5"; -import { EnableAllowedImagesSettingsResult } from "../models/models_6"; +import { EnableAllowedImagesSettingsRequest, EnableAllowedImagesSettingsResult } from "../models/models_6"; import { de_EnableAllowedImagesSettingsCommand, se_EnableAllowedImagesSettingsCommand } from "../protocols/Aws_ec2"; /** diff --git a/clients/client-ec2/src/commands/ModifyInstanceEventWindowCommand.ts b/clients/client-ec2/src/commands/ModifyInstanceEventWindowCommand.ts index 8fe4177f1376..1398f8e9c723 100644 --- a/clients/client-ec2/src/commands/ModifyInstanceEventWindowCommand.ts +++ b/clients/client-ec2/src/commands/ModifyInstanceEventWindowCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ModifyInstanceEventWindowRequest, ModifyInstanceEventWindowResult } from "../models/models_6"; +import { ModifyInstanceEventWindowRequest } from "../models/models_6"; +import { ModifyInstanceEventWindowResult } from "../models/models_7"; import { de_ModifyInstanceEventWindowCommand, se_ModifyInstanceEventWindowCommand } from "../protocols/Aws_ec2"; /** diff --git a/clients/client-ec2/src/commands/StartDeclarativePoliciesReportCommand.ts b/clients/client-ec2/src/commands/StartDeclarativePoliciesReportCommand.ts index 8528aa8042f0..88a783dadfe0 100644 --- a/clients/client-ec2/src/commands/StartDeclarativePoliciesReportCommand.ts +++ b/clients/client-ec2/src/commands/StartDeclarativePoliciesReportCommand.ts @@ -56,9 +56,9 @@ export interface StartDeclarativePoliciesReportCommandOutput *An S3 bucket must be available before generating the report (you can create a - * new one or use an existing one), and it must have an appropriate bucket policy. - * For a sample S3 policy, see Sample Amazon S3 policy under - * .
+ * new one or use an existing one), it must be in the same Region where the report + * generation request is made, and it must have an appropriate bucket policy. For a + * sample S3 policy, see Sample Amazon S3 policy under . *Trusted access must be enabled for the service for which the declarative diff --git a/clients/client-ec2/src/commands/UnlockSnapshotCommand.ts b/clients/client-ec2/src/commands/UnlockSnapshotCommand.ts index 7217fc4a69e5..0247763fdff6 100644 --- a/clients/client-ec2/src/commands/UnlockSnapshotCommand.ts +++ b/clients/client-ec2/src/commands/UnlockSnapshotCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UnlockSnapshotRequest, UnlockSnapshotResult } from "../models/models_7"; +import { UnlockSnapshotRequest } from "../models/models_7"; +import { UnlockSnapshotResult } from "../models/models_8"; import { de_UnlockSnapshotCommand, se_UnlockSnapshotCommand } from "../protocols/Aws_ec2"; /** diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts index fdea21033850..2b8fd6aa08f3 100644 --- a/clients/client-ec2/src/models/models_3.ts +++ b/clients/client-ec2/src/models/models_3.ts @@ -1618,6 +1618,23 @@ export interface DeleteSecurityGroupRequest { DryRun?: boolean | undefined; } +/** + * @public + */ +export interface DeleteSecurityGroupResult { + /** + *
Returns true
if the request succeeds; otherwise, returns an error.
The ID of the deleted security group.
+ * @public + */ + GroupId?: string | undefined; +} + /** * @public */ @@ -3133,6 +3150,7 @@ export interface DescribeAccountAttributesResult { * Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. *If you specify multiple filters, the filters are joined with an AND
, and the request returns only
* results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
* @public */ export interface Filter { @@ -7868,51 +7886,6 @@ export interface DescribeFleetHistoryResult { StartTime?: Date | undefined; } -/** - * @public - */ -export interface DescribeFleetInstancesRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation
.
- * Otherwise, it is UnauthorizedOperation
.
The maximum number of items to return for this request. - * To get the next page of items, make another request with the token returned in the output. - * For more information, see Pagination.
- * @public - */ - MaxResults?: number | undefined; - - /** - *The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- * @public - */ - NextToken?: string | undefined; - - /** - *The ID of the EC2 Fleet.
- * @public - */ - FleetId: string | undefined; - - /** - *The filters.
- *
- * instance-type
- The instance type.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation
.
+ * Otherwise, it is UnauthorizedOperation
.
The maximum number of items to return for this request. + * To get the next page of items, make another request with the token returned in the output. + * For more information, see Pagination.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
+ * @public + */ + NextToken?: string | undefined; + + /** + *The ID of the EC2 Fleet.
+ * @public + */ + FleetId: string | undefined; + + /** + *The filters.
+ *
+ * instance-type
- The instance type.
Contains the parameters for DescribeReservedInstances.
- * @public - */ -export interface DescribeReservedInstancesRequest { - /** - *Describes whether the Reserved Instance is Standard or Convertible.
- * @public - */ - OfferingClass?: OfferingClassType | undefined; - - /** - *One or more Reserved Instance IDs.
- *Default: Describes all your Reserved Instances, or only those otherwise specified.
- * @public - */ - ReservedInstancesIds?: string[] | undefined; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation
.
- * Otherwise, it is UnauthorizedOperation
.
One or more filters.
- *
- * availability-zone
- The Availability Zone where the Reserved Instance can be used.
- * duration
- The duration of the Reserved Instance (one year or three years), in seconds (31536000
| 94608000
).
- * end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
- * fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
- * instance-type
- The instance type that is covered by the reservation.
- * scope
- The scope of the Reserved Instance (Region
or Availability Zone
).
- * product-description
- The Reserved Instance product platform description
- * (Linux/UNIX
| Linux with SQL Server Standard
|
- * Linux with SQL Server Web
| Linux with SQL Server Enterprise
|
- * SUSE Linux
|
- * Red Hat Enterprise Linux
| Red Hat Enterprise Linux with HA
|
- * Windows
| Windows with SQL Server Standard
|
- * Windows with SQL Server Web
| Windows with SQL Server Enterprise
).
- * reserved-instances-id
- The ID of the Reserved Instance.
- * start
- The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
- * state
- The state of the Reserved Instance (payment-pending
| active
| payment-failed
| retired
).
- * tag:
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
- * For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
- * tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
- * version, you only have access to the Medium Utilization
Reserved Instance
- * offering type.
Contains the parameters for DescribeReservedInstances.
+ * @public + */ +export interface DescribeReservedInstancesRequest { + /** + *Describes whether the Reserved Instance is Standard or Convertible.
+ * @public + */ + OfferingClass?: OfferingClassType | undefined; + + /** + *One or more Reserved Instance IDs.
+ *Default: Describes all your Reserved Instances, or only those otherwise specified.
+ * @public + */ + ReservedInstancesIds?: string[] | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation
.
+ * Otherwise, it is UnauthorizedOperation
.
One or more filters.
+ *
+ * availability-zone
- The Availability Zone where the Reserved Instance can be used.
+ * duration
- The duration of the Reserved Instance (one year or three years), in seconds (31536000
| 94608000
).
+ * end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
+ * fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
+ * instance-type
- The instance type that is covered by the reservation.
+ * scope
- The scope of the Reserved Instance (Region
or Availability Zone
).
+ * product-description
- The Reserved Instance product platform description
+ * (Linux/UNIX
| Linux with SQL Server Standard
|
+ * Linux with SQL Server Web
| Linux with SQL Server Enterprise
|
+ * SUSE Linux
|
+ * Red Hat Enterprise Linux
| Red Hat Enterprise Linux with HA
|
+ * Windows
| Windows with SQL Server Standard
|
+ * Windows with SQL Server Web
| Windows with SQL Server Enterprise
).
+ * reserved-instances-id
- The ID of the Reserved Instance.
+ * start
- The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
+ * state
- The state of the Reserved Instance (payment-pending
| active
| payment-failed
| retired
).
+ * tag:
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
+ * For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
+ * tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
+ * version, you only have access to the Medium Utilization
Reserved Instance
+ * offering type.
Specify enabled
to apply the image criteria specified by the Allowed AMIs
- * settings. Specify audit-mode
so that you can check which AMIs will be allowed or
- * not allowed by the image criteria.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is
- * DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Specify enabled
to apply the image criteria specified by the Allowed AMIs
+ * settings. Specify audit-mode
so that you can check which AMIs will be allowed or
+ * not allowed by the image criteria.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the event window.
- * @public - */ - InstanceEventWindow?: InstanceEventWindow | undefined; -} - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_7.ts b/clients/client-ec2/src/models/models_7.ts index 67197fe19043..a998c5bfa369 100644 --- a/clients/client-ec2/src/models/models_7.ts +++ b/clients/client-ec2/src/models/models_7.ts @@ -17,6 +17,7 @@ import { EnaSrdSpecification, IamInstanceProfileAssociation, IamInstanceProfileSpecification, + InstanceEventWindow, IpPermission, Ipv6SupportValue, NatGatewayAddress, @@ -158,6 +159,17 @@ import { import { CapacityReservationSpecification, IpamResourceCidr, OperationType, Purchase } from "./models_6"; +/** + * @public + */ +export interface ModifyInstanceEventWindowResult { + /** + *Information about the event window.
+ * @public + */ + InstanceEventWindow?: InstanceEventWindow | undefined; +} + /** * @public */ @@ -8927,7 +8939,8 @@ export interface StartDeclarativePoliciesReportRequest { DryRun?: boolean | undefined; /** - *The name of the S3 bucket where the report will be saved.
+ *The name of the S3 bucket where the report will be saved. The bucket must be in the + * same Region where the report generation request is made.
* @public */ S3Bucket: string | undefined; @@ -9464,17 +9477,6 @@ export interface UnlockSnapshotRequest { DryRun?: boolean | undefined; } -/** - * @public - */ -export interface UnlockSnapshotResult { - /** - *The ID of the snapshot.
- * @public - */ - SnapshotId?: string | undefined; -} - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_8.ts b/clients/client-ec2/src/models/models_8.ts index 3d9e67a1494b..939aba257535 100644 --- a/clients/client-ec2/src/models/models_8.ts +++ b/clients/client-ec2/src/models/models_8.ts @@ -3,6 +3,17 @@ import { ByoipCidr, IpPermission } from "./models_0"; import { InstanceMonitoring } from "./models_7"; +/** + * @public + */ +export interface UnlockSnapshotResult { + /** + *The ID of the snapshot.
+ * @public + */ + SnapshotId?: string | undefined; +} + /** * @public */ diff --git a/clients/client-ec2/src/protocols/Aws_ec2.ts b/clients/client-ec2/src/protocols/Aws_ec2.ts index f9576236b57d..2394cabd050a 100644 --- a/clients/client-ec2/src/protocols/Aws_ec2.ts +++ b/clients/client-ec2/src/protocols/Aws_ec2.ts @@ -3080,6 +3080,7 @@ import { DeleteRouteRequest, DeleteRouteTableRequest, DeleteSecurityGroupRequest, + DeleteSecurityGroupResult, DeleteSnapshotRequest, DeleteSpotDatafeedSubscriptionRequest, DeleteSubnetCidrReservationRequest, @@ -3225,7 +3226,6 @@ import { DescribeFastSnapshotRestoreSuccessItem, DescribeFleetHistoryRequest, DescribeFleetHistoryResult, - DescribeFleetInstancesRequest, DirectoryServiceAuthentication, DiskImageDescription, DiskImageVolumeDescription, @@ -3266,6 +3266,7 @@ import { ConnectionTrackingSpecificationResponse, CpuOptions, DescribeFleetError, + DescribeFleetInstancesRequest, DescribeFleetInstancesResult, DescribeFleetsInstances, DescribeFleetsRequest, @@ -3390,7 +3391,6 @@ import { DescribeRegionsResult, DescribeReplaceRootVolumeTasksRequest, DescribeReplaceRootVolumeTasksResult, - DescribeReservedInstancesRequest, DestinationOptionsResponse, DiskInfo, EbsInfo, @@ -3518,6 +3518,7 @@ import { DescribeReservedInstancesModificationsResult, DescribeReservedInstancesOfferingsRequest, DescribeReservedInstancesOfferingsResult, + DescribeReservedInstancesRequest, DescribeReservedInstancesResult, DescribeRouteTablesRequest, DescribeRouteTablesResult, @@ -3718,7 +3719,6 @@ import { DisassociateVpcCidrBlockResult, EnableAddressTransferRequest, EnableAddressTransferResult, - EnableAllowedImagesSettingsRequest, HistoryRecord, InstanceEventWindowDisassociationRequest, InstanceNetworkInterfaceSpecification, @@ -3801,6 +3801,7 @@ import { DiskImageDetail, DnsServersOptionsModifyStructure, EbsInstanceBlockDeviceSpecification, + EnableAllowedImagesSettingsRequest, EnableAllowedImagesSettingsResult, EnableAwsNetworkPerformanceMetricSubscriptionRequest, EnableAwsNetworkPerformanceMetricSubscriptionResult, @@ -4034,7 +4035,6 @@ import { ModifyInstanceEventStartTimeRequest, ModifyInstanceEventStartTimeResult, ModifyInstanceEventWindowRequest, - ModifyInstanceEventWindowResult, PrefixListAssociation, PrefixListEntry, Purchase, @@ -4084,6 +4084,7 @@ import { IpamCidrAuthorizationContext, LaunchTemplateSpecification, LicenseConfigurationRequest, + ModifyInstanceEventWindowResult, ModifyInstanceMaintenanceOptionsRequest, ModifyInstanceMaintenanceOptionsResult, ModifyInstanceMetadataDefaultsRequest, @@ -4350,7 +4351,6 @@ import { UnassignPrivateNatGatewayAddressRequest, UnassignPrivateNatGatewayAddressResult, UnlockSnapshotRequest, - UnlockSnapshotResult, VerifiedAccessLogCloudWatchLogsDestinationOptions, VerifiedAccessLogKinesisDataFirehoseDestinationOptions, VerifiedAccessLogOptions, @@ -4358,6 +4358,7 @@ import { } from "../models/models_7"; import { SecurityGroupRuleDescription, + UnlockSnapshotResult, UnmonitorInstancesRequest, UnmonitorInstancesResult, UpdateSecurityGroupRuleDescriptionsEgressRequest, @@ -19216,9 +19217,12 @@ export const de_DeleteSecurityGroupCommand = async ( if (output.statusCode >= 300) { return de_CommandError(output, context); } - await collectBody(output.body, context); + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_DeleteSecurityGroupResult(data, context); const response: DeleteSecurityGroupCommandOutput = { $metadata: deserializeMetadata(output), + ...contents, }; return response; }; @@ -62618,6 +62622,20 @@ const de_DeleteQueuedReservedInstancesResult = ( return contents; }; +/** + * deserializeAws_ec2DeleteSecurityGroupResult + */ +const de_DeleteSecurityGroupResult = (output: any, context: __SerdeContext): DeleteSecurityGroupResult => { + const contents: any = {}; + if (output[_r] != null) { + contents[_Ret] = __parseBoolean(output[_r]); + } + if (output[_gIr] != null) { + contents[_GIr] = __expectString(output[_gIr]); + } + return contents; +}; + /** * deserializeAws_ec2DeleteSubnetCidrReservationResult */ diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 2a71cc001a5f..2d5e76f06c4e 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -26456,7 +26456,7 @@ "target": "com.amazonaws.ec2#DeleteSecurityGroupRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.ec2#DeleteSecurityGroupResult" }, "traits": { "smithy.api#documentation": "Deletes a security group.
\nIf you attempt to delete a security group that is associated with an instance or network interface, is\n\t\t\t referenced by another security group in the same VPC, or has a VPC association, the operation fails with\n\t\t\t\tDependencyViolation
.
Returns true
if the request succeeds; otherwise, returns an error.
The ID of the deleted security group.
", + "smithy.api#xmlName": "groupId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DeleteSnapshot": { "type": "operation", "input": { @@ -52141,7 +52165,7 @@ } }, "traits": { - "smithy.api#documentation": "A filter name and value pair that is used to return a more specific list of results from a describe operation. \n Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
\nIf you specify multiple filters, the filters are joined with an AND
, and the request returns only \n results that match all of the specified filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. \n Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
\nIf you specify multiple filters, the filters are joined with an AND
, and the request returns only \n results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#FilterList": { @@ -102737,7 +102761,7 @@ "target": "com.amazonaws.ec2#StartDeclarativePoliciesReportResult" }, "traits": { - "smithy.api#documentation": "Generates an account status report. The report is generated asynchronously, and can\n take several hours to complete.
\nThe report provides the current status of all attributes supported by declarative\n policies for the accounts within the specified scope. The scope is determined by the\n specified TargetId
, which can represent an individual account, or all the\n accounts that fall under the specified organizational unit (OU) or root (the entire\n Amazon Web Services Organization).
The report is saved to your specified S3 bucket, using the following path structure\n (with the italicized placeholders representing your specific\n values):
\n\n s3://amzn-s3-demo-bucket/your-optional-s3-prefix/ec2_targetId_reportId_yyyyMMddThhmmZ.csv
\n
\n Prerequisites for generating a report\n
\nThe StartDeclarativePoliciesReport
API can only be called by the\n management account or delegated administrators for the organization.
An S3 bucket must be available before generating the report (you can create a\n new one or use an existing one), and it must have an appropriate bucket policy.\n For a sample S3 policy, see Sample Amazon S3 policy under\n .
\nTrusted access must be enabled for the service for which the declarative\n policy will enforce a baseline configuration. If you use the Amazon Web Services Organizations\n console, this is done automatically when you enable declarative policies. The\n API uses the following service principal to identify the EC2 service:\n ec2.amazonaws.com
. For more information on how to enable\n trusted access with the Amazon Web Services CLI and Amazon Web Services SDKs, see Using\n Organizations with other Amazon Web Services services in the\n Amazon Web Services Organizations User Guide.
Only one report per organization can be generated at a time. Attempting to\n generate a report while another is in progress will result in an error.
\nFor more information, including the required IAM permissions to run this API, see\n Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.
" + "smithy.api#documentation": "Generates an account status report. The report is generated asynchronously, and can\n take several hours to complete.
\nThe report provides the current status of all attributes supported by declarative\n policies for the accounts within the specified scope. The scope is determined by the\n specified TargetId
, which can represent an individual account, or all the\n accounts that fall under the specified organizational unit (OU) or root (the entire\n Amazon Web Services Organization).
The report is saved to your specified S3 bucket, using the following path structure\n (with the italicized placeholders representing your specific\n values):
\n\n s3://amzn-s3-demo-bucket/your-optional-s3-prefix/ec2_targetId_reportId_yyyyMMddThhmmZ.csv
\n
\n Prerequisites for generating a report\n
\nThe StartDeclarativePoliciesReport
API can only be called by the\n management account or delegated administrators for the organization.
An S3 bucket must be available before generating the report (you can create a\n new one or use an existing one), it must be in the same Region where the report\n generation request is made, and it must have an appropriate bucket policy. For a\n sample S3 policy, see Sample Amazon S3 policy under .
\nTrusted access must be enabled for the service for which the declarative\n policy will enforce a baseline configuration. If you use the Amazon Web Services Organizations\n console, this is done automatically when you enable declarative policies. The\n API uses the following service principal to identify the EC2 service:\n ec2.amazonaws.com
. For more information on how to enable\n trusted access with the Amazon Web Services CLI and Amazon Web Services SDKs, see Using\n Organizations with other Amazon Web Services services in the\n Amazon Web Services Organizations User Guide.
Only one report per organization can be generated at a time. Attempting to\n generate a report while another is in progress will result in an error.
\nFor more information, including the required IAM permissions to run this API, see\n Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.
" } }, "com.amazonaws.ec2#StartDeclarativePoliciesReportRequest": { @@ -102753,7 +102777,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the S3 bucket where the report will be saved.
", + "smithy.api#documentation": "The name of the S3 bucket where the report will be saved. The bucket must be in the\n same Region where the report generation request is made.
", "smithy.api#required": {} } }, From ce39697db7d1c6fe63b9e987cdb048c989c8d2ab Mon Sep 17 00:00:00 2001 From: awstoolsA network CIDR that can contain hybrid nodes.
+ *These CIDR blocks define the expected IP address range of the hybrid nodes that join + * the cluster. These blocks are typically determined by your network administrator.
+ *Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,
+ * 10.2.0.0/16
).
It must satisfy the following requirements:
+ *Each block must be within an IPv4
RFC-1918 network range. Minimum
+ * allowed size is /24, maximum allowed size is /8. Publicly-routable addresses
+ * aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS + * resources, or the block of the Kubernetes service IP range.
+ *Each block must have a route to the VPC that uses the VPC CIDR blocks, not + * public IPs or Elastic IPs. There are many options including Transit Gateway, + * Site-to-Site VPN, or Direct Connect.
+ *Each host must allow outbound connection to the EKS cluster control plane on
+ * TCP ports 443
and 10250
.
Each host must allow inbound connection from the EKS cluster control plane on + * TCP port 10250 for logs, exec and port-forward operations.
+ * Each host must allow TCP and UDP network connectivity to and from other hosts
+ * that are running CoreDNS
on UDP port 53
for service and pod DNS
+ * names.
A network CIDR that can contain hybrid nodes.
+ *These CIDR blocks define the expected IP address range of the hybrid nodes that join + * the cluster. These blocks are typically determined by your network administrator.
+ *Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,
+ * 10.2.0.0/16
).
It must satisfy the following requirements:
+ *Each block must be within an IPv4
RFC-1918 network range. Minimum
+ * allowed size is /24, maximum allowed size is /8. Publicly-routable addresses
+ * aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS + * resources, or the block of the Kubernetes service IP range.
+ *Each block must have a route to the VPC that uses the VPC CIDR blocks, not + * public IPs or Elastic IPs. There are many options including Transit Gateway, + * Site-to-Site VPN, or Direct Connect.
+ *Each host must allow outbound connection to the EKS cluster control plane on
+ * TCP ports 443
and 10250
.
Each host must allow inbound connection from the EKS cluster control plane on + * TCP port 10250 for logs, exec and port-forward operations.
+ * Each host must allow TCP and UDP network connectivity to and from other hosts
+ * that are running CoreDNS
on UDP port 53
for service and pod DNS
+ * names.
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
+ *These CIDR blocks are determined by configuring your Container Network Interface (CNI) + * plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't + * available for on-premises and edge locations.
+ *Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,
+ * 10.2.0.0/16
).
It must satisfy the following requirements:
+ *Each block must be within an IPv4
RFC-1918 network range. Minimum
+ * allowed size is /24, maximum allowed size is /8. Publicly-routable addresses
+ * aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS + * resources, or the block of the Kubernetes service IP range.
+ *A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
+ *These CIDR blocks are determined by configuring your Container Network Interface (CNI) + * plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't + * available for on-premises and edge locations.
+ *Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,
+ * 10.2.0.0/16
).
It must satisfy the following requirements:
+ *Each block must be within an IPv4
RFC-1918 network range. Minimum
+ * allowed size is /24, maximum allowed size is /8. Publicly-routable addresses
+ * aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS + * resources, or the block of the Kubernetes service IP range.
+ *The list of network CIDRs that can contain hybrid nodes.
+ *These CIDR blocks define the expected IP address range of the hybrid nodes that join + * the cluster. These blocks are typically determined by your network administrator.
+ *Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,
+ * 10.2.0.0/16
).
It must satisfy the following requirements:
+ *Each block must be within an IPv4
RFC-1918 network range. Minimum
+ * allowed size is /24, maximum allowed size is /8. Publicly-routable addresses
+ * aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS + * resources, or the block of the Kubernetes service IP range.
+ *Each block must have a route to the VPC that uses the VPC CIDR blocks, not + * public IPs or Elastic IPs. There are many options including Transit Gateway, + * Site-to-Site VPN, or Direct Connect.
+ *Each host must allow outbound connection to the EKS cluster control plane on
+ * TCP ports 443
and 10250
.
Each host must allow inbound connection from the EKS cluster control plane on + * TCP port 10250 for logs, exec and port-forward operations.
+ * Each host must allow TCP and UDP network connectivity to and from other hosts
+ * that are running CoreDNS
on UDP port 53
for service and pod DNS
+ * names.
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
+ *These CIDR blocks are determined by configuring your Container Network Interface (CNI) + * plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't + * available for on-premises and edge locations.
+ *Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example,
+ * 10.2.0.0/16
).
It must satisfy the following requirements:
+ *Each block must be within an IPv4
RFC-1918 network range. Minimum
+ * allowed size is /24, maximum allowed size is /8. Publicly-routable addresses
+ * aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS + * resources, or the block of the Kubernetes service IP range.
+ *The node auto repair configuration for the node group.
+ * @public + */ +export interface NodeRepairConfig { + /** + *Specifies whether to enable node auto repair for the node group. Node auto repair is + * disabled by default.
+ * @public + */ + enabled?: boolean | undefined; +} + /** *An object representing the remote access configuration for the managed node * group.
@@ -3712,6 +3879,12 @@ export interface CreateNodegroupRequest { */ updateConfig?: NodegroupUpdateConfig | undefined; + /** + *The node auto repair configuration for the node group.
+ * @public + */ + nodeRepairConfig?: NodeRepairConfig | undefined; + /** *The capacity type for your node group.
* @public @@ -4127,6 +4300,12 @@ export interface Nodegroup { */ updateConfig?: NodegroupUpdateConfig | undefined; + /** + *The node auto repair configuration for the node group.
+ * @public + */ + nodeRepairConfig?: NodeRepairConfig | undefined; + /** *If a launch template was used to create the node group, then this is the launch * template that was used.
@@ -7011,6 +7190,12 @@ export interface UpdateNodegroupConfigRequest { */ updateConfig?: NodegroupUpdateConfig | undefined; + /** + *The node auto repair configuration for the node group.
+ * @public + */ + nodeRepairConfig?: NodeRepairConfig | undefined; + /** *A unique, case-sensitive identifier that you provide to ensure * the idempotency of the request.
diff --git a/clients/client-eks/src/protocols/Aws_restJson1.ts b/clients/client-eks/src/protocols/Aws_restJson1.ts index f804f45912a3..8616d4036c3c 100644 --- a/clients/client-eks/src/protocols/Aws_restJson1.ts +++ b/clients/client-eks/src/protocols/Aws_restJson1.ts @@ -214,6 +214,7 @@ import { Nodegroup, NodegroupScalingConfig, NodegroupUpdateConfig, + NodeRepairConfig, NotFoundException, OidcIdentityProviderConfigRequest, OutpostConfigRequest, @@ -490,6 +491,7 @@ export const se_CreateNodegroupCommand = async ( instanceTypes: (_) => _json(_), labels: (_) => _json(_), launchTemplate: (_) => _json(_), + nodeRepairConfig: (_) => _json(_), nodeRole: [], nodegroupName: [], releaseVersion: [], @@ -1418,6 +1420,7 @@ export const se_UpdateNodegroupConfigCommand = async ( take(input, { clientRequestToken: [true, (_) => _ ?? generateIdempotencyToken()], labels: (_) => _json(_), + nodeRepairConfig: (_) => _json(_), scalingConfig: (_) => _json(_), taints: (_) => _json(_), updateConfig: (_) => _json(_), @@ -3058,6 +3061,8 @@ const de_UnsupportedAvailabilityZoneExceptionRes = async ( // se_NodegroupUpdateConfig omitted. +// se_NodeRepairConfig omitted. + // se_OidcIdentityProviderConfigRequest omitted. // se_OutpostConfigRequest omitted. @@ -3489,6 +3494,7 @@ const de_Nodegroup = (output: any, context: __SerdeContext): Nodegroup => { labels: _json, launchTemplate: _json, modifiedAt: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + nodeRepairConfig: _json, nodeRole: __expectString, nodegroupArn: __expectString, nodegroupName: __expectString, @@ -3513,6 +3519,8 @@ const de_Nodegroup = (output: any, context: __SerdeContext): Nodegroup => { // de_NodegroupUpdateConfig omitted. +// de_NodeRepairConfig omitted. + // de_OIDC omitted. // de_OidcIdentityProviderConfig omitted. diff --git a/codegen/sdk-codegen/aws-models/eks.json b/codegen/sdk-codegen/aws-models/eks.json index 6124a3b58443..778c4d3db9ac 100644 --- a/codegen/sdk-codegen/aws-models/eks.json +++ b/codegen/sdk-codegen/aws-models/eks.json @@ -3838,6 +3838,12 @@ "smithy.api#documentation": "The node group update configuration.
" } }, + "nodeRepairConfig": { + "target": "com.amazonaws.eks#NodeRepairConfig", + "traits": { + "smithy.api#documentation": "The node auto repair configuration for the node group.
" + } + }, "capacityType": { "target": "com.amazonaws.eks#CapacityTypes", "traits": { @@ -8387,6 +8393,20 @@ "smithy.api#documentation": "Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.
" } }, + "com.amazonaws.eks#NodeRepairConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable node auto repair for the node group. Node auto repair is \n disabled by default.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The node auto repair configuration for the node group.
" + } + }, "com.amazonaws.eks#Nodegroup": { "type": "structure", "members": { @@ -8516,6 +8536,12 @@ "smithy.api#documentation": "The node group update configuration.
" } }, + "nodeRepairConfig": { + "target": "com.amazonaws.eks#NodeRepairConfig", + "traits": { + "smithy.api#documentation": "The node auto repair configuration for the node group.
" + } + }, "launchTemplate": { "target": "com.amazonaws.eks#LaunchTemplateSpecification", "traits": { @@ -9370,13 +9396,13 @@ "remoteNodeNetworks": { "target": "com.amazonaws.eks#RemoteNodeNetworkList", "traits": { - "smithy.api#documentation": "The list of network CIDRs that can contain hybrid nodes.
" + "smithy.api#documentation": "The list of network CIDRs that can contain hybrid nodes.
\nThese CIDR blocks define the expected IP address range of the hybrid nodes that join\n the cluster. These blocks are typically determined by your network administrator.
\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16
).
It must satisfy the following requirements:
\nEach block must be within an IPv4
RFC-1918 network range. Minimum\n allowed size is /24, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.
\nEach block must have a route to the VPC that uses the VPC CIDR blocks, not\n public IPs or Elastic IPs. There are many options including Transit Gateway,\n Site-to-Site VPN, or Direct Connect.
\nEach host must allow outbound connection to the EKS cluster control plane on\n TCP ports 443
and 10250
.
Each host must allow inbound connection from the EKS cluster control plane on\n TCP port 10250 for logs, exec and port-forward operations.
\n Each host must allow TCP and UDP network connectivity to and from other hosts\n that are running CoreDNS
on UDP port 53
for service and pod DNS\n names.
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
" + "smithy.api#documentation": "The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
\nThese CIDR blocks are determined by configuring your Container Network Interface (CNI)\n plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\n available for on-premises and edge locations.
\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16
).
It must satisfy the following requirements:
\nEach block must be within an IPv4
RFC-1918 network range. Minimum\n allowed size is /24, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.
\nA network CIDR that can contain hybrid nodes.
" + "smithy.api#documentation": "A network CIDR that can contain hybrid nodes.
\nThese CIDR blocks define the expected IP address range of the hybrid nodes that join\n the cluster. These blocks are typically determined by your network administrator.
\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16
).
It must satisfy the following requirements:
\nEach block must be within an IPv4
RFC-1918 network range. Minimum\n allowed size is /24, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.
\nEach block must have a route to the VPC that uses the VPC CIDR blocks, not\n public IPs or Elastic IPs. There are many options including Transit Gateway,\n Site-to-Site VPN, or Direct Connect.
\nEach host must allow outbound connection to the EKS cluster control plane on\n TCP ports 443
and 10250
.
Each host must allow inbound connection from the EKS cluster control plane on\n TCP port 10250 for logs, exec and port-forward operations.
\n Each host must allow TCP and UDP network connectivity to and from other hosts\n that are running CoreDNS
on UDP port 53
for service and pod DNS\n names.
A network CIDR that can contain hybrid nodes.
" + "smithy.api#documentation": "A network CIDR that can contain hybrid nodes.
\nThese CIDR blocks define the expected IP address range of the hybrid nodes that join\n the cluster. These blocks are typically determined by your network administrator.
\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16
).
It must satisfy the following requirements:
\nEach block must be within an IPv4
RFC-1918 network range. Minimum\n allowed size is /24, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.
\nEach block must have a route to the VPC that uses the VPC CIDR blocks, not\n public IPs or Elastic IPs. There are many options including Transit Gateway,\n Site-to-Site VPN, or Direct Connect.
\nEach host must allow outbound connection to the EKS cluster control plane on\n TCP ports 443
and 10250
.
Each host must allow inbound connection from the EKS cluster control plane on\n TCP port 10250 for logs, exec and port-forward operations.
\n Each host must allow TCP and UDP network connectivity to and from other hosts\n that are running CoreDNS
on UDP port 53
for service and pod DNS\n names.
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
" + "smithy.api#documentation": "A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
\nThese CIDR blocks are determined by configuring your Container Network Interface (CNI)\n plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\n available for on-premises and edge locations.
\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16
).
It must satisfy the following requirements:
\nEach block must be within an IPv4
RFC-1918 network range. Minimum\n allowed size is /24, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.
\nA network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
" + "smithy.api#documentation": "A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
\nThese CIDR blocks are determined by configuring your Container Network Interface (CNI)\n plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't\n available for on-premises and edge locations.
\nEnter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, \n 10.2.0.0/16
).
It must satisfy the following requirements:
\nEach block must be within an IPv4
RFC-1918 network range. Minimum\n allowed size is /24, maximum allowed size is /8. Publicly-routable addresses\n aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS\n resources, or the block of the Kubernetes service IP range.
\nThe node group update configuration.
" } }, + "nodeRepairConfig": { + "target": "com.amazonaws.eks#NodeRepairConfig", + "traits": { + "smithy.api#documentation": "The node auto repair configuration for the node group.
" + } + }, "clientRequestToken": { "target": "com.amazonaws.eks#String", "traits": { @@ -10889,6 +10921,12 @@ "smithy.api#enumValue": "MaxUnavailablePercentage" } }, + "NODE_REPAIR_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeRepairEnabled" + } + }, "CONFIGURATION_VALUES": { "target": "smithy.api#Unit", "traits": { From b525bd5452778a5928e2dad11d60a6f1082bbe94 Mon Sep 17 00:00:00 2001 From: awstoolsDeletes specific attributes associated with a service.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, DeleteServiceAttributesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, DeleteServiceAttributesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const input = { // DeleteServiceAttributesRequest + * ServiceId: "STRING_VALUE", // required + * Attributes: [ // ServiceAttributeKeyList // required + * "STRING_VALUE", + * ], + * }; + * const command = new DeleteServiceAttributesCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteServiceAttributesCommandInput - {@link DeleteServiceAttributesCommandInput} + * @returns {@link DeleteServiceAttributesCommandOutput} + * @see {@link DeleteServiceAttributesCommandInput} for command's `input` shape. + * @see {@link DeleteServiceAttributesCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape. + * + * @throws {@link InvalidInput} (client fault) + *One or more specified values aren't valid. For example, a required value might be missing, a numeric value + * might be outside the allowed range, or a string value might exceed length constraints.
+ * + * @throws {@link ServiceNotFound} (client fault) + *No service exists with the specified ID.
+ * + * @throws {@link ServiceDiscoveryServiceException} + *Base exception class for all service exceptions from ServiceDiscovery service.
+ * + * @public + */ +export class DeleteServiceAttributesCommand extends $Command + .classBuilder< + DeleteServiceAttributesCommandInput, + DeleteServiceAttributesCommandOutput, + ServiceDiscoveryClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ServiceDiscoveryClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Route53AutoNaming_v20170314", "DeleteServiceAttributes", {}) + .n("ServiceDiscoveryClient", "DeleteServiceAttributesCommand") + .f(void 0, void 0) + .ser(se_DeleteServiceAttributesCommand) + .de(de_DeleteServiceAttributesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteServiceAttributesRequest; + output: {}; + }; + sdk: { + input: DeleteServiceAttributesCommandInput; + output: DeleteServiceAttributesCommandOutput; + }; + }; +} diff --git a/clients/client-servicediscovery/src/commands/DeleteServiceCommand.ts b/clients/client-servicediscovery/src/commands/DeleteServiceCommand.ts index 879b3a74aaa8..48d3fcda89b9 100644 --- a/clients/client-servicediscovery/src/commands/DeleteServiceCommand.ts +++ b/clients/client-servicediscovery/src/commands/DeleteServiceCommand.ts @@ -28,7 +28,7 @@ export interface DeleteServiceCommandInput extends DeleteServiceRequest {} export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __MetadataBearer {} /** - *Deletes a specified service. If the service still contains one or more registered instances, the request + *
Deletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request * fails.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-servicediscovery/src/commands/GetServiceAttributesCommand.ts b/clients/client-servicediscovery/src/commands/GetServiceAttributesCommand.ts new file mode 100644 index 000000000000..c468cd49a68c --- /dev/null +++ b/clients/client-servicediscovery/src/commands/GetServiceAttributesCommand.ts @@ -0,0 +1,104 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetServiceAttributesRequest, GetServiceAttributesResponse } from "../models/models_0"; +import { de_GetServiceAttributesCommand, se_GetServiceAttributesCommand } from "../protocols/Aws_json1_1"; +import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetServiceAttributesCommand}. + */ +export interface GetServiceAttributesCommandInput extends GetServiceAttributesRequest {} +/** + * @public + * + * The output of {@link GetServiceAttributesCommand}. + */ +export interface GetServiceAttributesCommandOutput extends GetServiceAttributesResponse, __MetadataBearer {} + +/** + *Returns the attributes associated with a specified service.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, GetServiceAttributesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, GetServiceAttributesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const input = { // GetServiceAttributesRequest + * ServiceId: "STRING_VALUE", // required + * }; + * const command = new GetServiceAttributesCommand(input); + * const response = await client.send(command); + * // { // GetServiceAttributesResponse + * // ServiceAttributes: { // ServiceAttributes + * // ServiceArn: "STRING_VALUE", + * // Attributes: { // ServiceAttributesMap + * // "One or more specified values aren't valid. For example, a required value might be missing, a numeric value + * might be outside the allowed range, or a string value might exceed length constraints.
+ * + * @throws {@link ServiceNotFound} (client fault) + *No service exists with the specified ID.
+ * + * @throws {@link ServiceDiscoveryServiceException} + *Base exception class for all service exceptions from ServiceDiscovery service.
+ * + * @public + */ +export class GetServiceAttributesCommand extends $Command + .classBuilder< + GetServiceAttributesCommandInput, + GetServiceAttributesCommandOutput, + ServiceDiscoveryClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ServiceDiscoveryClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Route53AutoNaming_v20170314", "GetServiceAttributes", {}) + .n("ServiceDiscoveryClient", "GetServiceAttributesCommand") + .f(void 0, void 0) + .ser(se_GetServiceAttributesCommand) + .de(de_GetServiceAttributesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetServiceAttributesRequest; + output: GetServiceAttributesResponse; + }; + sdk: { + input: GetServiceAttributesCommandInput; + output: GetServiceAttributesCommandOutput; + }; + }; +} diff --git a/clients/client-servicediscovery/src/commands/UpdateServiceAttributesCommand.ts b/clients/client-servicediscovery/src/commands/UpdateServiceAttributesCommand.ts new file mode 100644 index 000000000000..223e27c39dbb --- /dev/null +++ b/clients/client-servicediscovery/src/commands/UpdateServiceAttributesCommand.ts @@ -0,0 +1,103 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateServiceAttributesRequest, UpdateServiceAttributesResponse } from "../models/models_0"; +import { de_UpdateServiceAttributesCommand, se_UpdateServiceAttributesCommand } from "../protocols/Aws_json1_1"; +import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateServiceAttributesCommand}. + */ +export interface UpdateServiceAttributesCommandInput extends UpdateServiceAttributesRequest {} +/** + * @public + * + * The output of {@link UpdateServiceAttributesCommand}. + */ +export interface UpdateServiceAttributesCommandOutput extends UpdateServiceAttributesResponse, __MetadataBearer {} + +/** + *Submits a request to update a specified service to add service-level attributes.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, UpdateServiceAttributesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, UpdateServiceAttributesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const input = { // UpdateServiceAttributesRequest + * ServiceId: "STRING_VALUE", // required + * Attributes: { // ServiceAttributesMap // required + * "One or more specified values aren't valid. For example, a required value might be missing, a numeric value + * might be outside the allowed range, or a string value might exceed length constraints.
+ * + * @throws {@link ServiceAttributesLimitExceededException} (client fault) + *The attribute can't be added to the service because you've exceeded the quota for the number of attributes you can add to a service.
+ * + * @throws {@link ServiceNotFound} (client fault) + *No service exists with the specified ID.
+ * + * @throws {@link ServiceDiscoveryServiceException} + *Base exception class for all service exceptions from ServiceDiscovery service.
+ * + * @public + */ +export class UpdateServiceAttributesCommand extends $Command + .classBuilder< + UpdateServiceAttributesCommandInput, + UpdateServiceAttributesCommandOutput, + ServiceDiscoveryClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ServiceDiscoveryClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Route53AutoNaming_v20170314", "UpdateServiceAttributes", {}) + .n("ServiceDiscoveryClient", "UpdateServiceAttributesCommand") + .f(void 0, void 0) + .ser(se_UpdateServiceAttributesCommand) + .de(de_UpdateServiceAttributesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateServiceAttributesRequest; + output: {}; + }; + sdk: { + input: UpdateServiceAttributesCommandInput; + output: UpdateServiceAttributesCommandOutput; + }; + }; +} diff --git a/clients/client-servicediscovery/src/commands/index.ts b/clients/client-servicediscovery/src/commands/index.ts index d043c7303815..89447615281c 100644 --- a/clients/client-servicediscovery/src/commands/index.ts +++ b/clients/client-servicediscovery/src/commands/index.ts @@ -4,6 +4,7 @@ export * from "./CreatePrivateDnsNamespaceCommand"; export * from "./CreatePublicDnsNamespaceCommand"; export * from "./CreateServiceCommand"; export * from "./DeleteNamespaceCommand"; +export * from "./DeleteServiceAttributesCommand"; export * from "./DeleteServiceCommand"; export * from "./DeregisterInstanceCommand"; export * from "./DiscoverInstancesCommand"; @@ -12,6 +13,7 @@ export * from "./GetInstanceCommand"; export * from "./GetInstancesHealthStatusCommand"; export * from "./GetNamespaceCommand"; export * from "./GetOperationCommand"; +export * from "./GetServiceAttributesCommand"; export * from "./GetServiceCommand"; export * from "./ListInstancesCommand"; export * from "./ListNamespacesCommand"; @@ -25,4 +27,5 @@ export * from "./UpdateHttpNamespaceCommand"; export * from "./UpdateInstanceCustomHealthStatusCommand"; export * from "./UpdatePrivateDnsNamespaceCommand"; export * from "./UpdatePublicDnsNamespaceCommand"; +export * from "./UpdateServiceAttributesCommand"; export * from "./UpdateServiceCommand"; diff --git a/clients/client-servicediscovery/src/models/models_0.ts b/clients/client-servicediscovery/src/models/models_0.ts index e6eb0c8bb38b..62c771754c28 100644 --- a/clients/client-servicediscovery/src/models/models_0.ts +++ b/clients/client-servicediscovery/src/models/models_0.ts @@ -574,10 +574,6 @@ export type RoutingPolicy = (typeof RoutingPolicy)[keyof typeof RoutingPolicy]; /** *A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create * when you register an instance.
- *The record types of a service can only be changed by deleting the service and recreating it with a new
- * Dnsconfig
.
An array that contains one DnsRecord
object for each Route 53 DNS record that you want Cloud Map
* to create when you register an instance.
The record type of a service specified in a DnsRecord
object can't be updated. To change a record type, you need to delete the service and recreate it with a new
+ * DnsConfig
.
The ID of the service from which the attributes will be deleted.
+ * @public + */ + ServiceId: string | undefined; + + /** + *A list of keys corresponding to each attribute that you want to delete.
+ * @public + */ + Attributes: string[] | undefined; +} + +/** + * @public + */ +export interface DeleteServiceAttributesResponse {} + /** * @public */ @@ -2230,6 +2252,56 @@ export interface GetServiceResponse { Service?: Service | undefined; } +/** + * @public + */ +export interface GetServiceAttributesRequest { + /** + *The ID of the service that you want to get attributes for.
+ * @public + */ + ServiceId: string | undefined; +} + +/** + *A complex type that contains information about attributes associated with a specific service.
+ * @public + */ +export interface ServiceAttributes { + /** + *The ARN of the service that the attributes are associated with.
+ * @public + */ + ServiceArn?: string | undefined; + + /** + *A string map that contains the following information for the service that you specify in
+ * ServiceArn
:
The attributes that apply to the service.
+ *For each attribute, the applicable value.
+ *You can specify a total of 30 attributes.
+ * @public + */ + Attributes?: RecordA complex type that contains the service ARN and a list of attribute key-value pairs associated with the service.
+ * @public + */ + ServiceAttributes?: ServiceAttributes | undefined; +} + /** *Updated properties for the HTTP * namespace.
@@ -3548,7 +3620,7 @@ export interface UpdateServiceRequest { Id: string | undefined; /** - *A complex type that contains the new settings for the service.
+ *A complex type that contains the new settings for the service. You can specify a maximum of 30 attributes (key-value pairs).
* @public */ Service: ServiceChange | undefined; @@ -3565,3 +3637,47 @@ export interface UpdateServiceResponse { */ OperationId?: string | undefined; } + +/** + *The attribute can't be added to the service because you've exceeded the quota for the number of attributes you can add to a service.
+ * @public + */ +export class ServiceAttributesLimitExceededException extends __BaseException { + readonly name: "ServiceAttributesLimitExceededException" = "ServiceAttributesLimitExceededException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe ID of the service that you want to update.
+ * @public + */ + ServiceId: string | undefined; + + /** + *A string map that contains attribute key-value pairs.
+ * @public + */ + Attributes: RecordDeletes a specified service. If the service still contains one or more registered instances, the request\n fails.
", + "smithy.api#documentation": "Deletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request\n fails.
", "smithy.api#examples": [ { "title": "Example: Delete service", @@ -649,6 +649,66 @@ ] } }, + "com.amazonaws.servicediscovery#DeleteServiceAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicediscovery#DeleteServiceAttributesRequest" + }, + "output": { + "target": "com.amazonaws.servicediscovery#DeleteServiceAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicediscovery#InvalidInput" + }, + { + "target": "com.amazonaws.servicediscovery#ServiceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Deletes specific attributes associated with a service.
", + "smithy.api#examples": [ + { + "title": "DeleteServiceAttributes example", + "documentation": "Example: Delete service attribute by providing attribute key and service ID", + "input": { + "Attributes": ["port"], + "ServiceId": "srv-e4anhexample0004" + }, + "output": {} + } + ] + } + }, + "com.amazonaws.servicediscovery#DeleteServiceAttributesRequest": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the service from which the attributes will be deleted.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.servicediscovery#ServiceAttributeKeyList", + "traits": { + "smithy.api#documentation": "A list of keys corresponding to each attribute that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.servicediscovery#DeleteServiceAttributesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.servicediscovery#DeleteServiceRequest": { "type": "structure", "members": { @@ -978,13 +1038,13 @@ "DnsRecords": { "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { - "smithy.api#documentation": "An array that contains one DnsRecord
object for each Route 53 DNS record that you want Cloud Map\n to create when you register an instance.
An array that contains one DnsRecord
object for each Route 53 DNS record that you want Cloud Map\n to create when you register an instance.
The record type of a service specified in a DnsRecord
object can't be updated. To change a record type, you need to delete the service and recreate it with a new\n DnsConfig
.
A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
\nThe record types of a service can only be changed by deleting the service and recreating it with a new\n Dnsconfig
.
A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create\n when you register an instance.
" } }, "com.amazonaws.servicediscovery#DnsConfigChange": { @@ -1444,6 +1504,72 @@ "smithy.api#documentation": "Gets the settings for a specified service.
" } }, + "com.amazonaws.servicediscovery#GetServiceAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicediscovery#GetServiceAttributesRequest" + }, + "output": { + "target": "com.amazonaws.servicediscovery#GetServiceAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicediscovery#InvalidInput" + }, + { + "target": "com.amazonaws.servicediscovery#ServiceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns the attributes associated with a specified service.
", + "smithy.api#examples": [ + { + "title": "GetServiceAttributes Example", + "documentation": "This example gets the attributes for a specified service.", + "input": { + "ServiceId": "srv-e4anhexample0004" + }, + "output": { + "ServiceAttributes": { + "Attributes": { + "port": "80" + }, + "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004" + } + } + } + ] + } + }, + "com.amazonaws.servicediscovery#GetServiceAttributesRequest": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the service that you want to get attributes for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.servicediscovery#GetServiceAttributesResponse": { + "type": "structure", + "members": { + "ServiceAttributes": { + "target": "com.amazonaws.servicediscovery#ServiceAttributes", + "traits": { + "smithy.api#documentation": "A complex type that contains the service ARN and a list of attribute key-value pairs associated with the service.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.servicediscovery#GetServiceRequest": { "type": "structure", "members": { @@ -2421,7 +2547,8 @@ "smithy.api#length": { "min": 0, "max": 1024 - } + }, + "smithy.api#pattern": "^[!-~]{1,1024}$" } }, "com.amazonaws.servicediscovery#NamespaceNameHttp": { @@ -3264,6 +3391,9 @@ { "target": "com.amazonaws.servicediscovery#DeleteService" }, + { + "target": "com.amazonaws.servicediscovery#DeleteServiceAttributes" + }, { "target": "com.amazonaws.servicediscovery#DeregisterInstance" }, @@ -3288,6 +3418,9 @@ { "target": "com.amazonaws.servicediscovery#GetService" }, + { + "target": "com.amazonaws.servicediscovery#GetServiceAttributes" + }, { "target": "com.amazonaws.servicediscovery#ListInstances" }, @@ -3326,6 +3459,9 @@ }, { "target": "com.amazonaws.servicediscovery#UpdateService" + }, + { + "target": "com.amazonaws.servicediscovery#UpdateServiceAttributes" } ], "traits": { @@ -4537,6 +4673,84 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.servicediscovery#ServiceAttributeKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.servicediscovery#ServiceAttributeKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.servicediscovery#ServiceAttributeKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.servicediscovery#ServiceAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.servicediscovery#ServiceAttributes": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.servicediscovery#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the service that the attributes are associated with.
" + } + }, + "Attributes": { + "target": "com.amazonaws.servicediscovery#ServiceAttributesMap", + "traits": { + "smithy.api#documentation": "A string map that contains the following information for the service that you specify in\n ServiceArn
:
The attributes that apply to the service.
\nFor each attribute, the applicable value.
\nYou can specify a total of 30 attributes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about attributes associated with a specific service.
" + } + }, + "com.amazonaws.servicediscovery#ServiceAttributesLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.servicediscovery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The attribute can't be added to the service because you've exceeded the quota for the number of attributes you can add to a service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.servicediscovery#ServiceAttributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.servicediscovery#ServiceAttributeKey" + }, + "value": { + "target": "com.amazonaws.servicediscovery#ServiceAttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, "com.amazonaws.servicediscovery#ServiceChange": { "type": "structure", "members": { @@ -5324,6 +5538,71 @@ ] } }, + "com.amazonaws.servicediscovery#UpdateServiceAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicediscovery#UpdateServiceAttributesRequest" + }, + "output": { + "target": "com.amazonaws.servicediscovery#UpdateServiceAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicediscovery#InvalidInput" + }, + { + "target": "com.amazonaws.servicediscovery#ServiceAttributesLimitExceededException" + }, + { + "target": "com.amazonaws.servicediscovery#ServiceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Submits a request to update a specified service to add service-level attributes.
", + "smithy.api#examples": [ + { + "title": "UpdateServiceAttributes Example", + "documentation": "This example submits a request to update the specified service to add a port attribute with the value 80.", + "input": { + "ServiceId": "srv-e4anhexample0004", + "Attributes": { + "port": "80" + } + }, + "output": {} + } + ] + } + }, + "com.amazonaws.servicediscovery#UpdateServiceAttributesRequest": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the service that you want to update.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.servicediscovery#ServiceAttributesMap", + "traits": { + "smithy.api#documentation": "A string map that contains attribute key-value pairs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.servicediscovery#UpdateServiceAttributesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.servicediscovery#UpdateServiceRequest": { "type": "structure", "members": { @@ -5337,7 +5616,7 @@ "Service": { "target": "com.amazonaws.servicediscovery#ServiceChange", "traits": { - "smithy.api#documentation": "A complex type that contains the new settings for the service.
", + "smithy.api#documentation": "A complex type that contains the new settings for the service. You can specify a maximum of 30 attributes (key-value pairs).
", "smithy.api#required": {} } } From 6e1313e0a487dee75340db1d5330ec657d85d045 Mon Sep 17 00:00:00 2001 From: awstoolsOne or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations
is only used for Direct Connect gateway attachments. Do
One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations
is only used for Direct Connect gateway attachments.
One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations
is only used for Direct Connect gateway attachments. Do
One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations
is only used for Direct Connect gateway attachments.