aws-sdk 2.768.0 → 2.772.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 +40 -1
- package/README.md +1 -1
- package/apis/accessanalyzer-2019-11-01.min.json +70 -48
- package/apis/amplify-2017-07-25.min.json +58 -46
- package/apis/budgets-2016-10-20.min.json +411 -0
- package/apis/budgets-2016-10-20.paginators.json +18 -0
- package/apis/ce-2017-10-25.min.json +119 -87
- package/apis/dms-2016-01-01.min.json +15 -3
- package/apis/ec2-2016-11-15.min.json +33 -7
- package/apis/elasticache-2015-02-02.min.json +425 -106
- package/apis/elasticache-2015-02-02.paginators.json +12 -0
- package/apis/eventbridge-2015-10-07.min.json +20 -3
- package/apis/events-2015-10-07.min.json +20 -3
- package/apis/groundstation-2019-05-23.min.json +1 -0
- package/apis/iot-2015-05-28.min.json +4 -1
- package/apis/macie2-2020-01-01.min.json +159 -22
- package/apis/medialive-2017-10-14.min.json +366 -194
- package/apis/mediapackage-2017-10-12.min.json +214 -93
- package/apis/rds-2014-10-31.min.json +20 -2
- package/apis/rekognition-2016-06-27.min.json +206 -76
- package/apis/servicecatalog-2015-12-10.min.json +60 -30
- package/apis/servicecatalog-2015-12-10.paginators.json +5 -0
- package/apis/snowball-2016-06-30.min.json +61 -9
- package/apis/ssm-2014-11-06.min.json +147 -126
- package/apis/transfer-2018-11-05.min.json +32 -28
- package/apis/workmail-2017-10-01.min.json +93 -30
- package/apis/xray-2016-04-12.min.json +11 -5
- package/apis/xray-2016-04-12.paginators.json +0 -15
- package/clients/accessanalyzer.d.ts +26 -4
- package/clients/amplify.d.ts +17 -0
- package/clients/budgets.d.ts +358 -0
- package/clients/cloudwatchevents.d.ts +27 -0
- package/clients/computeoptimizer.d.ts +15 -15
- package/clients/costexplorer.d.ts +64 -12
- package/clients/dms.d.ts +26 -2
- package/clients/ec2.d.ts +28 -8
- package/clients/eks.d.ts +2 -2
- package/clients/elasticache.d.ts +416 -4
- package/clients/eventbridge.d.ts +27 -0
- package/clients/glue.d.ts +1 -1
- package/clients/groundstation.d.ts +5 -1
- package/clients/iot.d.ts +10 -6
- package/clients/macie2.d.ts +182 -62
- package/clients/medialive.d.ts +206 -4
- package/clients/mediapackage.d.ts +58 -0
- package/clients/rds.d.ts +26 -14
- package/clients/rekognition.d.ts +155 -14
- package/clients/sagemaker.d.ts +5 -5
- package/clients/servicecatalog.d.ts +66 -21
- package/clients/snowball.d.ts +122 -52
- package/clients/sns.d.ts +1 -1
- package/clients/ssm.d.ts +63 -11
- package/clients/transfer.d.ts +77 -71
- package/clients/workmail.d.ts +91 -1
- package/clients/workspaces.d.ts +12 -12
- package/clients/xray.d.ts +29 -21
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +27 -27
- package/dist/aws-sdk.js +1087 -483
- package/dist/aws-sdk.min.js +78 -78
- package/lib/config-base.d.ts +3 -0
- package/lib/core.d.ts +1 -1
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/rds.d.ts
CHANGED
|
@@ -102,11 +102,11 @@ declare class RDS extends Service {
|
|
|
102
102
|
*/
|
|
103
103
|
copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
|
|
104
104
|
/**
|
|
105
|
-
* Copies the specified DB snapshot. The source DB snapshot must be in the available
|
|
105
|
+
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
106
106
|
*/
|
|
107
107
|
copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
|
|
108
108
|
/**
|
|
109
|
-
* Copies the specified DB snapshot. The source DB snapshot must be in the available
|
|
109
|
+
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
110
110
|
*/
|
|
111
111
|
copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
|
|
112
112
|
/**
|
|
@@ -198,11 +198,11 @@ declare class RDS extends Service {
|
|
|
198
198
|
*/
|
|
199
199
|
createDBSecurityGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
|
|
200
200
|
/**
|
|
201
|
-
* Creates a
|
|
201
|
+
* Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimizationstate.
|
|
202
202
|
*/
|
|
203
203
|
createDBSnapshot(params: RDS.Types.CreateDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
|
|
204
204
|
/**
|
|
205
|
-
* Creates a
|
|
205
|
+
* Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimizationstate.
|
|
206
206
|
*/
|
|
207
207
|
createDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
|
|
208
208
|
/**
|
|
@@ -1485,7 +1485,7 @@ declare namespace RDS {
|
|
|
1485
1485
|
}
|
|
1486
1486
|
export interface CopyOptionGroupMessage {
|
|
1487
1487
|
/**
|
|
1488
|
-
* The identifier
|
|
1488
|
+
* The identifier for the source option group. Constraints: Must specify a valid option group.
|
|
1489
1489
|
*/
|
|
1490
1490
|
SourceOptionGroupIdentifier: String;
|
|
1491
1491
|
/**
|
|
@@ -1646,7 +1646,7 @@ declare namespace RDS {
|
|
|
1646
1646
|
*/
|
|
1647
1647
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
1648
1648
|
/**
|
|
1649
|
-
* The DB engine mode of the DB cluster, either provisioned
|
|
1649
|
+
* The DB engine mode of the DB cluster, either provisioned serverless, parallelquery, global, or multimaster. The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions. The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless Limitations of Parallel Query Limitations of Aurora Global Databases Limitations of Multi-Master Clusters
|
|
1650
1650
|
*/
|
|
1651
1651
|
EngineMode?: String;
|
|
1652
1652
|
/**
|
|
@@ -1797,7 +1797,7 @@ declare namespace RDS {
|
|
|
1797
1797
|
*/
|
|
1798
1798
|
MultiAZ?: BooleanOptional;
|
|
1799
1799
|
/**
|
|
1800
|
-
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See
|
|
1800
|
+
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
|
|
1801
1801
|
*/
|
|
1802
1802
|
EngineVersion?: String;
|
|
1803
1803
|
/**
|
|
@@ -1901,7 +1901,7 @@ declare namespace RDS {
|
|
|
1901
1901
|
*/
|
|
1902
1902
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
1903
1903
|
/**
|
|
1904
|
-
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. MariaDB Possible values are audit, error, general, and slowquery. Microsoft SQL Server Possible values are agent and error. MySQL Possible values are audit, error, general, and slowquery. Oracle Possible values are alert, audit, listener, and trace. PostgreSQL Possible values are postgresql and upgrade.
|
|
1904
|
+
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. MariaDB Possible values are audit, error, general, and slowquery. Microsoft SQL Server Possible values are agent and error. MySQL Possible values are audit, error, general, and slowquery. Oracle Possible values are alert, audit, listener, and trace. PostgreSQL Possible values are postgresql and upgrade.
|
|
1905
1905
|
*/
|
|
1906
1906
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
1907
1907
|
/**
|
|
@@ -2454,7 +2454,7 @@ declare namespace RDS {
|
|
|
2454
2454
|
*/
|
|
2455
2455
|
Capacity?: IntegerOptional;
|
|
2456
2456
|
/**
|
|
2457
|
-
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
|
|
2457
|
+
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. For more information, see CreateDBCluster.
|
|
2458
2458
|
*/
|
|
2459
2459
|
EngineMode?: String;
|
|
2460
2460
|
ScalingConfigurationInfo?: ScalingConfigurationInfo;
|
|
@@ -2494,6 +2494,7 @@ declare namespace RDS {
|
|
|
2494
2494
|
* The Active Directory Domain membership records associated with the DB cluster.
|
|
2495
2495
|
*/
|
|
2496
2496
|
DomainMemberships?: DomainMembershipList;
|
|
2497
|
+
TagList?: TagList;
|
|
2497
2498
|
/**
|
|
2498
2499
|
* Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
|
|
2499
2500
|
*/
|
|
@@ -2797,6 +2798,7 @@ declare namespace RDS {
|
|
|
2797
2798
|
* True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
|
|
2798
2799
|
*/
|
|
2799
2800
|
IAMDatabaseAuthenticationEnabled?: Boolean;
|
|
2801
|
+
TagList?: TagList;
|
|
2800
2802
|
}
|
|
2801
2803
|
export interface DBClusterSnapshotAttribute {
|
|
2802
2804
|
/**
|
|
@@ -2884,7 +2886,7 @@ declare namespace RDS {
|
|
|
2884
2886
|
*/
|
|
2885
2887
|
SupportsReadReplica?: Boolean;
|
|
2886
2888
|
/**
|
|
2887
|
-
* A list of the supported DB engine modes.
|
|
2889
|
+
* A list of the supported DB engine modes.
|
|
2888
2890
|
*/
|
|
2889
2891
|
SupportedEngineModes?: EngineModeList;
|
|
2890
2892
|
/**
|
|
@@ -3156,6 +3158,7 @@ declare namespace RDS {
|
|
|
3156
3158
|
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
|
3157
3159
|
*/
|
|
3158
3160
|
MaxAllocatedStorage?: IntegerOptional;
|
|
3161
|
+
TagList?: TagList;
|
|
3159
3162
|
}
|
|
3160
3163
|
export interface DBInstanceAutomatedBackup {
|
|
3161
3164
|
/**
|
|
@@ -3653,6 +3656,7 @@ declare namespace RDS {
|
|
|
3653
3656
|
* The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
|
|
3654
3657
|
*/
|
|
3655
3658
|
DbiResourceId?: String;
|
|
3659
|
+
TagList?: TagList;
|
|
3656
3660
|
}
|
|
3657
3661
|
export interface DBSnapshotAttribute {
|
|
3658
3662
|
/**
|
|
@@ -5223,7 +5227,7 @@ declare namespace RDS {
|
|
|
5223
5227
|
*/
|
|
5224
5228
|
Engine: String;
|
|
5225
5229
|
/**
|
|
5226
|
-
* The version number of the database engine to use. For a list of valid engine versions, call DescribeDBEngineVersions. The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license. Microsoft SQL Server See
|
|
5230
|
+
* The version number of the database engine to use. For a list of valid engine versions, call DescribeDBEngineVersions. The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
|
|
5227
5231
|
*/
|
|
5228
5232
|
EngineVersion: String;
|
|
5229
5233
|
/**
|
|
@@ -6239,7 +6243,7 @@ declare namespace RDS {
|
|
|
6239
6243
|
*/
|
|
6240
6244
|
AvailableProcessorFeatures?: AvailableProcessorFeatureList;
|
|
6241
6245
|
/**
|
|
6242
|
-
* A list of the supported DB engine modes.
|
|
6246
|
+
* A list of the supported DB engine modes.
|
|
6243
6247
|
*/
|
|
6244
6248
|
SupportedEngineModes?: EngineModeList;
|
|
6245
6249
|
/**
|
|
@@ -6973,7 +6977,7 @@ declare namespace RDS {
|
|
|
6973
6977
|
*/
|
|
6974
6978
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
6975
6979
|
/**
|
|
6976
|
-
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
|
|
6980
|
+
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. For more information, see CreateDBCluster.
|
|
6977
6981
|
*/
|
|
6978
6982
|
EngineMode?: String;
|
|
6979
6983
|
/**
|
|
@@ -7173,7 +7177,7 @@ declare namespace RDS {
|
|
|
7173
7177
|
*/
|
|
7174
7178
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7175
7179
|
/**
|
|
7176
|
-
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon
|
|
7180
|
+
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
|
|
7177
7181
|
*/
|
|
7178
7182
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7179
7183
|
/**
|
|
@@ -7369,6 +7373,10 @@ declare namespace RDS {
|
|
|
7369
7373
|
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
|
|
7370
7374
|
*/
|
|
7371
7375
|
DeletionProtection?: BooleanOptional;
|
|
7376
|
+
/**
|
|
7377
|
+
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
|
7378
|
+
*/
|
|
7379
|
+
MaxAllocatedStorage?: IntegerOptional;
|
|
7372
7380
|
}
|
|
7373
7381
|
export interface RestoreDBInstanceFromS3Result {
|
|
7374
7382
|
DBInstance?: DBInstance;
|
|
@@ -7495,6 +7503,10 @@ declare namespace RDS {
|
|
|
7495
7503
|
* The resource ID of the source DB instance from which to restore.
|
|
7496
7504
|
*/
|
|
7497
7505
|
SourceDbiResourceId?: String;
|
|
7506
|
+
/**
|
|
7507
|
+
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
|
7508
|
+
*/
|
|
7509
|
+
MaxAllocatedStorage?: IntegerOptional;
|
|
7498
7510
|
}
|
|
7499
7511
|
export interface RestoreDBInstanceToPointInTimeResult {
|
|
7500
7512
|
DBInstance?: DBInstance;
|
package/clients/rekognition.d.ts
CHANGED
|
@@ -13,11 +13,11 @@ declare class Rekognition extends Service {
|
|
|
13
13
|
constructor(options?: Rekognition.Types.ClientConfiguration)
|
|
14
14
|
config: Config & Rekognition.Types.ClientConfiguration;
|
|
15
15
|
/**
|
|
16
|
-
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.
|
|
16
|
+
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
|
|
17
17
|
*/
|
|
18
18
|
compareFaces(params: Rekognition.Types.CompareFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
|
|
19
19
|
/**
|
|
20
|
-
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.
|
|
20
|
+
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
|
|
21
21
|
*/
|
|
22
22
|
compareFaces(callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
|
|
23
23
|
/**
|
|
@@ -156,6 +156,14 @@ declare class Rekognition extends Service {
|
|
|
156
156
|
* Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate. For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
|
|
157
157
|
*/
|
|
158
158
|
detectModerationLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectModerationLabelsResponse) => void): Request<Rekognition.Types.DetectModerationLabelsResponse, AWSError>;
|
|
159
|
+
/**
|
|
160
|
+
* Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE. Face cover Hand cover Head cover You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file. DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image. For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE. You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information. The persons detected as wearing all of the types of PPE that you specify. The persons detected as not wearing all of the types PPE that you specify. The persons detected where PPE adornment could not be determined. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.
|
|
161
|
+
*/
|
|
162
|
+
detectProtectiveEquipment(params: Rekognition.Types.DetectProtectiveEquipmentRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectProtectiveEquipmentResponse) => void): Request<Rekognition.Types.DetectProtectiveEquipmentResponse, AWSError>;
|
|
163
|
+
/**
|
|
164
|
+
* Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE. Face cover Hand cover Head cover You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file. DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image. For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE. You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information. The persons detected as wearing all of the types of PPE that you specify. The persons detected as not wearing all of the types PPE that you specify. The persons detected where PPE adornment could not be determined. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.
|
|
165
|
+
*/
|
|
166
|
+
detectProtectiveEquipment(callback?: (err: AWSError, data: Rekognition.Types.DetectProtectiveEquipmentResponse) => void): Request<Rekognition.Types.DetectProtectiveEquipmentResponse, AWSError>;
|
|
159
167
|
/**
|
|
160
168
|
* Detects text in the input image and converts it into machine-readable text. Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file. The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image. A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image. A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines. To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field. To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. For more information, see DetectText in the Amazon Rekognition Developer Guide.
|
|
161
169
|
*/
|
|
@@ -269,11 +277,11 @@ declare class Rekognition extends Service {
|
|
|
269
277
|
*/
|
|
270
278
|
listStreamProcessors(callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request<Rekognition.Types.ListStreamProcessorsResponse, AWSError>;
|
|
271
279
|
/**
|
|
272
|
-
* Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the
|
|
280
|
+
* Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 64 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.
|
|
273
281
|
*/
|
|
274
282
|
recognizeCelebrities(params: Rekognition.Types.RecognizeCelebritiesRequest, callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request<Rekognition.Types.RecognizeCelebritiesResponse, AWSError>;
|
|
275
283
|
/**
|
|
276
|
-
* Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the
|
|
284
|
+
* Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 64 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.
|
|
277
285
|
*/
|
|
278
286
|
recognizeCelebrities(callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request<Rekognition.Types.RecognizeCelebritiesResponse, AWSError>;
|
|
279
287
|
/**
|
|
@@ -436,7 +444,7 @@ declare namespace Rekognition {
|
|
|
436
444
|
*/
|
|
437
445
|
SampleRate?: ULong;
|
|
438
446
|
/**
|
|
439
|
-
* The number of audio channels in the
|
|
447
|
+
* The number of audio channels in the segment.
|
|
440
448
|
*/
|
|
441
449
|
NumberOfChannels?: ULong;
|
|
442
450
|
}
|
|
@@ -451,6 +459,8 @@ declare namespace Rekognition {
|
|
|
451
459
|
*/
|
|
452
460
|
Confidence?: Percent;
|
|
453
461
|
}
|
|
462
|
+
export type BodyPart = "FACE"|"HEAD"|"LEFT_HAND"|"RIGHT_HAND"|string;
|
|
463
|
+
export type BodyParts = ProtectiveEquipmentBodyPart[];
|
|
454
464
|
export type Boolean = boolean;
|
|
455
465
|
export interface BoundingBox {
|
|
456
466
|
/**
|
|
@@ -635,6 +645,16 @@ declare namespace Rekognition {
|
|
|
635
645
|
}
|
|
636
646
|
export type ContentModerationDetections = ContentModerationDetection[];
|
|
637
647
|
export type ContentModerationSortBy = "NAME"|"TIMESTAMP"|string;
|
|
648
|
+
export interface CoversBodyPart {
|
|
649
|
+
/**
|
|
650
|
+
* The confidence that Amazon Rekognition has in the value of Value.
|
|
651
|
+
*/
|
|
652
|
+
Confidence?: Percent;
|
|
653
|
+
/**
|
|
654
|
+
* True if the PPE covers the corresponding body part, otherwise false.
|
|
655
|
+
*/
|
|
656
|
+
Value?: Boolean;
|
|
657
|
+
}
|
|
638
658
|
export interface CreateCollectionRequest {
|
|
639
659
|
/**
|
|
640
660
|
* ID for the collection that you are creating.
|
|
@@ -1017,6 +1037,30 @@ declare namespace Rekognition {
|
|
|
1017
1037
|
*/
|
|
1018
1038
|
HumanLoopActivationOutput?: HumanLoopActivationOutput;
|
|
1019
1039
|
}
|
|
1040
|
+
export interface DetectProtectiveEquipmentRequest {
|
|
1041
|
+
/**
|
|
1042
|
+
* The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can reference an image stored in an Amazon S3 bucket.
|
|
1043
|
+
*/
|
|
1044
|
+
Image: Image;
|
|
1045
|
+
/**
|
|
1046
|
+
* An array of PPE types that you want to summarize.
|
|
1047
|
+
*/
|
|
1048
|
+
SummarizationAttributes?: ProtectiveEquipmentSummarizationAttributes;
|
|
1049
|
+
}
|
|
1050
|
+
export interface DetectProtectiveEquipmentResponse {
|
|
1051
|
+
/**
|
|
1052
|
+
* The version number of the PPE detection model used to detect PPE in the image.
|
|
1053
|
+
*/
|
|
1054
|
+
ProtectiveEquipmentModelVersion?: String;
|
|
1055
|
+
/**
|
|
1056
|
+
* An array of persons detected in the image (including persons not wearing PPE).
|
|
1057
|
+
*/
|
|
1058
|
+
Persons?: ProtectiveEquipmentPersons;
|
|
1059
|
+
/**
|
|
1060
|
+
* Summary information for the types of PPE specified in the SummarizationAttributes input parameter.
|
|
1061
|
+
*/
|
|
1062
|
+
Summary?: ProtectiveEquipmentSummary;
|
|
1063
|
+
}
|
|
1020
1064
|
export interface DetectTextFilters {
|
|
1021
1065
|
WordFilter?: DetectionFilter;
|
|
1022
1066
|
/**
|
|
@@ -1070,6 +1114,25 @@ declare namespace Rekognition {
|
|
|
1070
1114
|
}
|
|
1071
1115
|
export type EmotionName = "HAPPY"|"SAD"|"ANGRY"|"CONFUSED"|"DISGUSTED"|"SURPRISED"|"CALM"|"UNKNOWN"|"FEAR"|string;
|
|
1072
1116
|
export type Emotions = Emotion[];
|
|
1117
|
+
export interface EquipmentDetection {
|
|
1118
|
+
/**
|
|
1119
|
+
* A bounding box surrounding the item of detected PPE.
|
|
1120
|
+
*/
|
|
1121
|
+
BoundingBox?: BoundingBox;
|
|
1122
|
+
/**
|
|
1123
|
+
* The confidence that Amazon Rekognition has that the bounding box (BoundingBox) contains an item of PPE.
|
|
1124
|
+
*/
|
|
1125
|
+
Confidence?: Percent;
|
|
1126
|
+
/**
|
|
1127
|
+
* The type of detected PPE.
|
|
1128
|
+
*/
|
|
1129
|
+
Type?: ProtectiveEquipmentType;
|
|
1130
|
+
/**
|
|
1131
|
+
* Information about the body part covered by the detected PPE.
|
|
1132
|
+
*/
|
|
1133
|
+
CoversBodyPart?: CoversBodyPart;
|
|
1134
|
+
}
|
|
1135
|
+
export type EquipmentDetections = EquipmentDetection[];
|
|
1073
1136
|
export interface EvaluationResult {
|
|
1074
1137
|
/**
|
|
1075
1138
|
* The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.
|
|
@@ -1555,7 +1618,7 @@ declare namespace Rekognition {
|
|
|
1555
1618
|
*/
|
|
1556
1619
|
NextToken?: PaginationToken;
|
|
1557
1620
|
/**
|
|
1558
|
-
* An array of segments detected in a video.
|
|
1621
|
+
* An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.
|
|
1559
1622
|
*/
|
|
1560
1623
|
Segments?: SegmentDetections;
|
|
1561
1624
|
/**
|
|
@@ -1773,11 +1836,11 @@ declare namespace Rekognition {
|
|
|
1773
1836
|
*/
|
|
1774
1837
|
Type?: LandmarkType;
|
|
1775
1838
|
/**
|
|
1776
|
-
* The x-coordinate
|
|
1839
|
+
* The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
|
|
1777
1840
|
*/
|
|
1778
1841
|
X?: Float;
|
|
1779
1842
|
/**
|
|
1780
|
-
* The y-coordinate
|
|
1843
|
+
* The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.
|
|
1781
1844
|
*/
|
|
1782
1845
|
Y?: Float;
|
|
1783
1846
|
}
|
|
@@ -2044,22 +2107,86 @@ declare namespace Rekognition {
|
|
|
2044
2107
|
*/
|
|
2045
2108
|
OutputConfig?: OutputConfig;
|
|
2046
2109
|
/**
|
|
2047
|
-
*
|
|
2110
|
+
* Contains information about the training results.
|
|
2048
2111
|
*/
|
|
2049
2112
|
TrainingDataResult?: TrainingDataResult;
|
|
2050
2113
|
/**
|
|
2051
|
-
*
|
|
2114
|
+
* Contains information about the testing results.
|
|
2052
2115
|
*/
|
|
2053
2116
|
TestingDataResult?: TestingDataResult;
|
|
2054
2117
|
/**
|
|
2055
2118
|
* The training results. EvaluationResult is only returned if training is successful.
|
|
2056
2119
|
*/
|
|
2057
2120
|
EvaluationResult?: EvaluationResult;
|
|
2121
|
+
/**
|
|
2122
|
+
* The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
|
|
2123
|
+
*/
|
|
2124
|
+
ManifestSummary?: GroundTruthManifest;
|
|
2058
2125
|
}
|
|
2059
2126
|
export type ProjectVersionDescriptions = ProjectVersionDescription[];
|
|
2060
2127
|
export type ProjectVersionStatus = "TRAINING_IN_PROGRESS"|"TRAINING_COMPLETED"|"TRAINING_FAILED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING"|string;
|
|
2061
2128
|
export type ProjectVersionsPageSize = number;
|
|
2062
2129
|
export type ProjectsPageSize = number;
|
|
2130
|
+
export interface ProtectiveEquipmentBodyPart {
|
|
2131
|
+
/**
|
|
2132
|
+
* The detected body part.
|
|
2133
|
+
*/
|
|
2134
|
+
Name?: BodyPart;
|
|
2135
|
+
/**
|
|
2136
|
+
* The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.
|
|
2137
|
+
*/
|
|
2138
|
+
Confidence?: Percent;
|
|
2139
|
+
/**
|
|
2140
|
+
* An array of Personal Protective Equipment items detected around a body part.
|
|
2141
|
+
*/
|
|
2142
|
+
EquipmentDetections?: EquipmentDetections;
|
|
2143
|
+
}
|
|
2144
|
+
export interface ProtectiveEquipmentPerson {
|
|
2145
|
+
/**
|
|
2146
|
+
* An array of body parts detected on a person's body (including body parts without PPE).
|
|
2147
|
+
*/
|
|
2148
|
+
BodyParts?: BodyParts;
|
|
2149
|
+
/**
|
|
2150
|
+
* A bounding box around the detected person.
|
|
2151
|
+
*/
|
|
2152
|
+
BoundingBox?: BoundingBox;
|
|
2153
|
+
/**
|
|
2154
|
+
* The confidence that Amazon Rekognition has that the bounding box contains a person.
|
|
2155
|
+
*/
|
|
2156
|
+
Confidence?: Percent;
|
|
2157
|
+
/**
|
|
2158
|
+
* The identifier for the detected person. The identifier is only unique for a single call to DetectProtectiveEquipment.
|
|
2159
|
+
*/
|
|
2160
|
+
Id?: UInteger;
|
|
2161
|
+
}
|
|
2162
|
+
export type ProtectiveEquipmentPersonIds = UInteger[];
|
|
2163
|
+
export type ProtectiveEquipmentPersons = ProtectiveEquipmentPerson[];
|
|
2164
|
+
export interface ProtectiveEquipmentSummarizationAttributes {
|
|
2165
|
+
/**
|
|
2166
|
+
* The minimum confidence level for which you want summary information. The confidence level applies to person detection, body part detection, equipment detection, and body part coverage. Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a default value. Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment returns predictions only where the detection confidence is between 50% - 100%. If you specify a value that is less than 50%, the results are the same specifying a value of 50%.
|
|
2167
|
+
*/
|
|
2168
|
+
MinConfidence: Percent;
|
|
2169
|
+
/**
|
|
2170
|
+
* An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.
|
|
2171
|
+
*/
|
|
2172
|
+
RequiredEquipmentTypes: ProtectiveEquipmentTypes;
|
|
2173
|
+
}
|
|
2174
|
+
export interface ProtectiveEquipmentSummary {
|
|
2175
|
+
/**
|
|
2176
|
+
* An array of IDs for persons who are wearing detected personal protective equipment.
|
|
2177
|
+
*/
|
|
2178
|
+
PersonsWithRequiredEquipment?: ProtectiveEquipmentPersonIds;
|
|
2179
|
+
/**
|
|
2180
|
+
* An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of the detected personal protective equipment.
|
|
2181
|
+
*/
|
|
2182
|
+
PersonsWithoutRequiredEquipment?: ProtectiveEquipmentPersonIds;
|
|
2183
|
+
/**
|
|
2184
|
+
* An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.
|
|
2185
|
+
*/
|
|
2186
|
+
PersonsIndeterminate?: ProtectiveEquipmentPersonIds;
|
|
2187
|
+
}
|
|
2188
|
+
export type ProtectiveEquipmentType = "FACE_COVER"|"HAND_COVER"|"HEAD_COVER"|string;
|
|
2189
|
+
export type ProtectiveEquipmentTypes = ProtectiveEquipmentType[];
|
|
2063
2190
|
export type QualityFilter = "NONE"|"AUTO"|"LOW"|"MEDIUM"|"HIGH"|string;
|
|
2064
2191
|
export type Reason = "EXCEEDS_MAX_FACES"|"EXTREME_POSE"|"LOW_BRIGHTNESS"|"LOW_SHARPNESS"|"LOW_CONFIDENCE"|"SMALL_BOUNDING_BOX"|"LOW_FACE_QUALITY"|string;
|
|
2065
2192
|
export type Reasons = Reason[];
|
|
@@ -2071,7 +2198,7 @@ declare namespace Rekognition {
|
|
|
2071
2198
|
}
|
|
2072
2199
|
export interface RecognizeCelebritiesResponse {
|
|
2073
2200
|
/**
|
|
2074
|
-
* Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of
|
|
2201
|
+
* Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image.
|
|
2075
2202
|
*/
|
|
2076
2203
|
CelebrityFaces?: CelebrityList;
|
|
2077
2204
|
/**
|
|
@@ -2190,11 +2317,11 @@ declare namespace Rekognition {
|
|
|
2190
2317
|
*/
|
|
2191
2318
|
Type?: SegmentType;
|
|
2192
2319
|
/**
|
|
2193
|
-
* The start time of the detected segment in milliseconds from the start of the video.
|
|
2320
|
+
* The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.
|
|
2194
2321
|
*/
|
|
2195
2322
|
StartTimestampMillis?: Timestamp;
|
|
2196
2323
|
/**
|
|
2197
|
-
* The end time of the detected segment, in milliseconds, from the start of the video.
|
|
2324
|
+
* The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.
|
|
2198
2325
|
*/
|
|
2199
2326
|
EndTimestampMillis?: Timestamp;
|
|
2200
2327
|
/**
|
|
@@ -2238,7 +2365,7 @@ declare namespace Rekognition {
|
|
|
2238
2365
|
export type SegmentTypesInfo = SegmentTypeInfo[];
|
|
2239
2366
|
export interface ShotSegment {
|
|
2240
2367
|
/**
|
|
2241
|
-
* An Identifier for a shot detection segment detected in a video
|
|
2368
|
+
* An Identifier for a shot detection segment detected in a video.
|
|
2242
2369
|
*/
|
|
2243
2370
|
Index?: ULong;
|
|
2244
2371
|
/**
|
|
@@ -2624,6 +2751,10 @@ declare namespace Rekognition {
|
|
|
2624
2751
|
* The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.
|
|
2625
2752
|
*/
|
|
2626
2753
|
Output?: TestingData;
|
|
2754
|
+
/**
|
|
2755
|
+
* The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.
|
|
2756
|
+
*/
|
|
2757
|
+
Validation?: ValidationData;
|
|
2627
2758
|
}
|
|
2628
2759
|
export interface TextDetection {
|
|
2629
2760
|
/**
|
|
@@ -2681,6 +2812,10 @@ declare namespace Rekognition {
|
|
|
2681
2812
|
* The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
|
|
2682
2813
|
*/
|
|
2683
2814
|
Output?: TrainingData;
|
|
2815
|
+
/**
|
|
2816
|
+
* The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.
|
|
2817
|
+
*/
|
|
2818
|
+
Validation?: ValidationData;
|
|
2684
2819
|
}
|
|
2685
2820
|
export type UInteger = number;
|
|
2686
2821
|
export type ULong = number;
|
|
@@ -2697,6 +2832,12 @@ declare namespace Rekognition {
|
|
|
2697
2832
|
export type UnindexedFaces = UnindexedFace[];
|
|
2698
2833
|
export type Url = string;
|
|
2699
2834
|
export type Urls = Url[];
|
|
2835
|
+
export interface ValidationData {
|
|
2836
|
+
/**
|
|
2837
|
+
* The assets that comprise the validation data.
|
|
2838
|
+
*/
|
|
2839
|
+
Assets?: Assets;
|
|
2840
|
+
}
|
|
2700
2841
|
export type VersionName = string;
|
|
2701
2842
|
export type VersionNames = VersionName[];
|
|
2702
2843
|
export interface Video {
|
package/clients/sagemaker.d.ts
CHANGED
|
@@ -69,11 +69,11 @@ declare class SageMaker extends Service {
|
|
|
69
69
|
*/
|
|
70
70
|
createCompilationJob(callback?: (err: AWSError, data: SageMaker.Types.CreateCompilationJobResponse) => void): Request<SageMaker.Types.CreateCompilationJobResponse, AWSError>;
|
|
71
71
|
/**
|
|
72
|
-
* Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other. When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. VPC configuration All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the
|
|
72
|
+
* Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other. When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. VPC configuration All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available: PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value. VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to train or host models unless your VPC has an interface endpoint (PrivateLink) or a NAT gateway and your security groups allow outbound connections. VpcOnly network access type When you choose VpcOnly, you must specify the following: Security group inbound and outbound rules to allow NFS traffic over TCP on port 2049 between the domain and the EFS volume Security group inbound and outbound rules to allow traffic between the JupyterServer app and the KernelGateway apps Interface endpoints to access the SageMaker API and SageMaker runtime For more information, see: Security groups for your VPC VPC with public and private subnets (NAT) Connect to SageMaker through a VPC interface endpoint
|
|
73
73
|
*/
|
|
74
74
|
createDomain(params: SageMaker.Types.CreateDomainRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateDomainResponse) => void): Request<SageMaker.Types.CreateDomainResponse, AWSError>;
|
|
75
75
|
/**
|
|
76
|
-
* Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other. When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. VPC configuration All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the
|
|
76
|
+
* Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other. When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. VPC configuration All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available: PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value. VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to train or host models unless your VPC has an interface endpoint (PrivateLink) or a NAT gateway and your security groups allow outbound connections. VpcOnly network access type When you choose VpcOnly, you must specify the following: Security group inbound and outbound rules to allow NFS traffic over TCP on port 2049 between the domain and the EFS volume Security group inbound and outbound rules to allow traffic between the JupyterServer app and the KernelGateway apps Interface endpoints to access the SageMaker API and SageMaker runtime For more information, see: Security groups for your VPC VPC with public and private subnets (NAT) Connect to SageMaker through a VPC interface endpoint
|
|
77
77
|
*/
|
|
78
78
|
createDomain(callback?: (err: AWSError, data: SageMaker.Types.CreateDomainResponse) => void): Request<SageMaker.Types.CreateDomainResponse, AWSError>;
|
|
79
79
|
/**
|
|
@@ -5438,7 +5438,7 @@ declare namespace SageMaker {
|
|
|
5438
5438
|
*/
|
|
5439
5439
|
S3Uri: S3Uri;
|
|
5440
5440
|
/**
|
|
5441
|
-
* Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific. TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"input":[1,1024,1024,3]} If using the CLI, {\"input\":[1,1024,1024,3]} Examples for two inputs: If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]} If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]} KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"input_1":[1,3,224,224]} If using the CLI, {\"input_1\":[1,3,224,224]} Examples for two inputs: If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]} If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]} MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"data":[1,3,1024,1024]} If using the CLI, {\"data\":[1,3,1024,1024]} Examples for two inputs: If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]} If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]} PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same. Examples for one input in dictionary format: If using the console, {"input0":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224]} Example for one input in list format: [[1,3,224,224]] Examples for two inputs in dictionary format: If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]] XGBOOST: input data name and shape are not needed.
|
|
5441
|
+
* Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific. TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"input":[1,1024,1024,3]} If using the CLI, {\"input\":[1,1024,1024,3]} Examples for two inputs: If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]} If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]} KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"input_1":[1,3,224,224]} If using the CLI, {\"input_1\":[1,3,224,224]} Examples for two inputs: If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]} If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]} MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"data":[1,3,1024,1024]} If using the CLI, {\"data\":[1,3,1024,1024]} Examples for two inputs: If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]} If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]} PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same. Examples for one input in dictionary format: If using the console, {"input0":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224]} Example for one input in list format: [[1,3,224,224]] Examples for two inputs in dictionary format: If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]] XGBOOST: input data name and shape are not needed. DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format): shape: Input shape, for example {"input_1": {"shape": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes: Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}} Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}} default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}} type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale. bias: If the input type is an Image, you need to provide the bias vector. scale: If the input type is an Image, you need to provide a scale factor. CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples: Tensor type input: "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}} Tensor type input without input name (PyTorch): "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}] Image type input: "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}} "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"} Image type input without input name (PyTorch): "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}] "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}
|
|
5442
5442
|
*/
|
|
5443
5443
|
DataInputConfig: DataInputConfig;
|
|
5444
5444
|
/**
|
|
@@ -7729,7 +7729,7 @@ declare namespace SageMaker {
|
|
|
7729
7729
|
*/
|
|
7730
7730
|
TargetPlatform?: TargetPlatform;
|
|
7731
7731
|
/**
|
|
7732
|
-
* Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU
|
|
7732
|
+
* Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions. CPU: Compilation for CPU supports the following compiler options. mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'} mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']} ARM: Details of ARM CPU compilations. NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors. For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support. NVIDIA: Compilation for NVIDIA GPU supports the following compiler options. gpu_code: Specifies the targeted architecture. trt-ver: Specifies the TensorRT versions in x.y.z. format. cuda-ver: Specifies the CUDA version in x.y format. For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'} ANDROID: Compilation for the Android OS supports the following compiler options: ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}. mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support. CoreML: Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options: class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated by newlines.
|
|
7733
7733
|
*/
|
|
7734
7734
|
CompilerOptions?: CompilerOptions;
|
|
7735
7735
|
}
|
|
@@ -8524,7 +8524,7 @@ declare namespace SageMaker {
|
|
|
8524
8524
|
export type TagList = Tag[];
|
|
8525
8525
|
export type TagValue = string;
|
|
8526
8526
|
export type TargetAttributeName = string;
|
|
8527
|
-
export type TargetDevice = "lambda"|"ml_m4"|"ml_m5"|"ml_c4"|"ml_c5"|"ml_p2"|"ml_p3"|"ml_g4dn"|"ml_inf1"|"jetson_tx1"|"jetson_tx2"|"jetson_nano"|"jetson_xavier"|"rasp3b"|"imx8qm"|"deeplens"|"rk3399"|"rk3288"|"aisage"|"sbe_c"|"qcs605"|"qcs603"|"sitara_am57x"|"amba_cv22"|"x86_win32"|"x86_win64"|string;
|
|
8527
|
+
export type TargetDevice = "lambda"|"ml_m4"|"ml_m5"|"ml_c4"|"ml_c5"|"ml_p2"|"ml_p3"|"ml_g4dn"|"ml_inf1"|"jetson_tx1"|"jetson_tx2"|"jetson_nano"|"jetson_xavier"|"rasp3b"|"imx8qm"|"deeplens"|"rk3399"|"rk3288"|"aisage"|"sbe_c"|"qcs605"|"qcs603"|"sitara_am57x"|"amba_cv22"|"x86_win32"|"x86_win64"|"coreml"|string;
|
|
8528
8528
|
export type TargetObjectiveMetricValue = number;
|
|
8529
8529
|
export interface TargetPlatform {
|
|
8530
8530
|
/**
|