aws-sdk 2.1409.0 → 2.1411.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -1
- package/README.md +1 -1
- package/apis/batch-2016-08-10.min.json +58 -45
- package/apis/kms-2014-11-01.min.json +57 -15
- package/apis/mgn-2020-02-26.min.json +274 -130
- package/apis/mgn-2020-02-26.paginators.json +6 -0
- package/apis/sagemaker-2017-07-24.min.json +566 -561
- package/clients/batch.d.ts +23 -11
- package/clients/comprehendmedical.d.ts +46 -46
- package/clients/connect.d.ts +11 -11
- package/clients/kms.d.ts +58 -2
- package/clients/mgn.d.ts +275 -7
- package/clients/sagemaker.d.ts +18 -11
- package/clients/securityhub.d.ts +19 -19
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +6 -6
- package/dist/aws-sdk.js +60 -18
- package/dist/aws-sdk.min.js +43 -43
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/batch.d.ts
CHANGED
@@ -12,19 +12,19 @@ declare class Batch extends Service {
|
|
12
12
|
constructor(options?: Batch.Types.ClientConfiguration)
|
13
13
|
config: Config & Batch.Types.ClientConfiguration;
|
14
14
|
/**
|
15
|
-
* Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED. Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.
|
15
|
+
* Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED. A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status. When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed. Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.
|
16
16
|
*/
|
17
17
|
cancelJob(params: Batch.Types.CancelJobRequest, callback?: (err: AWSError, data: Batch.Types.CancelJobResponse) => void): Request<Batch.Types.CancelJobResponse, AWSError>;
|
18
18
|
/**
|
19
|
-
* Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED. Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.
|
19
|
+
* Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED. A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status. When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed. Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.
|
20
20
|
*/
|
21
21
|
cancelJob(callback?: (err: AWSError, data: Batch.Types.CancelJobResponse) => void): Request<Batch.Types.CancelJobResponse, AWSError>;
|
22
22
|
/**
|
23
|
-
* Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price. Multi-node parallel jobs aren't supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster. Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the earlier compute environment from your job queue. Delete the earlier compute environment. In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules: Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role. Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED. Set the update to latest image version (updateToLatestImageVersion) parameter to true. Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest). If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.
|
23
|
+
* Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price. Multi-node parallel jobs aren't supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster. Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the earlier compute environment from your job queue. Delete the earlier compute environment. In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules: Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role. Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED. Set the update to latest image version (updateToLatestImageVersion) parameter to true. The updateToLatestImageVersion parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment. Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest). If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.
|
24
24
|
*/
|
25
25
|
createComputeEnvironment(params: Batch.Types.CreateComputeEnvironmentRequest, callback?: (err: AWSError, data: Batch.Types.CreateComputeEnvironmentResponse) => void): Request<Batch.Types.CreateComputeEnvironmentResponse, AWSError>;
|
26
26
|
/**
|
27
|
-
* Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price. Multi-node parallel jobs aren't supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster. Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the earlier compute environment from your job queue. Delete the earlier compute environment. In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules: Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role. Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED. Set the update to latest image version (updateToLatestImageVersion) parameter to true. Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest). If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.
|
27
|
+
* Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price. Multi-node parallel jobs aren't supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster. Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the earlier compute environment from your job queue. Delete the earlier compute environment. In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules: Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role. Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED. Set the update to latest image version (updateToLatestImageVersion) parameter to true. The updateToLatestImageVersion parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment. Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest). If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.
|
28
28
|
*/
|
29
29
|
createComputeEnvironment(callback?: (err: AWSError, data: Batch.Types.CreateComputeEnvironmentResponse) => void): Request<Batch.Types.CreateComputeEnvironmentResponse, AWSError>;
|
30
30
|
/**
|
@@ -386,15 +386,15 @@ declare namespace Batch {
|
|
386
386
|
*/
|
387
387
|
allocationStrategy?: CRAllocationStrategy;
|
388
388
|
/**
|
389
|
-
* The minimum number of
|
389
|
+
* The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is DISABLED). This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
|
390
390
|
*/
|
391
391
|
minvCpus?: Integer;
|
392
392
|
/**
|
393
|
-
* The maximum number of
|
393
|
+
* The maximum number of vCPUs that a compute environment can support. With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.
|
394
394
|
*/
|
395
395
|
maxvCpus: Integer;
|
396
396
|
/**
|
397
|
-
* The desired number of
|
397
|
+
* The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
|
398
398
|
*/
|
399
399
|
desiredvCpus?: Integer;
|
400
400
|
/**
|
@@ -448,7 +448,7 @@ declare namespace Batch {
|
|
448
448
|
}
|
449
449
|
export interface ComputeResourceUpdate {
|
450
450
|
/**
|
451
|
-
* The minimum number of
|
451
|
+
* The minimum number of vCPUs that an environment should maintain (even if the compute environment is DISABLED). This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
|
452
452
|
*/
|
453
453
|
minvCpus?: Integer;
|
454
454
|
/**
|
@@ -456,7 +456,7 @@ declare namespace Batch {
|
|
456
456
|
*/
|
457
457
|
maxvCpus?: Integer;
|
458
458
|
/**
|
459
|
-
* The desired number of
|
459
|
+
* The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify this parameter for compute environments using Amazon EKS clusters. When you update the desiredvCpus setting, the value must be between the minvCpus and maxvCpus values. Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting Batch in the Batch User Guide.
|
460
460
|
*/
|
461
461
|
desiredvCpus?: Integer;
|
462
462
|
/**
|
@@ -625,6 +625,7 @@ declare namespace Batch {
|
|
625
625
|
* The amount of ephemeral storage allocated for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
|
626
626
|
*/
|
627
627
|
ephemeralStorage?: EphemeralStorage;
|
628
|
+
runtimePlatform?: RuntimePlatform;
|
628
629
|
}
|
629
630
|
export interface ContainerOverrides {
|
630
631
|
/**
|
@@ -636,7 +637,7 @@ declare namespace Batch {
|
|
636
637
|
*/
|
637
638
|
memory?: Integer;
|
638
639
|
/**
|
639
|
-
* The command to send to the container that overrides the default command from the Docker image or the job definition.
|
640
|
+
* The command to send to the container that overrides the default command from the Docker image or the job definition. This parameter can't contain an empty string.
|
640
641
|
*/
|
641
642
|
command?: StringList;
|
642
643
|
/**
|
@@ -737,6 +738,7 @@ declare namespace Batch {
|
|
737
738
|
* The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
|
738
739
|
*/
|
739
740
|
ephemeralStorage?: EphemeralStorage;
|
741
|
+
runtimePlatform?: RuntimePlatform;
|
740
742
|
}
|
741
743
|
export interface ContainerSummary {
|
742
744
|
/**
|
@@ -2107,6 +2109,16 @@ declare namespace Batch {
|
|
2107
2109
|
*/
|
2108
2110
|
evaluateOnExit?: EvaluateOnExitList;
|
2109
2111
|
}
|
2112
|
+
export interface RuntimePlatform {
|
2113
|
+
/**
|
2114
|
+
* The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL. The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration. The Batch Scheduler checks before registering a task definition with Fargate. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next is checked until a Windows-based compute environment is found. Fargate Spot is not supported for Windows-based containers on Fargate. A job queue will be blocked if a Fargate Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.
|
2115
|
+
*/
|
2116
|
+
operatingSystemFamily?: String;
|
2117
|
+
/**
|
2118
|
+
* The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64. This parameter must be set to X86_64 for Windows containers.
|
2119
|
+
*/
|
2120
|
+
cpuArchitecture?: String;
|
2121
|
+
}
|
2110
2122
|
export interface SchedulingPolicyDetail {
|
2111
2123
|
/**
|
2112
2124
|
* The name of the scheduling policy.
|
@@ -2167,7 +2179,7 @@ declare namespace Batch {
|
|
2167
2179
|
*/
|
2168
2180
|
jobQueue: String;
|
2169
2181
|
/**
|
2170
|
-
* The share identifier for the job.
|
2182
|
+
* The share identifier for the job. Don't specify this parameter if the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, then this parameter must be specified. This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
|
2171
2183
|
*/
|
2172
2184
|
shareIdentifier?: String;
|
2173
2185
|
/**
|
@@ -52,11 +52,11 @@ declare class ComprehendMedical extends Service {
|
|
52
52
|
*/
|
53
53
|
describeSNOMEDCTInferenceJob(callback?: (err: AWSError, data: ComprehendMedical.Types.DescribeSNOMEDCTInferenceJobResponse) => void): Request<ComprehendMedical.Types.DescribeSNOMEDCTInferenceJobResponse, AWSError>;
|
54
54
|
/**
|
55
|
-
* The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.
|
55
|
+
* The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead. Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.
|
56
56
|
*/
|
57
57
|
detectEntities(params: ComprehendMedical.Types.DetectEntitiesRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesResponse) => void): Request<ComprehendMedical.Types.DetectEntitiesResponse, AWSError>;
|
58
58
|
/**
|
59
|
-
* The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.
|
59
|
+
* The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead. Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.
|
60
60
|
*/
|
61
61
|
detectEntities(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesResponse) => void): Request<ComprehendMedical.Types.DetectEntitiesResponse, AWSError>;
|
62
62
|
/**
|
@@ -68,11 +68,11 @@ declare class ComprehendMedical extends Service {
|
|
68
68
|
*/
|
69
69
|
detectEntitiesV2(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesV2Response) => void): Request<ComprehendMedical.Types.DetectEntitiesV2Response, AWSError>;
|
70
70
|
/**
|
71
|
-
*
|
71
|
+
* Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.
|
72
72
|
*/
|
73
73
|
detectPHI(params: ComprehendMedical.Types.DetectPHIRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DetectPHIResponse) => void): Request<ComprehendMedical.Types.DetectPHIResponse, AWSError>;
|
74
74
|
/**
|
75
|
-
*
|
75
|
+
* Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.
|
76
76
|
*/
|
77
77
|
detectPHI(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectPHIResponse) => void): Request<ComprehendMedical.Types.DetectPHIResponse, AWSError>;
|
78
78
|
/**
|
@@ -116,11 +116,11 @@ declare class ComprehendMedical extends Service {
|
|
116
116
|
*/
|
117
117
|
listICD10CMInferenceJobs(callback?: (err: AWSError, data: ComprehendMedical.Types.ListICD10CMInferenceJobsResponse) => void): Request<ComprehendMedical.Types.ListICD10CMInferenceJobsResponse, AWSError>;
|
118
118
|
/**
|
119
|
-
* Gets a list of protected health information (PHI) detection jobs
|
119
|
+
* Gets a list of protected health information (PHI) detection jobs you have submitted.
|
120
120
|
*/
|
121
121
|
listPHIDetectionJobs(params: ComprehendMedical.Types.ListPHIDetectionJobsRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.ListPHIDetectionJobsResponse) => void): Request<ComprehendMedical.Types.ListPHIDetectionJobsResponse, AWSError>;
|
122
122
|
/**
|
123
|
-
* Gets a list of protected health information (PHI) detection jobs
|
123
|
+
* Gets a list of protected health information (PHI) detection jobs you have submitted.
|
124
124
|
*/
|
125
125
|
listPHIDetectionJobs(callback?: (err: AWSError, data: ComprehendMedical.Types.ListPHIDetectionJobsResponse) => void): Request<ComprehendMedical.Types.ListPHIDetectionJobsResponse, AWSError>;
|
126
126
|
/**
|
@@ -228,11 +228,11 @@ declare namespace ComprehendMedical {
|
|
228
228
|
*/
|
229
229
|
Type?: EntitySubType;
|
230
230
|
/**
|
231
|
-
* The level of confidence that Comprehend Medical
|
231
|
+
* The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
232
232
|
*/
|
233
233
|
Score?: Float;
|
234
234
|
/**
|
235
|
-
* The level of confidence that Comprehend Medical
|
235
|
+
* The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
|
236
236
|
*/
|
237
237
|
RelationshipScore?: Float;
|
238
238
|
/**
|
@@ -269,7 +269,7 @@ declare namespace ComprehendMedical {
|
|
269
269
|
export type BoundedLengthString = string;
|
270
270
|
export interface Characters {
|
271
271
|
/**
|
272
|
-
* The number of characters present in the input text document as processed by Comprehend Medical.
|
272
|
+
* The number of characters present in the input text document as processed by Amazon Comprehend Medical.
|
273
273
|
*/
|
274
274
|
OriginalTextCharacters?: Integer;
|
275
275
|
}
|
@@ -334,7 +334,7 @@ declare namespace ComprehendMedical {
|
|
334
334
|
*/
|
335
335
|
LanguageCode?: LanguageCode;
|
336
336
|
/**
|
337
|
-
* The Amazon Resource Name (ARN) that gives Comprehend Medical
|
337
|
+
* The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.
|
338
338
|
*/
|
339
339
|
DataAccessRoleArn?: IamRoleArn;
|
340
340
|
/**
|
@@ -353,7 +353,7 @@ declare namespace ComprehendMedical {
|
|
353
353
|
export type ComprehendMedicalAsyncJobPropertiesList = ComprehendMedicalAsyncJobProperties[];
|
354
354
|
export interface DescribeEntitiesDetectionV2JobRequest {
|
355
355
|
/**
|
356
|
-
* The identifier that Comprehend Medical
|
356
|
+
* The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.
|
357
357
|
*/
|
358
358
|
JobId: JobId;
|
359
359
|
}
|
@@ -377,7 +377,7 @@ declare namespace ComprehendMedical {
|
|
377
377
|
}
|
378
378
|
export interface DescribePHIDetectionJobRequest {
|
379
379
|
/**
|
380
|
-
* The identifier that Comprehend Medical
|
380
|
+
* The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.
|
381
381
|
*/
|
382
382
|
JobId: JobId;
|
383
383
|
}
|
@@ -410,21 +410,21 @@ declare namespace ComprehendMedical {
|
|
410
410
|
}
|
411
411
|
export interface DetectEntitiesRequest {
|
412
412
|
/**
|
413
|
-
* A UTF-8 text string containing the clinical content being examined for entities.
|
413
|
+
* A UTF-8 text string containing the clinical content being examined for entities.
|
414
414
|
*/
|
415
415
|
Text: BoundedLengthString;
|
416
416
|
}
|
417
417
|
export interface DetectEntitiesResponse {
|
418
418
|
/**
|
419
|
-
*
|
419
|
+
* The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
|
420
420
|
*/
|
421
421
|
Entities: EntityList;
|
422
422
|
/**
|
423
|
-
*
|
423
|
+
* Attributes extracted from the input text that we were unable to relate to an entity.
|
424
424
|
*/
|
425
425
|
UnmappedAttributes?: UnmappedAttributeList;
|
426
426
|
/**
|
427
|
-
*
|
427
|
+
* If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
|
428
428
|
*/
|
429
429
|
PaginationToken?: String;
|
430
430
|
/**
|
@@ -434,7 +434,7 @@ declare namespace ComprehendMedical {
|
|
434
434
|
}
|
435
435
|
export interface DetectEntitiesV2Request {
|
436
436
|
/**
|
437
|
-
* A UTF-8 string containing the clinical content being examined for entities.
|
437
|
+
* A UTF-8 string containing the clinical content being examined for entities.
|
438
438
|
*/
|
439
439
|
Text: BoundedLengthString;
|
440
440
|
}
|
@@ -458,17 +458,17 @@ declare namespace ComprehendMedical {
|
|
458
458
|
}
|
459
459
|
export interface DetectPHIRequest {
|
460
460
|
/**
|
461
|
-
*
|
461
|
+
* A UTF-8 text string containing the clinical content being examined for PHI entities.
|
462
462
|
*/
|
463
463
|
Text: BoundedLengthString;
|
464
464
|
}
|
465
465
|
export interface DetectPHIResponse {
|
466
466
|
/**
|
467
|
-
*
|
467
|
+
* The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.
|
468
468
|
*/
|
469
469
|
Entities: EntityList;
|
470
470
|
/**
|
471
|
-
*
|
471
|
+
* If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
|
472
472
|
*/
|
473
473
|
PaginationToken?: String;
|
474
474
|
/**
|
@@ -490,7 +490,7 @@ declare namespace ComprehendMedical {
|
|
490
490
|
*/
|
491
491
|
EndOffset?: Integer;
|
492
492
|
/**
|
493
|
-
* The level of confidence that Comprehend Medical
|
493
|
+
* The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
|
494
494
|
*/
|
495
495
|
Score?: Float;
|
496
496
|
/**
|
@@ -629,7 +629,7 @@ declare namespace ComprehendMedical {
|
|
629
629
|
*/
|
630
630
|
Name?: ICD10CMTraitName;
|
631
631
|
/**
|
632
|
-
* The level of confidence that Comprehend Medical
|
632
|
+
* The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as a trait.
|
633
633
|
*/
|
634
634
|
Score?: Float;
|
635
635
|
}
|
@@ -638,7 +638,7 @@ declare namespace ComprehendMedical {
|
|
638
638
|
export type IamRoleArn = string;
|
639
639
|
export interface InferICD10CMRequest {
|
640
640
|
/**
|
641
|
-
* The input text used for analysis.
|
641
|
+
* The input text used for analysis.
|
642
642
|
*/
|
643
643
|
Text: OntologyLinkingBoundedLengthString;
|
644
644
|
}
|
@@ -658,7 +658,7 @@ declare namespace ComprehendMedical {
|
|
658
658
|
}
|
659
659
|
export interface InferRxNormRequest {
|
660
660
|
/**
|
661
|
-
* The input text used for analysis.
|
661
|
+
* The input text used for analysis.
|
662
662
|
*/
|
663
663
|
Text: OntologyLinkingBoundedLengthString;
|
664
664
|
}
|
@@ -678,13 +678,13 @@ declare namespace ComprehendMedical {
|
|
678
678
|
}
|
679
679
|
export interface InferSNOMEDCTRequest {
|
680
680
|
/**
|
681
|
-
*
|
681
|
+
* The input text to be analyzed using InferSNOMEDCT.
|
682
682
|
*/
|
683
683
|
Text: OntologyLinkingBoundedLengthString;
|
684
684
|
}
|
685
685
|
export interface InferSNOMEDCTResponse {
|
686
686
|
/**
|
687
|
-
* The collection of medical concept entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
|
687
|
+
* The collection of medical concept entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
|
688
688
|
*/
|
689
689
|
Entities: SNOMEDCTEntityList;
|
690
690
|
/**
|
@@ -706,7 +706,7 @@ declare namespace ComprehendMedical {
|
|
706
706
|
}
|
707
707
|
export interface InputDataConfig {
|
708
708
|
/**
|
709
|
-
* The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
|
709
|
+
* The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
|
710
710
|
*/
|
711
711
|
S3Bucket: S3Bucket;
|
712
712
|
/**
|
@@ -847,7 +847,7 @@ declare namespace ComprehendMedical {
|
|
847
847
|
*/
|
848
848
|
S3Bucket: S3Bucket;
|
849
849
|
/**
|
850
|
-
* The path to the output data files in the S3 bucket. Comprehend Medical
|
850
|
+
* The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
|
851
851
|
*/
|
852
852
|
S3Key?: S3Key;
|
853
853
|
}
|
@@ -858,7 +858,7 @@ declare namespace ComprehendMedical {
|
|
858
858
|
*/
|
859
859
|
Type?: RxNormAttributeType;
|
860
860
|
/**
|
861
|
-
* The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
861
|
+
* The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
862
862
|
*/
|
863
863
|
Score?: Float;
|
864
864
|
/**
|
@@ -937,11 +937,11 @@ declare namespace ComprehendMedical {
|
|
937
937
|
*/
|
938
938
|
Attributes?: RxNormAttributeList;
|
939
939
|
/**
|
940
|
-
*
|
940
|
+
* Contextual information for the entity.
|
941
941
|
*/
|
942
942
|
Traits?: RxNormTraitList;
|
943
943
|
/**
|
944
|
-
*
|
944
|
+
* The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
|
945
945
|
*/
|
946
946
|
RxNormConcepts?: RxNormConceptList;
|
947
947
|
}
|
@@ -972,11 +972,11 @@ declare namespace ComprehendMedical {
|
|
972
972
|
*/
|
973
973
|
Type?: SNOMEDCTAttributeType;
|
974
974
|
/**
|
975
|
-
* The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
975
|
+
* The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
976
976
|
*/
|
977
977
|
Score?: Float;
|
978
978
|
/**
|
979
|
-
* The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.
|
979
|
+
* The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
|
980
980
|
*/
|
981
981
|
RelationshipScore?: Float;
|
982
982
|
/**
|
@@ -1020,7 +1020,7 @@ declare namespace ComprehendMedical {
|
|
1020
1020
|
*/
|
1021
1021
|
Code?: String;
|
1022
1022
|
/**
|
1023
|
-
* The level of confidence Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
|
1023
|
+
* The level of confidence Amazon Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
|
1024
1024
|
*/
|
1025
1025
|
Score?: Float;
|
1026
1026
|
}
|
@@ -1057,7 +1057,7 @@ declare namespace ComprehendMedical {
|
|
1057
1057
|
*/
|
1058
1058
|
Type?: SNOMEDCTEntityType;
|
1059
1059
|
/**
|
1060
|
-
* The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
|
1060
|
+
* The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
|
1061
1061
|
*/
|
1062
1062
|
Score?: Float;
|
1063
1063
|
/**
|
@@ -1091,7 +1091,7 @@ declare namespace ComprehendMedical {
|
|
1091
1091
|
*/
|
1092
1092
|
Name?: SNOMEDCTTraitName;
|
1093
1093
|
/**
|
1094
|
-
* The level of confidence that Comprehend Medical has in the accuracy of a detected trait.
|
1094
|
+
* The level of confidence that Amazon Comprehend Medical has in the accuracy of a detected trait.
|
1095
1095
|
*/
|
1096
1096
|
Score?: Float;
|
1097
1097
|
}
|
@@ -1107,7 +1107,7 @@ declare namespace ComprehendMedical {
|
|
1107
1107
|
*/
|
1108
1108
|
OutputDataConfig: OutputDataConfig;
|
1109
1109
|
/**
|
1110
|
-
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical
|
1110
|
+
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
|
1111
1111
|
*/
|
1112
1112
|
DataAccessRoleArn: IamRoleArn;
|
1113
1113
|
/**
|
@@ -1115,7 +1115,7 @@ declare namespace ComprehendMedical {
|
|
1115
1115
|
*/
|
1116
1116
|
JobName?: JobName;
|
1117
1117
|
/**
|
1118
|
-
* A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
1118
|
+
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.
|
1119
1119
|
*/
|
1120
1120
|
ClientRequestToken?: ClientRequestTokenString;
|
1121
1121
|
/**
|
@@ -1123,7 +1123,7 @@ declare namespace ComprehendMedical {
|
|
1123
1123
|
*/
|
1124
1124
|
KMSKey?: KMSKey;
|
1125
1125
|
/**
|
1126
|
-
* The language of the input documents. All documents must be in the same language. Comprehend Medical
|
1126
|
+
* The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).
|
1127
1127
|
*/
|
1128
1128
|
LanguageCode: LanguageCode;
|
1129
1129
|
}
|
@@ -1143,7 +1143,7 @@ declare namespace ComprehendMedical {
|
|
1143
1143
|
*/
|
1144
1144
|
OutputDataConfig: OutputDataConfig;
|
1145
1145
|
/**
|
1146
|
-
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical
|
1146
|
+
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
|
1147
1147
|
*/
|
1148
1148
|
DataAccessRoleArn: IamRoleArn;
|
1149
1149
|
/**
|
@@ -1151,7 +1151,7 @@ declare namespace ComprehendMedical {
|
|
1151
1151
|
*/
|
1152
1152
|
JobName?: JobName;
|
1153
1153
|
/**
|
1154
|
-
* A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
1154
|
+
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
|
1155
1155
|
*/
|
1156
1156
|
ClientRequestToken?: ClientRequestTokenString;
|
1157
1157
|
/**
|
@@ -1179,7 +1179,7 @@ declare namespace ComprehendMedical {
|
|
1179
1179
|
*/
|
1180
1180
|
OutputDataConfig: OutputDataConfig;
|
1181
1181
|
/**
|
1182
|
-
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical
|
1182
|
+
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
|
1183
1183
|
*/
|
1184
1184
|
DataAccessRoleArn: IamRoleArn;
|
1185
1185
|
/**
|
@@ -1187,7 +1187,7 @@ declare namespace ComprehendMedical {
|
|
1187
1187
|
*/
|
1188
1188
|
JobName?: JobName;
|
1189
1189
|
/**
|
1190
|
-
* A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
1190
|
+
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
|
1191
1191
|
*/
|
1192
1192
|
ClientRequestToken?: ClientRequestTokenString;
|
1193
1193
|
/**
|
@@ -1215,7 +1215,7 @@ declare namespace ComprehendMedical {
|
|
1215
1215
|
*/
|
1216
1216
|
OutputDataConfig: OutputDataConfig;
|
1217
1217
|
/**
|
1218
|
-
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical
|
1218
|
+
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
|
1219
1219
|
*/
|
1220
1220
|
DataAccessRoleArn: IamRoleArn;
|
1221
1221
|
/**
|
@@ -1223,7 +1223,7 @@ declare namespace ComprehendMedical {
|
|
1223
1223
|
*/
|
1224
1224
|
JobName?: JobName;
|
1225
1225
|
/**
|
1226
|
-
* A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
1226
|
+
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
|
1227
1227
|
*/
|
1228
1228
|
ClientRequestToken?: ClientRequestTokenString;
|
1229
1229
|
/**
|
@@ -1339,7 +1339,7 @@ declare namespace ComprehendMedical {
|
|
1339
1339
|
*/
|
1340
1340
|
Name?: AttributeName;
|
1341
1341
|
/**
|
1342
|
-
* The level of confidence that Comprehend Medical
|
1342
|
+
* The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.
|
1343
1343
|
*/
|
1344
1344
|
Score?: Float;
|
1345
1345
|
}
|
package/clients/connect.d.ts
CHANGED
@@ -180,11 +180,11 @@ declare class Connect extends Service {
|
|
180
180
|
*/
|
181
181
|
createPrompt(callback?: (err: AWSError, data: Connect.Types.CreatePromptResponse) => void): Request<Connect.Types.CreatePromptResponse, AWSError>;
|
182
182
|
/**
|
183
|
-
* This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
|
183
|
+
* This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
|
184
184
|
*/
|
185
185
|
createQueue(params: Connect.Types.CreateQueueRequest, callback?: (err: AWSError, data: Connect.Types.CreateQueueResponse) => void): Request<Connect.Types.CreateQueueResponse, AWSError>;
|
186
186
|
/**
|
187
|
-
* This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
|
187
|
+
* This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
|
188
188
|
*/
|
189
189
|
createQueue(callback?: (err: AWSError, data: Connect.Types.CreateQueueResponse) => void): Request<Connect.Types.CreateQueueResponse, AWSError>;
|
190
190
|
/**
|
@@ -1084,11 +1084,11 @@ declare class Connect extends Service {
|
|
1084
1084
|
*/
|
1085
1085
|
searchPrompts(callback?: (err: AWSError, data: Connect.Types.SearchPromptsResponse) => void): Request<Connect.Types.SearchPromptsResponse, AWSError>;
|
1086
1086
|
/**
|
1087
|
-
*
|
1087
|
+
* Searches queues in an Amazon Connect instance, with optional filtering.
|
1088
1088
|
*/
|
1089
1089
|
searchQueues(params: Connect.Types.SearchQueuesRequest, callback?: (err: AWSError, data: Connect.Types.SearchQueuesResponse) => void): Request<Connect.Types.SearchQueuesResponse, AWSError>;
|
1090
1090
|
/**
|
1091
|
-
*
|
1091
|
+
* Searches queues in an Amazon Connect instance, with optional filtering.
|
1092
1092
|
*/
|
1093
1093
|
searchQueues(callback?: (err: AWSError, data: Connect.Types.SearchQueuesResponse) => void): Request<Connect.Types.SearchQueuesResponse, AWSError>;
|
1094
1094
|
/**
|
@@ -1108,19 +1108,19 @@ declare class Connect extends Service {
|
|
1108
1108
|
*/
|
1109
1109
|
searchResourceTags(callback?: (err: AWSError, data: Connect.Types.SearchResourceTagsResponse) => void): Request<Connect.Types.SearchResourceTagsResponse, AWSError>;
|
1110
1110
|
/**
|
1111
|
-
*
|
1111
|
+
* Searches routing profiles in an Amazon Connect instance, with optional filtering.
|
1112
1112
|
*/
|
1113
1113
|
searchRoutingProfiles(params: Connect.Types.SearchRoutingProfilesRequest, callback?: (err: AWSError, data: Connect.Types.SearchRoutingProfilesResponse) => void): Request<Connect.Types.SearchRoutingProfilesResponse, AWSError>;
|
1114
1114
|
/**
|
1115
|
-
*
|
1115
|
+
* Searches routing profiles in an Amazon Connect instance, with optional filtering.
|
1116
1116
|
*/
|
1117
1117
|
searchRoutingProfiles(callback?: (err: AWSError, data: Connect.Types.SearchRoutingProfilesResponse) => void): Request<Connect.Types.SearchRoutingProfilesResponse, AWSError>;
|
1118
1118
|
/**
|
1119
|
-
*
|
1119
|
+
* Searches security profiles in an Amazon Connect instance, with optional filtering.
|
1120
1120
|
*/
|
1121
1121
|
searchSecurityProfiles(params: Connect.Types.SearchSecurityProfilesRequest, callback?: (err: AWSError, data: Connect.Types.SearchSecurityProfilesResponse) => void): Request<Connect.Types.SearchSecurityProfilesResponse, AWSError>;
|
1122
1122
|
/**
|
1123
|
-
*
|
1123
|
+
* Searches security profiles in an Amazon Connect instance, with optional filtering.
|
1124
1124
|
*/
|
1125
1125
|
searchSecurityProfiles(callback?: (err: AWSError, data: Connect.Types.SearchSecurityProfilesResponse) => void): Request<Connect.Types.SearchSecurityProfilesResponse, AWSError>;
|
1126
1126
|
/**
|
@@ -1412,11 +1412,11 @@ declare class Connect extends Service {
|
|
1412
1412
|
*/
|
1413
1413
|
updateQueueName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
1414
1414
|
/**
|
1415
|
-
* This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
|
1415
|
+
* This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
|
1416
1416
|
*/
|
1417
1417
|
updateQueueOutboundCallerConfig(params: Connect.Types.UpdateQueueOutboundCallerConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
1418
1418
|
/**
|
1419
|
-
* This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
|
1419
|
+
* This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
|
1420
1420
|
*/
|
1421
1421
|
updateQueueOutboundCallerConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
1422
1422
|
/**
|
@@ -4559,7 +4559,7 @@ declare namespace Connect {
|
|
4559
4559
|
*/
|
4560
4560
|
EndTime: Timestamp;
|
4561
4561
|
/**
|
4562
|
-
* The filters to apply to returned metrics. You can filter on the following resources: Queues Routing profiles Agents Channels User hierarchy groups At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups. To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide. Note the following limits: Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE Filter values: A maximum of 100 filter values are supported in a single request. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values
|
4562
|
+
* The filters to apply to returned metrics. You can filter on the following resources: Queues Routing profiles Agents Channels User hierarchy groups At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups. To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide. Note the following limits: Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
|
4563
4563
|
*/
|
4564
4564
|
Filters: FiltersV2List;
|
4565
4565
|
/**
|