diff --git a/.changes/3.86.1 b/.changes/3.86.1
new file mode 100644
index 0000000000..9db009c454
--- /dev/null
+++ b/.changes/3.86.1
@@ -0,0 +1,22 @@
+[
+ {
+ "type": "api-change",
+ "category": "Pinpoint",
+ "description": "This release updates the PutEvents operation. AppPackageName, AppTitle, AppVersionCode, SdkName fields will now be accepted as a part of the event when submitting events."
+ },
+ {
+ "type": "api-change",
+ "category": "Rekognition",
+ "description": "GetLabelDetection now returns bounding box information for common objects and a hierarchical taxonomy of detected labels. The version of the model used for video label detection is also returned. DetectModerationLabels now returns the version of the model used for detecting unsafe content."
+ },
+ {
+ "type": "enhancement",
+ "category": "Lambda",
+ "description": "Documentation updates for AWS Lambda"
+ },
+ {
+ "type": "api-change",
+ "category": "Lightsail",
+ "description": "This release adds functionality to the CreateDiskSnapshot API that allows users to snapshot instance root volumes. It also adds various documentation updates."
+ }
+]
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bda4286dde..d143d05add 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,12 @@
# CHANGELOG
+## next release
+
+* `Aws\Lambda` - Documentation updates for AWS Lambda
+* `Aws\Lightsail` - This release adds functionality to the CreateDiskSnapshot API that allows users to snapshot instance root volumes. It also adds various documentation updates.
+* `Aws\Pinpoint` - This release updates the PutEvents operation. AppPackageName, AppTitle, AppVersionCode, SdkName fields will now be accepted as a part of the event when submitting events.
+* `Aws\Rekognition` - GetLabelDetection now returns bounding box information for common objects and a hierarchical taxonomy of detected labels. The version of the model used for video label detection is also returned. DetectModerationLabels now returns the version of the model used for detecting unsafe content.
+
## 3.86.0 - 2019-01-16
* `Aws\Backup` - AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing
diff --git a/src/data/endpoints.json b/src/data/endpoints.json
index 4c9796aca9..26d10fa66c 100644
--- a/src/data/endpoints.json
+++ b/src/data/endpoints.json
@@ -1217,6 +1217,7 @@
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
+ "eu-west-3" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@@ -2146,6 +2147,25 @@
}
}
},
+ "securityhub" : {
+ "endpoints" : {
+ "ap-northeast-1" : { },
+ "ap-northeast-2" : { },
+ "ap-south-1" : { },
+ "ap-southeast-1" : { },
+ "ap-southeast-2" : { },
+ "ca-central-1" : { },
+ "eu-central-1" : { },
+ "eu-west-1" : { },
+ "eu-west-2" : { },
+ "eu-west-3" : { },
+ "sa-east-1" : { },
+ "us-east-1" : { },
+ "us-east-2" : { },
+ "us-west-1" : { },
+ "us-west-2" : { }
+ }
+ },
"serverlessrepo" : {
"defaults" : {
"protocols" : [ "https" ]
@@ -3024,6 +3044,12 @@
"cn-northwest-1" : { }
}
},
+ "states" : {
+ "endpoints" : {
+ "cn-north-1" : { },
+ "cn-northwest-1" : { }
+ }
+ },
"storagegateway" : {
"endpoints" : {
"cn-north-1" : { }
diff --git a/src/data/endpoints.json.php b/src/data/endpoints.json.php
index 1b1c70c817..ca09f28dbd 100644
--- a/src/data/endpoints.json.php
+++ b/src/data/endpoints.json.php
@@ -1,3 +1,3 @@
[ [ 'defaults' => [ 'hostname' => '{service}.{region}.{dnsSuffix}', 'protocols' => [ 'https', ], 'signatureVersions' => [ 'v4', ], ], 'dnsSuffix' => 'amazonaws.com', 'partition' => 'aws', 'partitionName' => 'AWS Standard', 'regionRegex' => '^(us|eu|ap|sa|ca)\\-\\w+\\-\\d+$', 'regions' => [ 'ap-northeast-1' => [ 'description' => 'Asia Pacific (Tokyo)', ], 'ap-northeast-2' => [ 'description' => 'Asia Pacific (Seoul)', ], 'ap-south-1' => [ 'description' => 'Asia Pacific (Mumbai)', ], 'ap-southeast-1' => [ 'description' => 'Asia Pacific (Singapore)', ], 'ap-southeast-2' => [ 'description' => 'Asia Pacific (Sydney)', ], 'ca-central-1' => [ 'description' => 'Canada (Central)', ], 'eu-central-1' => [ 'description' => 'EU (Frankfurt)', ], 'eu-north-1' => [ 'description' => 'EU (Stockholm)', ], 'eu-west-1' => [ 'description' => 'EU (Ireland)', ], 'eu-west-2' => [ 'description' => 'EU (London)', ], 'eu-west-3' => [ 'description' => 'EU (Paris)', ], 'sa-east-1' => [ 'description' => 'South America (Sao Paulo)', ], 'us-east-1' => [ 'description' => 'US East (N. Virginia)', ], 'us-east-2' => [ 'description' => 'US East (Ohio)', ], 'us-west-1' => [ 'description' => 'US West (N. California)', ], 'us-west-2' => [ 'description' => 'US West (Oregon)', ], ], 'services' => [ 'a4b' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'acm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'acm-pca' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'api.mediatailor' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], ], ], 'api.pricing' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'pricing', ], ], 'endpoints' => [ 'ap-south-1' => [], 'us-east-1' => [], ], ], 'api.sagemaker' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'apigateway' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'application-autoscaling' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'application-autoscaling', ], 'hostname' => 'autoscaling.{region}.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'appstream2' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'appstream', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'appsync' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'athena' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'autoscaling' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'autoscaling-plans' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'autoscaling-plans', ], 'hostname' => 'autoscaling.{region}.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'batch' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'budgets' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'budgets.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'ce' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'ce.us-east-1.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'chime' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'sslCommonName' => 'service.chime.aws.amazon.com', ], 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'service.chime.aws.amazon.com', 'protocols' => [ 'https', ], ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'cloud9' => [ 'endpoints' => [ 'ap-southeast-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'clouddirectory' => [ 'endpoints' => [ 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'cloudformation' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudfront' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'cloudfront.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'cloudhsm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudhsmv2' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'cloudhsm', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudsearch' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudtrail' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'codebuild' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'codebuild-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'codebuild-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'codebuild-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'codebuild-fips.us-west-2.amazonaws.com', ], ], ], 'codecommit' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'fips' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 'codecommit-fips.ca-central-1.amazonaws.com', ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'codedeploy' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'codedeploy-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'codedeploy-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'codedeploy-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'codedeploy-fips.us-west-2.amazonaws.com', ], ], ], 'codepipeline' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'codestar' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cognito-identity' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'cognito-idp' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'cognito-sync' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'comprehend' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'config' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cur' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'data.iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'iotdata', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'datapipeline' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'datasync' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'dax' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'devicefarm' => [ 'endpoints' => [ 'us-west-2' => [], ], ], 'directconnect' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'discovery' => [ 'endpoints' => [ 'us-west-2' => [], ], ], 'dms' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'docdb' => [ 'endpoints' => [ 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 'rds.eu-west-1.amazonaws.com', ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'rds.us-east-1.amazonaws.com', ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'rds.us-east-2.amazonaws.com', ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'rds.us-west-2.amazonaws.com', ], ], ], 'ds' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'dynamodb' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'local' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'localhost:8000', 'protocols' => [ 'http', ], ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ec2' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ecr' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ecs' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticache' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'elasticache-fips.us-west-1.amazonaws.com', ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticbeanstalk' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticfilesystem' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticloadbalancing' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticmapreduce' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'sslCommonName' => '{region}.{service}.{dnsSuffix}', ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [ 'sslCommonName' => '{service}.{region}.{dnsSuffix}', ], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [ 'sslCommonName' => '{service}.{region}.{dnsSuffix}', ], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elastictranscoder' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'email' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'entitlement.marketplace' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'aws-marketplace', ], ], 'endpoints' => [ 'us-east-1' => [], ], ], 'es' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'events' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'firehose' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'fms' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'fsx' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'gamelift' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'glacier' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'glue' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'greengrass' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], 'isRegionalized' => true, ], 'guardduty' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], 'isRegionalized' => true, ], 'health' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'iam' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'iam.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'importexport' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', 'service' => 'IngestionService', ], 'hostname' => 'importexport.amazonaws.com', 'signatureVersions' => [ 'v2', 'v4', ], ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'inspector' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'execute-api', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'iotanalytics' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'kinesis' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'kinesisanalytics' => [ 'endpoints' => [ 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'kinesisvideo' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'kms' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'lambda' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'lightsail' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'logs' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'machinelearning' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], ], ], 'marketplacecommerceanalytics' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'mediaconvert' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'medialive' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'mediapackage' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mediastore' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'metering.marketplace' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'aws-marketplace', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mgh' => [ 'endpoints' => [ 'us-west-2' => [], ], ], 'mobileanalytics' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'models.lex' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'lex', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'monitoring' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mq' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mturk-requester' => [ 'endpoints' => [ 'sandbox' => [ 'hostname' => 'mturk-requester-sandbox.us-east-1.amazonaws.com', ], 'us-east-1' => [], ], 'isRegionalized' => false, ], 'neptune' => [ 'endpoints' => [ 'ap-southeast-1' => [ 'credentialScope' => [ 'region' => 'ap-southeast-1', ], 'hostname' => 'rds.ap-southeast-1.amazonaws.com', ], 'ap-southeast-2' => [ 'credentialScope' => [ 'region' => 'ap-southeast-2', ], 'hostname' => 'rds.ap-southeast-2.amazonaws.com', ], 'eu-central-1' => [ 'credentialScope' => [ 'region' => 'eu-central-1', ], 'hostname' => 'rds.eu-central-1.amazonaws.com', ], 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 'rds.eu-west-1.amazonaws.com', ], 'eu-west-2' => [ 'credentialScope' => [ 'region' => 'eu-west-2', ], 'hostname' => 'rds.eu-west-2.amazonaws.com', ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'rds.us-east-1.amazonaws.com', ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'rds.us-east-2.amazonaws.com', ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'rds.us-west-2.amazonaws.com', ], ], ], 'opsworks' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'opsworks-cm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'organizations' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'organizations.us-east-1.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'pinpoint' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'mobiletargeting', ], ], 'endpoints' => [ 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'polly' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'rds' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [ 'sslCommonName' => '{service}.{dnsSuffix}', ], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'redshift' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'rekognition' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'resource-groups' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'robomaker' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'route53' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'route53.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'route53domains' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'route53resolver' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'runtime.lex' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'lex', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'runtime.sagemaker' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 's3' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'ap-northeast-1' => [ 'hostname' => 's3.ap-northeast-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [ 'hostname' => 's3.ap-southeast-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'ap-southeast-2' => [ 'hostname' => 's3.ap-southeast-2.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [ 'hostname' => 's3.eu-west-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'eu-west-2' => [], 'eu-west-3' => [], 's3-external-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 's3-external-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'sa-east-1' => [ 'hostname' => 's3.sa-east-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'us-east-1' => [ 'hostname' => 's3.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'us-east-2' => [], 'us-west-1' => [ 'hostname' => 's3.us-west-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'us-west-2' => [ 'hostname' => 's3.us-west-2.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], ], 'isRegionalized' => true, 'partitionEndpoint' => 'us-east-1', ], 's3-control' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'ap-northeast-1' => [ 'credentialScope' => [ 'region' => 'ap-northeast-1', ], 'hostname' => 's3-control.ap-northeast-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-northeast-2' => [ 'credentialScope' => [ 'region' => 'ap-northeast-2', ], 'hostname' => 's3-control.ap-northeast-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-south-1' => [ 'credentialScope' => [ 'region' => 'ap-south-1', ], 'hostname' => 's3-control.ap-south-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-southeast-1' => [ 'credentialScope' => [ 'region' => 'ap-southeast-1', ], 'hostname' => 's3-control.ap-southeast-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-southeast-2' => [ 'credentialScope' => [ 'region' => 'ap-southeast-2', ], 'hostname' => 's3-control.ap-southeast-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ca-central-1' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 's3-control.ca-central-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-central-1' => [ 'credentialScope' => [ 'region' => 'eu-central-1', ], 'hostname' => 's3-control.eu-central-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-north-1' => [ 'credentialScope' => [ 'region' => 'eu-north-1', ], 'hostname' => 's3-control.eu-north-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 's3-control.eu-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-west-2' => [ 'credentialScope' => [ 'region' => 'eu-west-2', ], 'hostname' => 's3-control.eu-west-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-west-3' => [ 'credentialScope' => [ 'region' => 'eu-west-3', ], 'hostname' => 's3-control.eu-west-3.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'sa-east-1' => [ 'credentialScope' => [ 'region' => 'sa-east-1', ], 'hostname' => 's3-control.sa-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 's3-control.us-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 's3-control-fips.us-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 's3-control.us-east-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 's3-control-fips.us-east-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-1' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 's3-control.us-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 's3-control-fips.us-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 's3-control.us-west-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 's3-control-fips.us-west-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], ], ], 'sdb' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'signatureVersions' => [ 'v2', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [ 'hostname' => 'sdb.amazonaws.com', ], 'us-west-1' => [], 'us-west-2' => [], ], ], 'secretsmanager' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'secretsmanager-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'secretsmanager-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'secretsmanager-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'secretsmanager-fips.us-west-2.amazonaws.com', ], ], ], 'serverlessrepo' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [ 'protocols' => [ 'https', ], ], 'ap-northeast-2' => [ 'protocols' => [ 'https', ], ], 'ap-south-1' => [ 'protocols' => [ 'https', ], ], 'ap-southeast-1' => [ 'protocols' => [ 'https', ], ], 'ap-southeast-2' => [ 'protocols' => [ 'https', ], ], 'ca-central-1' => [ 'protocols' => [ 'https', ], ], 'eu-central-1' => [ 'protocols' => [ 'https', ], ], 'eu-west-1' => [ 'protocols' => [ 'https', ], ], 'eu-west-2' => [ 'protocols' => [ 'https', ], ], 'sa-east-1' => [ 'protocols' => [ 'https', ], ], 'us-east-1' => [ 'protocols' => [ 'https', ], ], 'us-east-2' => [ 'protocols' => [ 'https', ], ], 'us-west-1' => [ 'protocols' => [ 'https', ], ], 'us-west-2' => [ 'protocols' => [ 'https', ], ], ], ], 'servicecatalog' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'servicecatalog-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'servicecatalog-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'servicecatalog-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'servicecatalog-fips.us-west-2.amazonaws.com', ], ], ], 'servicediscovery' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'shield' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'sslCommonName' => 'shield.us-east-1.amazonaws.com', ], 'endpoints' => [ 'us-east-1' => [], ], 'isRegionalized' => false, ], 'sms' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'snowball' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'sns' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'sqs' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'sslCommonName' => '{region}.queue.{dnsSuffix}', ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'fips-us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'sqs-fips.us-east-1.amazonaws.com', ], 'fips-us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'sqs-fips.us-east-2.amazonaws.com', ], 'fips-us-west-1' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'sqs-fips.us-west-1.amazonaws.com', ], 'fips-us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'sqs-fips.us-west-2.amazonaws.com', ], 'sa-east-1' => [], 'us-east-1' => [ 'sslCommonName' => 'queue.{dnsSuffix}', ], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ssm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'states' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'storagegateway' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'streams.dynamodb' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'dynamodb', ], 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'local' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'localhost:8000', 'protocols' => [ 'http', ], ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'sts' => [ 'defaults' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'sts.amazonaws.com', ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [ 'credentialScope' => [ 'region' => 'ap-northeast-2', ], 'hostname' => 'sts.ap-northeast-2.amazonaws.com', ], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'aws-global' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'sts-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'sts-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'sts-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'sts-fips.us-west-2.amazonaws.com', ], ], 'partitionEndpoint' => 'aws-global', ], 'support' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'swf' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'tagging' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'transfer' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'translate' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'translate-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'translate-fips.us-east-2.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'translate-fips.us-west-2.amazonaws.com', ], ], ], 'waf' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'waf.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'waf-regional' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'workdocs' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'workmail' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'workspaces' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'xray' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], ], ], [ 'defaults' => [ 'hostname' => '{service}.{region}.{dnsSuffix}', 'protocols' => [ 'https', ], 'signatureVersions' => [ 'v4', ], ], 'dnsSuffix' => 'amazonaws.com.cn', 'partition' => 'aws-cn', 'partitionName' => 'AWS China', 'regionRegex' => '^cn\\-\\w+\\-\\d+$', 'regions' => [ 'cn-north-1' => [ 'description' => 'China (Beijing)', ], 'cn-northwest-1' => [ 'description' => 'China (Ningxia)', ], ], 'services' => [ 'apigateway' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'application-autoscaling' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'application-autoscaling', ], 'hostname' => 'autoscaling.{region}.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'autoscaling' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'cloudformation' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'cloudtrail' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'codebuild' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'codedeploy' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'cognito-identity' => [ 'endpoints' => [ 'cn-north-1' => [], ], ], 'config' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'data.iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'iotdata', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], ], ], 'directconnect' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'dms' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ds' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'dynamodb' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ec2' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ecr' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ecs' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticache' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticbeanstalk' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticloadbalancing' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticmapreduce' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'es' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'events' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'glacier' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'iam' => [ 'endpoints' => [ 'aws-cn-global' => [ 'credentialScope' => [ 'region' => 'cn-north-1', ], 'hostname' => 'iam.cn-north-1.amazonaws.com.cn', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-cn-global', ], 'iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'execute-api', ], ], 'endpoints' => [ 'cn-north-1' => [], ], ], 'kinesis' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'lambda' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'logs' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'monitoring' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'polly' => [ 'endpoints' => [ 'cn-northwest-1' => [], ], ], 'rds' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'redshift' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 's3' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 's3-control' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'cn-north-1' => [ 'credentialScope' => [ 'region' => 'cn-north-1', ], 'hostname' => 's3-control.cn-north-1.amazonaws.com.cn', 'signatureVersions' => [ 's3v4', ], ], 'cn-northwest-1' => [ 'credentialScope' => [ 'region' => 'cn-northwest-1', ], 'hostname' => 's3-control.cn-northwest-1.amazonaws.com.cn', 'signatureVersions' => [ 's3v4', ], ], ], ], 'sms' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'snowball' => [ 'endpoints' => [ 'cn-north-1' => [], ], ], 'sns' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'sqs' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'sslCommonName' => '{region}.queue.{dnsSuffix}', ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ssm' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'storagegateway' => [ 'endpoints' => [ 'cn-north-1' => [], ], ], 'streams.dynamodb' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'dynamodb', ], 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'sts' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'swf' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'tagging' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], ], ], [ 'defaults' => [ 'hostname' => '{service}.{region}.{dnsSuffix}', 'protocols' => [ 'https', ], 'signatureVersions' => [ 'v4', ], ], 'dnsSuffix' => 'amazonaws.com', 'partition' => 'aws-us-gov', 'partitionName' => 'AWS GovCloud (US)', 'regionRegex' => '^us\\-gov\\-\\w+\\-\\d+$', 'regions' => [ 'us-gov-east-1' => [ 'description' => 'AWS GovCloud (US-East)', ], 'us-gov-west-1' => [ 'description' => 'AWS GovCloud (US)', ], ], 'services' => [ 'acm' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'api.sagemaker' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'apigateway' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'application-autoscaling' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'autoscaling' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'clouddirectory' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'cloudformation' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'cloudhsm' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'cloudhsmv2' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'cloudhsm', ], ], 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'cloudtrail' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'codedeploy' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 'codedeploy-fips.us-gov-east-1.amazonaws.com', ], 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'codedeploy-fips.us-gov-west-1.amazonaws.com', ], ], ], 'config' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'data.iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'iotdata', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'directconnect' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'dms' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'ds' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'dynamodb' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'dynamodb.us-gov-west-1.amazonaws.com', ], ], ], 'ec2' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'ecr' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'ecs' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'elasticache' => [ 'endpoints' => [ 'fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'elasticache-fips.us-gov-west-1.amazonaws.com', ], 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'elasticbeanstalk' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'elasticfilesystem' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'elasticloadbalancing' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'elasticmapreduce' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'https', ], ], ], ], 'es' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'events' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'glacier' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'guardduty' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], 'isRegionalized' => true, ], 'iam' => [ 'endpoints' => [ 'aws-us-gov-global' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'iam.us-gov.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-us-gov-global', ], 'inspector' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'execute-api', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'kinesis' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'kms' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'lambda' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'logs' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'mediaconvert' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'metering.marketplace' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'aws-marketplace', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'monitoring' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'polly' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'rds' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'redshift' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'rekognition' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'runtime.sagemaker' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 's3' => [ 'defaults' => [ 'signatureVersions' => [ 's3', 's3v4', ], ], 'endpoints' => [ 'fips-us-gov-west-1' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 's3-fips-us-gov-west-1.amazonaws.com', ], 'us-gov-east-1' => [ 'hostname' => 's3.us-gov-east-1.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'us-gov-west-1' => [ 'hostname' => 's3.us-gov-west-1.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], ], ], 's3-control' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'us-gov-east-1' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 's3-control.us-gov-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-gov-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 's3-control-fips.us-gov-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-gov-west-1' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 's3-control.us-gov-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 's3-control-fips.us-gov-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], ], ], 'sms' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'snowball' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'sns' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'sqs' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], 'sslCommonName' => '{region}.queue.{dnsSuffix}', ], ], ], 'ssm' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'states' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'storagegateway' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'streams.dynamodb' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'dynamodb', ], ], 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'dynamodb.us-gov-west-1.amazonaws.com', ], ], ], 'sts' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'swf' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'tagging' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'translate' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'translate-fips.us-gov-west-1.amazonaws.com', ], ], ], ], ], ], 'version' => 3,];
+return [ 'partitions' => [ [ 'defaults' => [ 'hostname' => '{service}.{region}.{dnsSuffix}', 'protocols' => [ 'https', ], 'signatureVersions' => [ 'v4', ], ], 'dnsSuffix' => 'amazonaws.com', 'partition' => 'aws', 'partitionName' => 'AWS Standard', 'regionRegex' => '^(us|eu|ap|sa|ca)\\-\\w+\\-\\d+$', 'regions' => [ 'ap-northeast-1' => [ 'description' => 'Asia Pacific (Tokyo)', ], 'ap-northeast-2' => [ 'description' => 'Asia Pacific (Seoul)', ], 'ap-south-1' => [ 'description' => 'Asia Pacific (Mumbai)', ], 'ap-southeast-1' => [ 'description' => 'Asia Pacific (Singapore)', ], 'ap-southeast-2' => [ 'description' => 'Asia Pacific (Sydney)', ], 'ca-central-1' => [ 'description' => 'Canada (Central)', ], 'eu-central-1' => [ 'description' => 'EU (Frankfurt)', ], 'eu-north-1' => [ 'description' => 'EU (Stockholm)', ], 'eu-west-1' => [ 'description' => 'EU (Ireland)', ], 'eu-west-2' => [ 'description' => 'EU (London)', ], 'eu-west-3' => [ 'description' => 'EU (Paris)', ], 'sa-east-1' => [ 'description' => 'South America (Sao Paulo)', ], 'us-east-1' => [ 'description' => 'US East (N. Virginia)', ], 'us-east-2' => [ 'description' => 'US East (Ohio)', ], 'us-west-1' => [ 'description' => 'US West (N. California)', ], 'us-west-2' => [ 'description' => 'US West (Oregon)', ], ], 'services' => [ 'a4b' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'acm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'acm-pca' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'api.mediatailor' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], ], ], 'api.pricing' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'pricing', ], ], 'endpoints' => [ 'ap-south-1' => [], 'us-east-1' => [], ], ], 'api.sagemaker' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'apigateway' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'application-autoscaling' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'application-autoscaling', ], 'hostname' => 'autoscaling.{region}.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'appstream2' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'appstream', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'appsync' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'athena' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'autoscaling' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'autoscaling-plans' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'autoscaling-plans', ], 'hostname' => 'autoscaling.{region}.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'batch' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'budgets' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'budgets.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'ce' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'ce.us-east-1.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'chime' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'sslCommonName' => 'service.chime.aws.amazon.com', ], 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'service.chime.aws.amazon.com', 'protocols' => [ 'https', ], ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'cloud9' => [ 'endpoints' => [ 'ap-southeast-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'clouddirectory' => [ 'endpoints' => [ 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'cloudformation' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudfront' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'cloudfront.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'cloudhsm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudhsmv2' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'cloudhsm', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudsearch' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cloudtrail' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'codebuild' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'codebuild-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'codebuild-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'codebuild-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'codebuild-fips.us-west-2.amazonaws.com', ], ], ], 'codecommit' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'fips' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 'codecommit-fips.ca-central-1.amazonaws.com', ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'codedeploy' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'codedeploy-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'codedeploy-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'codedeploy-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'codedeploy-fips.us-west-2.amazonaws.com', ], ], ], 'codepipeline' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'codestar' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cognito-identity' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'cognito-idp' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'cognito-sync' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'comprehend' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'config' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'cur' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'data.iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'iotdata', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'datapipeline' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'datasync' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'dax' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'devicefarm' => [ 'endpoints' => [ 'us-west-2' => [], ], ], 'directconnect' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'discovery' => [ 'endpoints' => [ 'us-west-2' => [], ], ], 'dms' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'docdb' => [ 'endpoints' => [ 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 'rds.eu-west-1.amazonaws.com', ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'rds.us-east-1.amazonaws.com', ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'rds.us-east-2.amazonaws.com', ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'rds.us-west-2.amazonaws.com', ], ], ], 'ds' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'dynamodb' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'local' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'localhost:8000', 'protocols' => [ 'http', ], ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ec2' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ecr' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ecs' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticache' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'elasticache-fips.us-west-1.amazonaws.com', ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticbeanstalk' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticfilesystem' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticloadbalancing' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elasticmapreduce' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'sslCommonName' => '{region}.{service}.{dnsSuffix}', ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [ 'sslCommonName' => '{service}.{region}.{dnsSuffix}', ], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [ 'sslCommonName' => '{service}.{region}.{dnsSuffix}', ], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'elastictranscoder' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'email' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'entitlement.marketplace' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'aws-marketplace', ], ], 'endpoints' => [ 'us-east-1' => [], ], ], 'es' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'events' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'firehose' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'fms' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'fsx' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'gamelift' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'glacier' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'glue' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'greengrass' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], 'isRegionalized' => true, ], 'guardduty' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], 'isRegionalized' => true, ], 'health' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'iam' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'iam.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'importexport' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', 'service' => 'IngestionService', ], 'hostname' => 'importexport.amazonaws.com', 'signatureVersions' => [ 'v2', 'v4', ], ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'inspector' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'execute-api', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'iotanalytics' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'kinesis' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'kinesisanalytics' => [ 'endpoints' => [ 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'kinesisvideo' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'kms' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'lambda' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'lightsail' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'logs' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'machinelearning' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], ], ], 'marketplacecommerceanalytics' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'mediaconvert' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'medialive' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'mediapackage' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mediastore' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'metering.marketplace' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'aws-marketplace', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mgh' => [ 'endpoints' => [ 'us-west-2' => [], ], ], 'mobileanalytics' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'models.lex' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'lex', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'monitoring' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mq' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'mturk-requester' => [ 'endpoints' => [ 'sandbox' => [ 'hostname' => 'mturk-requester-sandbox.us-east-1.amazonaws.com', ], 'us-east-1' => [], ], 'isRegionalized' => false, ], 'neptune' => [ 'endpoints' => [ 'ap-southeast-1' => [ 'credentialScope' => [ 'region' => 'ap-southeast-1', ], 'hostname' => 'rds.ap-southeast-1.amazonaws.com', ], 'ap-southeast-2' => [ 'credentialScope' => [ 'region' => 'ap-southeast-2', ], 'hostname' => 'rds.ap-southeast-2.amazonaws.com', ], 'eu-central-1' => [ 'credentialScope' => [ 'region' => 'eu-central-1', ], 'hostname' => 'rds.eu-central-1.amazonaws.com', ], 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 'rds.eu-west-1.amazonaws.com', ], 'eu-west-2' => [ 'credentialScope' => [ 'region' => 'eu-west-2', ], 'hostname' => 'rds.eu-west-2.amazonaws.com', ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'rds.us-east-1.amazonaws.com', ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'rds.us-east-2.amazonaws.com', ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'rds.us-west-2.amazonaws.com', ], ], ], 'opsworks' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'opsworks-cm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'organizations' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'organizations.us-east-1.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'pinpoint' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'mobiletargeting', ], ], 'endpoints' => [ 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'polly' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'rds' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [ 'sslCommonName' => '{service}.{dnsSuffix}', ], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'redshift' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'rekognition' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'resource-groups' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'robomaker' => [ 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'route53' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'route53.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'route53domains' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'route53resolver' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'runtime.lex' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'lex', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'runtime.sagemaker' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 's3' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'ap-northeast-1' => [ 'hostname' => 's3.ap-northeast-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [ 'hostname' => 's3.ap-southeast-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'ap-southeast-2' => [ 'hostname' => 's3.ap-southeast-2.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [ 'hostname' => 's3.eu-west-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'eu-west-2' => [], 'eu-west-3' => [], 's3-external-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 's3-external-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'sa-east-1' => [ 'hostname' => 's3.sa-east-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'us-east-1' => [ 'hostname' => 's3.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'us-east-2' => [], 'us-west-1' => [ 'hostname' => 's3.us-west-1.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], 'us-west-2' => [ 'hostname' => 's3.us-west-2.amazonaws.com', 'signatureVersions' => [ 's3', 's3v4', ], ], ], 'isRegionalized' => true, 'partitionEndpoint' => 'us-east-1', ], 's3-control' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'ap-northeast-1' => [ 'credentialScope' => [ 'region' => 'ap-northeast-1', ], 'hostname' => 's3-control.ap-northeast-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-northeast-2' => [ 'credentialScope' => [ 'region' => 'ap-northeast-2', ], 'hostname' => 's3-control.ap-northeast-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-south-1' => [ 'credentialScope' => [ 'region' => 'ap-south-1', ], 'hostname' => 's3-control.ap-south-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-southeast-1' => [ 'credentialScope' => [ 'region' => 'ap-southeast-1', ], 'hostname' => 's3-control.ap-southeast-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ap-southeast-2' => [ 'credentialScope' => [ 'region' => 'ap-southeast-2', ], 'hostname' => 's3-control.ap-southeast-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'ca-central-1' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 's3-control.ca-central-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-central-1' => [ 'credentialScope' => [ 'region' => 'eu-central-1', ], 'hostname' => 's3-control.eu-central-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-north-1' => [ 'credentialScope' => [ 'region' => 'eu-north-1', ], 'hostname' => 's3-control.eu-north-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 's3-control.eu-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-west-2' => [ 'credentialScope' => [ 'region' => 'eu-west-2', ], 'hostname' => 's3-control.eu-west-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'eu-west-3' => [ 'credentialScope' => [ 'region' => 'eu-west-3', ], 'hostname' => 's3-control.eu-west-3.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'sa-east-1' => [ 'credentialScope' => [ 'region' => 'sa-east-1', ], 'hostname' => 's3-control.sa-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 's3-control.us-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 's3-control-fips.us-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 's3-control.us-east-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 's3-control-fips.us-east-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-1' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 's3-control.us-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 's3-control-fips.us-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 's3-control.us-west-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 's3-control-fips.us-west-2.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], ], ], 'sdb' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'signatureVersions' => [ 'v2', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'sa-east-1' => [], 'us-east-1' => [ 'hostname' => 'sdb.amazonaws.com', ], 'us-west-1' => [], 'us-west-2' => [], ], ], 'secretsmanager' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'secretsmanager-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'secretsmanager-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'secretsmanager-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'secretsmanager-fips.us-west-2.amazonaws.com', ], ], ], 'securityhub' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'serverlessrepo' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [ 'protocols' => [ 'https', ], ], 'ap-northeast-2' => [ 'protocols' => [ 'https', ], ], 'ap-south-1' => [ 'protocols' => [ 'https', ], ], 'ap-southeast-1' => [ 'protocols' => [ 'https', ], ], 'ap-southeast-2' => [ 'protocols' => [ 'https', ], ], 'ca-central-1' => [ 'protocols' => [ 'https', ], ], 'eu-central-1' => [ 'protocols' => [ 'https', ], ], 'eu-west-1' => [ 'protocols' => [ 'https', ], ], 'eu-west-2' => [ 'protocols' => [ 'https', ], ], 'sa-east-1' => [ 'protocols' => [ 'https', ], ], 'us-east-1' => [ 'protocols' => [ 'https', ], ], 'us-east-2' => [ 'protocols' => [ 'https', ], ], 'us-west-1' => [ 'protocols' => [ 'https', ], ], 'us-west-2' => [ 'protocols' => [ 'https', ], ], ], ], 'servicecatalog' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'servicecatalog-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'servicecatalog-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'servicecatalog-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'servicecatalog-fips.us-west-2.amazonaws.com', ], ], ], 'servicediscovery' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'shield' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'sslCommonName' => 'shield.us-east-1.amazonaws.com', ], 'endpoints' => [ 'us-east-1' => [], ], 'isRegionalized' => false, ], 'sms' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'snowball' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'sns' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'sqs' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'sslCommonName' => '{region}.queue.{dnsSuffix}', ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'fips-us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'sqs-fips.us-east-1.amazonaws.com', ], 'fips-us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'sqs-fips.us-east-2.amazonaws.com', ], 'fips-us-west-1' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'sqs-fips.us-west-1.amazonaws.com', ], 'fips-us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'sqs-fips.us-west-2.amazonaws.com', ], 'sa-east-1' => [], 'us-east-1' => [ 'sslCommonName' => 'queue.{dnsSuffix}', ], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'ssm' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'states' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'storagegateway' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'streams.dynamodb' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'dynamodb', ], 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'local' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'localhost:8000', 'protocols' => [ 'http', ], ], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'sts' => [ 'defaults' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'sts.amazonaws.com', ], 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [ 'credentialScope' => [ 'region' => 'ap-northeast-2', ], 'hostname' => 'sts.ap-northeast-2.amazonaws.com', ], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'aws-global' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'sts-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'sts-fips.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'sts-fips.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'sts-fips.us-west-2.amazonaws.com', ], ], 'partitionEndpoint' => 'aws-global', ], 'support' => [ 'endpoints' => [ 'us-east-1' => [], ], ], 'swf' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'tagging' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'transfer' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'translate' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'translate-fips.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'translate-fips.us-east-2.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'translate-fips.us-west-2.amazonaws.com', ], ], ], 'waf' => [ 'endpoints' => [ 'aws-global' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'waf.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-global', ], 'waf-regional' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-2' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], 'workdocs' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'workmail' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'workspaces' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], 'xray' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-northeast-2' => [], 'ap-south-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-north-1' => [], 'eu-west-1' => [], 'eu-west-2' => [], 'eu-west-3' => [], 'sa-east-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], 'us-west-2' => [], ], ], ], ], [ 'defaults' => [ 'hostname' => '{service}.{region}.{dnsSuffix}', 'protocols' => [ 'https', ], 'signatureVersions' => [ 'v4', ], ], 'dnsSuffix' => 'amazonaws.com.cn', 'partition' => 'aws-cn', 'partitionName' => 'AWS China', 'regionRegex' => '^cn\\-\\w+\\-\\d+$', 'regions' => [ 'cn-north-1' => [ 'description' => 'China (Beijing)', ], 'cn-northwest-1' => [ 'description' => 'China (Ningxia)', ], ], 'services' => [ 'apigateway' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'application-autoscaling' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'application-autoscaling', ], 'hostname' => 'autoscaling.{region}.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'autoscaling' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'cloudformation' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'cloudtrail' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'codebuild' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'codedeploy' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'cognito-identity' => [ 'endpoints' => [ 'cn-north-1' => [], ], ], 'config' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'data.iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'iotdata', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], ], ], 'directconnect' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'dms' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ds' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'dynamodb' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ec2' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ecr' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ecs' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticache' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticbeanstalk' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticloadbalancing' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'elasticmapreduce' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'es' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'events' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'glacier' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'iam' => [ 'endpoints' => [ 'aws-cn-global' => [ 'credentialScope' => [ 'region' => 'cn-north-1', ], 'hostname' => 'iam.cn-north-1.amazonaws.com.cn', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-cn-global', ], 'iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'execute-api', ], ], 'endpoints' => [ 'cn-north-1' => [], ], ], 'kinesis' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'lambda' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'logs' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'monitoring' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'polly' => [ 'endpoints' => [ 'cn-northwest-1' => [], ], ], 'rds' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'redshift' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 's3' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 's3-control' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'cn-north-1' => [ 'credentialScope' => [ 'region' => 'cn-north-1', ], 'hostname' => 's3-control.cn-north-1.amazonaws.com.cn', 'signatureVersions' => [ 's3v4', ], ], 'cn-northwest-1' => [ 'credentialScope' => [ 'region' => 'cn-northwest-1', ], 'hostname' => 's3-control.cn-northwest-1.amazonaws.com.cn', 'signatureVersions' => [ 's3v4', ], ], ], ], 'sms' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'snowball' => [ 'endpoints' => [ 'cn-north-1' => [], ], ], 'sns' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'sqs' => [ 'defaults' => [ 'protocols' => [ 'http', 'https', ], 'sslCommonName' => '{region}.queue.{dnsSuffix}', ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'ssm' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'states' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'storagegateway' => [ 'endpoints' => [ 'cn-north-1' => [], ], ], 'streams.dynamodb' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'dynamodb', ], 'protocols' => [ 'http', 'https', ], ], 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'sts' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'swf' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'tagging' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], ], ], [ 'defaults' => [ 'hostname' => '{service}.{region}.{dnsSuffix}', 'protocols' => [ 'https', ], 'signatureVersions' => [ 'v4', ], ], 'dnsSuffix' => 'amazonaws.com', 'partition' => 'aws-us-gov', 'partitionName' => 'AWS GovCloud (US)', 'regionRegex' => '^us\\-gov\\-\\w+\\-\\d+$', 'regions' => [ 'us-gov-east-1' => [ 'description' => 'AWS GovCloud (US-East)', ], 'us-gov-west-1' => [ 'description' => 'AWS GovCloud (US)', ], ], 'services' => [ 'acm' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'api.sagemaker' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'apigateway' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'application-autoscaling' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'autoscaling' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'clouddirectory' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'cloudformation' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'cloudhsm' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'cloudhsmv2' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'cloudhsm', ], ], 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'cloudtrail' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'codedeploy' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 'codedeploy-fips.us-gov-east-1.amazonaws.com', ], 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'codedeploy-fips.us-gov-west-1.amazonaws.com', ], ], ], 'config' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'data.iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'iotdata', ], 'protocols' => [ 'https', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'directconnect' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'dms' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'ds' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'dynamodb' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'dynamodb.us-gov-west-1.amazonaws.com', ], ], ], 'ec2' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'ecr' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'ecs' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'elasticache' => [ 'endpoints' => [ 'fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'elasticache-fips.us-gov-west-1.amazonaws.com', ], 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'elasticbeanstalk' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'elasticfilesystem' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'elasticloadbalancing' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'elasticmapreduce' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'https', ], ], ], ], 'es' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'events' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'glacier' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'guardduty' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], 'isRegionalized' => true, ], 'iam' => [ 'endpoints' => [ 'aws-us-gov-global' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'iam.us-gov.amazonaws.com', ], ], 'isRegionalized' => false, 'partitionEndpoint' => 'aws-us-gov-global', ], 'inspector' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'iot' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'execute-api', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'kinesis' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'kms' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'lambda' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'logs' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'mediaconvert' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'metering.marketplace' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'aws-marketplace', ], ], 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'monitoring' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'polly' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'rds' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'redshift' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'rekognition' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'runtime.sagemaker' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 's3' => [ 'defaults' => [ 'signatureVersions' => [ 's3', 's3v4', ], ], 'endpoints' => [ 'fips-us-gov-west-1' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 's3-fips-us-gov-west-1.amazonaws.com', ], 'us-gov-east-1' => [ 'hostname' => 's3.us-gov-east-1.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], 'us-gov-west-1' => [ 'hostname' => 's3.us-gov-west-1.amazonaws.com', 'protocols' => [ 'http', 'https', ], ], ], ], 's3-control' => [ 'defaults' => [ 'protocols' => [ 'https', ], 'signatureVersions' => [ 's3v4', ], ], 'endpoints' => [ 'us-gov-east-1' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 's3-control.us-gov-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-gov-east-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 's3-control-fips.us-gov-east-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-gov-west-1' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 's3-control.us-gov-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 's3-control-fips.us-gov-west-1.amazonaws.com', 'signatureVersions' => [ 's3v4', ], ], ], ], 'sms' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'snowball' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'sns' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'sqs' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], 'sslCommonName' => '{region}.queue.{dnsSuffix}', ], ], ], 'ssm' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'states' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'storagegateway' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'streams.dynamodb' => [ 'defaults' => [ 'credentialScope' => [ 'service' => 'dynamodb', ], ], 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'dynamodb.us-gov-west-1.amazonaws.com', ], ], ], 'sts' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'swf' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'tagging' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'translate' => [ 'defaults' => [ 'protocols' => [ 'https', ], ], 'endpoints' => [ 'us-gov-west-1' => [], 'us-gov-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'translate-fips.us-gov-west-1.amazonaws.com', ], ], ], ], ], ], 'version' => 3,];
diff --git a/src/data/lambda/2015-03-31/docs-2.json b/src/data/lambda/2015-03-31/docs-2.json
index fd42d22840..9320ea35f6 100644
--- a/src/data/lambda/2015-03-31/docs-2.json
+++ b/src/data/lambda/2015-03-31/docs-2.json
@@ -2,54 +2,54 @@
"version": "2.0",
"service": "
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
", "operations": { - "AddLayerVersionPermission": "Adds permissions to the resource-based policy of a version of a function layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
", - "AddPermission": "Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use the push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source permission to invoke the Lambda function.
Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the unpublished version of the function), or include a version or alias. If a client uses a version or alias to invoke a function, use the Qualifier
parameter to apply permissions to that ARN. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:AddPermission
action.
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.
Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.
", + "AddLayerVersionPermission": "Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
", + "AddPermission": "Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal
. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com
or sns.amazonaws.com
. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn
or SourceAccount
. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies.
", + "CreateAlias": "Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig
parameter to specify a second version and the percentage of invocation requests that it receives.
Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
Creates a new Lambda function. The function configuration is created from the request parameters, and the code for the function is provided by a .zip file. The function name is case-sensitive.
This operation requires permission for the lambda:CreateFunction
action.
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
", - "DeleteEventSourceMapping": "Deletes an event source mapping.
", - "DeleteFunction": "Deletes a Lambda function. To delete a specific function version, use the Qualifier
parameter. Otherwise, all versions and aliases are deleted. Event source mappings are not deleted.
This operation requires permission for the lambda:DeleteFunction
action.
Removes concurrent execution limits from this function. For more information, see Managing Concurrency.
", - "DeleteLayerVersion": "Deletes a version of a function layer. Deleted versions can no longer be viewed or added to functions. However, a copy of the version remains in Lambda until no functions refer to it.
", + "CreateFunction": "Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
A function has an unpublished version, and can have published versions and aliases. A published version is a snapshot of your function code and configuration that can not be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish
parameter to create version 1
of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
If another account or a AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
", + "DeleteAlias": "Deletes a Lambda function alias.
", + "DeleteEventSourceMapping": "Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
", + "DeleteFunction": "Deletes a Lambda function. To delete a specific function version, use the Qualifier
parameter. Otherwise, all versions and aliases are deleted.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
", + "DeleteFunctionConcurrency": "Removes a concurrent execution limit from a function.
", + "DeleteLayerVersion": "Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
", "GetAccountSettings": "Retrieves details about your account's limits and usage in a region.
", - "GetAlias": "Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:GetAlias
action.
Returns details about an event source mapping.
", - "GetFunction": "Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
Use the Qualifier
parameter to retrieve a published version of the function. Otherwise, returns the unpublished version ($LATEST
). For more information, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunction
action.
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier
parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunctionConfiguration
operation.
Returns information about a version of a function layer, with a link to download the layer archive that's valid for 10 minutes.
", - "GetLayerVersionPolicy": "Returns the permission policy for a layer version. For more information, see AddLayerVersionPermission.
", - "GetPolicy": "Returns the resource policy associated with the specified Lambda function.
This action requires permission for the lambda:GetPolicy action.
Invokes a Lambda function. For an example, see Create the Lambda Function and Test It Manually.
Specify just a function name to invoke the latest version of the function. To invoke a published version, use the Qualifier
parameter to specify a version or alias.
If you use the RequestResponse
(synchronous) invocation option, the function will be invoked only once. If you use the Event
(asynchronous) invocation option, the function will be invoked at least once in response to an event and the function must be idempotent to handle this.
For functions with a long timeout, your client may be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction
action.
The TooManyRequestsException
noted below will return the following: ConcurrentInvocationLimitExceeded
will be returned if you have no functions with reserved concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds the account's unreserved concurrency limit. ReservedFunctionConcurrentInvocationLimitExceeded
will be returned when a function with reserved concurrency exceeds its configured concurrency limit.
For asynchronous function invocation, use Invoke.
Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.
This operation requires permission for the lambda:InvokeFunction
action.
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:ListAliases action.
", + "GetAlias": "Returns details about a Lambda function alias.
", + "GetEventSourceMapping": "Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
", + "GetFunction": "Returns information about function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details specific to that version are returned.
", + "GetFunctionConfiguration": "Returns a the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function's details, including function-level settings, use GetFunction.
", + "GetLayerVersion": "Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
", + "GetLayerVersionPolicy": "Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
", + "GetPolicy": "Returns the resource-based IAM policy for a function, version, or alias.
", + "Invoke": "Invokes a Lambda function. You can invoke a function synchronously and wait for the response, or asynchronously. To invoke a function asynchronously, set InvocationType
to Event
.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. To record function errors for asynchronous invocations, configure your function with a dead letter queue.
The status code in the API response does not reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException
if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded
) or function level (ReservedFunctionConcurrentInvocationLimitExceeded
).
For functions with a long timeout, your client may be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction
action.
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
", + "ListAliases": "Returns a list of aliases for a Lambda function.
", "ListEventSourceMappings": "Lists event source mappings. Specify an EventSourceArn
to only show event source mappings for a single event source.
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions
action.
If you are using the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
Lists the versions of a function layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
", - "ListLayers": "Lists function layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
", - "ListTags": "Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name). For more information on Tagging, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "ListVersionsByFunction": "Lists all versions of a function. For information about versioning, see AWS Lambda Function Versioning and Aliases.
", - "PublishLayerVersion": "Creates a function layer from a ZIP archive. Each time you call PublishLayerVersion
with the same version name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
", - "PublishVersion": "Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
", - "PutFunctionConcurrency": "Sets a limit on the number of concurrent executions available to this function. It is a subset of your account's total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see Managing Concurrency.
", - "RemoveLayerVersionPermission": "Removes a statement from the permissions policy for a layer version. For more information, see AddLayerVersionPermission.
", - "RemovePermission": "Removes permissions from a function. You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. When you remove permissions, disable the event source mapping or trigger configuration first to avoid errors.
Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the unpublished version of the function), or include a version or alias. If a client uses a version or alias to invoke a function, use the Qualifier
parameter to apply permissions to that ARN. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
You need permission for the lambda:RemovePermission
action.
Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "UntagResource": "Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name). For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "UpdateAlias": "Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:UpdateAlias action.
", + "ListFunctions": "Returns a list of Lambda functions, with the version-specific configuration of each.
Set FunctionVersion
to ALL
to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.
Lists the versions of an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.
", + "ListLayers": "Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.
", + "ListTags": "Returns a function's tags. You can also view tags with GetFunction.
", + "ListVersionsByFunction": "Returns a list of versions, with the version-specific configuration of each.
", + "PublishLayerVersion": "Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion
with the same version name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
", + "PublishVersion": "Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
AWS Lambda does not publish a version if the function's configuration and code hasn't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function prior to publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
", + "PutFunctionConcurrency": "Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both guarantees that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency.
", + "RemoveLayerVersionPermission": "Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
", + "RemovePermission": "Revokes function use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
", + "TagResource": "Adds tags to a function.
", + "UntagResource": "Removes tags from a function.
", + "UpdateAlias": "Updates the configuration of a Lambda function alias.
", "UpdateEventSourceMapping": "Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
", - "UpdateFunctionCode": "Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionCode
action.
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionConfiguration
action.
Updates a Lambda function's code.
The function's code is locked when you publish a version. You cannot modify the code of a published version, only the unpublished version.
", + "UpdateFunctionConfiguration": "Modify the version-specifc settings of a Lambda function.
These settings can vary between versions of a function and are locked when you publish a version. You cannot modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
" }, "shapes": { "AccountLimit": { - "base": "Provides limits of code size and concurrency associated with the current account and region. For more information or to request a limit increase for concurrent executions, see Lambda Limits.
", + "base": "Limits related to concurrency and code storage. All file and storage sizes are in bytes.
", "refs": { "GetAccountSettingsResponse$AccountLimit": "Limits related to concurrency and code storage.
" } }, "AccountUsage": { - "base": "Provides code size usage and function count associated with the current account and region.
", + "base": "The number of functions and amount of storage in use.
", "refs": { "GetAccountSettingsResponse$AccountUsage": "The number of functions and amount of storage in use.
" } @@ -57,7 +57,7 @@ "Action": { "base": null, "refs": { - "AddPermissionRequest$Action": "The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda:
followed by the API name . For example, lambda:CreateFunction
. You can use wildcard (lambda:*
) to grant permission for all AWS Lambda actions.
The action that the principal can use on the function. For example, lambda:InvokeFunction
or lambda:GetFunction
.
Alias name.
", - "CreateAliasRequest$Name": "Name for the alias you are creating.
", - "DeleteAliasRequest$Name": "Name of the alias to delete.
", - "GetAliasRequest$Name": "Name of the alias for which you want to retrieve information.
", - "UpdateAliasRequest$Name": "The alias name.
" + "AliasConfiguration$Name": "The name of the alias.
", + "CreateAliasRequest$Name": "The name of the alias.
", + "DeleteAliasRequest$Name": "The name of the alias.
", + "GetAliasRequest$Name": "The name of the alias.
", + "UpdateAliasRequest$Name": "The name of the alias.
" } }, "AliasConfiguration": { - "base": "Provides configuration information about a Lambda function version alias.
", + "base": "Provides configuration information about a Lambda function alias.
", "refs": { "AliasList$member": null } @@ -115,17 +115,17 @@ } }, "AliasRoutingConfiguration": { - "base": "The alias's traffic shifting configuration.
", + "base": "A Lambda function alias's traffic shifting configuration.
", "refs": { - "AliasConfiguration$RoutingConfig": "Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.
", - "CreateAliasRequest$RoutingConfig": "Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see Traffic Shifting Using Aliases.
", - "UpdateAliasRequest$RoutingConfig": "Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see Traffic Shifting Using Aliases.
" + "AliasConfiguration$RoutingConfig": "The routing configuration of the alias.
", + "CreateAliasRequest$RoutingConfig": "The routing configuration of the alias.
", + "UpdateAliasRequest$RoutingConfig": "The routing configuration of the alias.
" } }, "Arn": { "base": null, "refs": { - "AddPermissionRequest$SourceArn": "The Amazon Resource Name of the invoker.
If you add a permission to a service principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can invoke your Lambda function.
For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
", "CreateEventSourceMappingRequest$EventSourceArn": "The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
The Amazon Resource Name (ARN) of the event source.
", "ListEventSourceMappingsRequest$EventSourceArn": "The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
The base64-encoded contents of your zip file containing your deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
", + "FunctionCode$ZipFile": "The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
", "InvocationRequest$Payload": "JSON that you want to provide to your Lambda function as input.
", - "InvocationResponse$Payload": " It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse
.
In the event of a function error this field contains a message describing the error. For the Handled
errors the Lambda function will report this message. For Unhandled
errors AWS Lambda reports the message.
The response from the function, or an error object.
", "LayerVersionContentInput$ZipFile": "The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.
", - "UpdateFunctionCodeRequest$ZipFile": "The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions.
" + "UpdateFunctionCodeRequest$ZipFile": "The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
" } }, "BlobStream": { @@ -159,8 +159,8 @@ "base": null, "refs": { "CreateFunctionRequest$Publish": "Set to true to publish the first version of the function during creation.
", - "UpdateFunctionCodeRequest$Publish": "This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.
", - "UpdateFunctionCodeRequest$DryRun": "This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the CodeSha256
hash value of the provided code will also be computed and returned in the response.
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
", + "UpdateFunctionCodeRequest$DryRun": "Set to true to validate the request parameters and access permissions without modifying the function code.
" } }, "CodeStorageExceededException": { @@ -180,7 +180,7 @@ "Concurrency": { "base": null, "refs": { - "GetFunctionResponse$Concurrency": "The concurrent execution limit set for this function. For more information, see Managing Concurrency.
" + "GetFunctionResponse$Concurrency": "The function's reserved concurrency.
" } }, "CreateAliasRequest": { @@ -201,14 +201,14 @@ "Date": { "base": null, "refs": { - "CreateEventSourceMappingRequest$StartingPositionTimestamp": "With StartingPosition
set to AT_TIMESTAMP
, the Unix time in seconds from which to start reading.
The date that the event source mapping was last updated, in Unix time seconds.
" + "CreateEventSourceMappingRequest$StartingPositionTimestamp": "With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
The date that the event source mapping was last updated.
" } }, "DeadLetterConfig": { "base": "The dead letter queue for failed asynchronous invocations.
", "refs": { - "CreateFunctionRequest$DeadLetterConfig": "A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
", + "CreateFunctionRequest$DeadLetterConfig": "A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
", "FunctionConfiguration$DeadLetterConfig": "The function's dead letter queue.
", "UpdateFunctionConfigurationRequest$DeadLetterConfig": "A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
" } @@ -241,16 +241,16 @@ "Description": { "base": null, "refs": { - "AliasConfiguration$Description": "Alias description.
", - "CreateAliasRequest$Description": "Description of the alias.
", + "AliasConfiguration$Description": "A description of the alias.
", + "CreateAliasRequest$Description": "A description of the alias.
", "CreateFunctionRequest$Description": "A description of the function.
", "FunctionConfiguration$Description": "The function's description.
", "GetLayerVersionResponse$Description": "The description of the version.
", "LayerVersionsListItem$Description": "The description of the version.
", "PublishLayerVersionRequest$Description": "The description of the version.
", "PublishLayerVersionResponse$Description": "The description of the version.
", - "PublishVersionRequest$Description": "The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.
", - "UpdateAliasRequest$Description": "You can change the description of the alias using this parameter.
", + "PublishVersionRequest$Description": "Specify a description for the version to override the description in the function configuration.
", + "UpdateAliasRequest$Description": "A description of the alias.
", "UpdateFunctionConfigurationRequest$Description": "A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
" } }, @@ -340,37 +340,37 @@ "EventSourceToken": { "base": null, "refs": { - "AddPermissionRequest$EventSourceToken": "A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.
" + "AddPermissionRequest$EventSourceToken": "For Alexa Smart Home functions, a token that must be supplied by the invoker.
" } }, "FunctionArn": { "base": null, "refs": { - "AliasConfiguration$AliasArn": "Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA
that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.
The Amazon Resource Name (ARN) of the alias.
", "EventSourceMappingConfiguration$FunctionArn": "The ARN of the Lambda function.
", - "FunctionConfiguration$MasterArn": "The ARN of the master function.
", - "ListTagsRequest$Resource": "The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "TagResourceRequest$Resource": "The ARN (Amazon Resource Name) of the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "UntagResourceRequest$Resource": "The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
" + "FunctionConfiguration$MasterArn": "For Lambda@Edge functions, the ARN of the master function.
", + "ListTagsRequest$Resource": "The function's Amazon Resource Name (ARN).
", + "TagResourceRequest$Resource": "The function's Amazon Resource Name (ARN).
", + "UntagResourceRequest$Resource": "The function's Amazon Resource Name (ARN).
" } }, "FunctionCode": { - "base": "The code for the Lambda function. You can specify either an S3 location, or upload a deployment package directly.
", + "base": "The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.
", "refs": { "CreateFunctionRequest$Code": "The code for the function.
" } }, "FunctionCodeLocation": { - "base": "The object for the Lambda function location.
", + "base": "Details about a function's deployment package.
", "refs": { - "GetFunctionResponse$Code": "The function's code.
" + "GetFunctionResponse$Code": "The deployment package of the function or version.
" } }, "FunctionConfiguration": { - "base": "A Lambda function's configuration settings.
", + "base": "Details about a function's configuration.
", "refs": { "FunctionList$member": null, - "GetFunctionResponse$Configuration": "The function's configuration.
" + "GetFunctionResponse$Configuration": "The configuration of the function or version.
" } }, "FunctionList": { @@ -383,29 +383,29 @@ "FunctionName": { "base": null, "refs": { - "AddPermissionRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "AddPermissionRequest$FunctionName": "The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "CreateAliasRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "CreateEventSourceMappingRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
", - "CreateFunctionRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "CreateFunctionRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "DeleteAliasRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "DeleteFunctionConcurrencyRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "DeleteFunctionRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "DeleteFunctionConcurrencyRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "DeleteFunctionRequest$FunctionName": "The name of the Lambda function or version.
Name formats
Function name - my-function
(name-only), my-function:1
(with version).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "GetAliasRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "ListAliasesRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "ListEventSourceMappingsRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
", "PublishVersionRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "PutFunctionConcurrencyRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "RemovePermissionRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "PutFunctionConcurrencyRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "RemovePermissionRequest$FunctionName": "The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "UpdateAliasRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "UpdateEventSourceMappingRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
", - "UpdateFunctionCodeRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "UpdateFunctionConfigurationRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
" + "UpdateFunctionCodeRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "UpdateFunctionConfigurationRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
" } }, "FunctionVersion": { "base": null, "refs": { - "ListFunctionsRequest$FunctionVersion": "Set to ALL
to list all published versions. If not specified, only the latest unpublished version ARN is returned.
Set to ALL
to include entries for all published versions of each function.
This response contains the object for the Lambda function location (see FunctionCodeLocation.
", + "base": null, "refs": { } }, @@ -476,7 +476,7 @@ "Handler": { "base": null, "refs": { - "CreateFunctionRequest$Handler": "The name of the method within your code that Lambda calls to execute your function. For more information, see Programming Model.
", + "CreateFunctionRequest$Handler": "The name of the method within your code that Lambda calls to execute your function. The format includes the filename and can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
", "FunctionConfiguration$Handler": "The function Lambda calls to begin executing your function.
", "UpdateFunctionConfigurationRequest$Handler": "The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export
value in your function.
Number of simultaneous executions of your function per region. The default limit is 1000.
", - "InvocationResponse$StatusCode": "The HTTP status code will be in the 200 range for successful request. For the RequestResponse
invocation type this status code will be 200. For the Event
invocation type this status code will be 202. For the DryRun
invocation type the status code will be 204.
The maximum number of simultaneous function executions.
", + "InvocationResponse$StatusCode": "The HTTP status code will be in the 200 range for successful request. For the RequestResponse
invocation type this status code will be 200. For the Event
invocation type this status code will be 202. For the DryRun
invocation type the status code will be 204.
Upon success, returns an empty response. Otherwise, throws an exception.
", + "base": null, "refs": { } }, "InvocationType": { "base": null, "refs": { - "InvocationRequest$InvocationType": "Choose from the following options.
RequestResponse
(default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured).
DryRun
- Validate parameter values and verify that the user or role has permission to invoke the function.
Choose from the following options.
RequestResponse
(default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if configured). The API response only includes a status code.
DryRun
- Validate parameter values and verify that the user or role has permission to invoke the function.
The ARN of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.
", + "CreateFunctionRequest$KMSKeyArn": "The ARN of the AWS Key Management Service key used to encrypt your function's environment variables. If not provided, AWS Lambda uses a default service key.
", "FunctionConfiguration$KMSKeyArn": "The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.
", "UpdateFunctionConfigurationRequest$KMSKeyArn": "The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string (\"\") for this parameter.
" } @@ -579,7 +579,7 @@ } }, "Layer": { - "base": "A function layer.
", + "base": "An AWS Lambda layer.
", "refs": { "LayersReferenceList$member": null } @@ -587,29 +587,29 @@ "LayerArn": { "base": null, "refs": { - "GetLayerVersionResponse$LayerArn": "The Amazon Resource Name (ARN) of the function layer.
", + "GetLayerVersionResponse$LayerArn": "The ARN of the layer.
", "LayersListItem$LayerArn": "The Amazon Resource Name (ARN) of the function layer.
", - "PublishLayerVersionResponse$LayerArn": "The Amazon Resource Name (ARN) of the function layer.
" + "PublishLayerVersionResponse$LayerArn": "The ARN of the layer.
" } }, "LayerList": { "base": null, "refs": { - "CreateFunctionRequest$Layers": "A list of function layers to add to the function's execution environment.
", + "CreateFunctionRequest$Layers": "A list of function layers to add to the function's execution environment. Specify each layer by ARN, including the version.
", "UpdateFunctionConfigurationRequest$Layers": "A list of function layers to add to the function's execution environment.
" } }, "LayerName": { "base": null, "refs": { - "AddLayerVersionPermissionRequest$LayerName": "The name of the layer.
", - "DeleteLayerVersionRequest$LayerName": "The name of the layer.
", - "GetLayerVersionPolicyRequest$LayerName": "The name of the layer.
", - "GetLayerVersionRequest$LayerName": "The name of the layer.
", + "AddLayerVersionPermissionRequest$LayerName": "The name or Amazon Resource Name (ARN) of the layer.
", + "DeleteLayerVersionRequest$LayerName": "The name or Amazon Resource Name (ARN) of the layer.
", + "GetLayerVersionPolicyRequest$LayerName": "The name or Amazon Resource Name (ARN) of the layer.
", + "GetLayerVersionRequest$LayerName": "The name or Amazon Resource Name (ARN) of the layer.
", "LayersListItem$LayerName": "The name of the layer.
", - "ListLayerVersionsRequest$LayerName": "The name of the layer.
", - "PublishLayerVersionRequest$LayerName": "The name of the layer.
", - "RemoveLayerVersionPermissionRequest$LayerName": "The name of the layer.
" + "ListLayerVersionsRequest$LayerName": "The name or Amazon Resource Name (ARN) of the layer.
", + "PublishLayerVersionRequest$LayerName": "The name or Amazon Resource Name (ARN) of the layer.
", + "RemoveLayerVersionPermissionRequest$LayerName": "The name or Amazon Resource Name (ARN) of the layer.
" } }, "LayerPermissionAllowedAction": { @@ -635,13 +635,13 @@ } }, "LayerVersionContentInput": { - "base": "A ZIP archive that contains the contents of the function layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
", + "base": "A ZIP archive that contains the contents of an AWS Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
", "refs": { "PublishLayerVersionRequest$Content": "The function layer archive.
" } }, "LayerVersionContentOutput": { - "base": "Details about a layer version.
", + "base": "Details about a version of an AWS Lambda layer.
", "refs": { "GetLayerVersionResponse$Content": "Details about the layer version.
", "PublishLayerVersionResponse$Content": "Details about the layer version.
" @@ -667,7 +667,7 @@ } }, "LayerVersionsListItem": { - "base": "Details about a layer version.
", + "base": "Details about a version of an AWS Lambda layer.
", "refs": { "LayerVersionsList$member": null, "LayersListItem$LatestMatchingVersion": "The newest version of the layer.
" @@ -680,7 +680,7 @@ } }, "LayersListItem": { - "base": "Details about a function layer.
", + "base": "Details about an AWS Lambda layer.
", "refs": { "LayersList$member": null } @@ -688,7 +688,7 @@ "LayersReferenceList": { "base": null, "refs": { - "FunctionConfiguration$Layers": "A list of function layers.
" + "FunctionConfiguration$Layers": "The function's layers
" } }, "LicenseInfo": { @@ -773,17 +773,17 @@ "LogType": { "base": null, "refs": { - "InvocationRequest$LogType": "You can set this optional parameter to Tail
in the request only if you specify the InvocationType
parameter with value RequestResponse
. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result
header.
Set to Tail
to include the execution log in the response.
Maximum size, in bytes, of a code package you can upload per region. The default size is 75 GB.
", - "AccountLimit$CodeSizeUnzipped": "Size, in bytes, of code/dependencies that you can zip into a deployment package (uncompressed zip/jar size) for uploading. The default limit is 250 MB.
", - "AccountLimit$CodeSizeZipped": "Size, in bytes, of a single zipped code/dependencies package you can upload for your Lambda function(.zip/.jar file). Try using Amazon S3 for uploading larger files. Default limit is 50 MB.
", - "AccountUsage$TotalCodeSize": "Total size, in bytes, of the account's deployment packages per region.
", - "AccountUsage$FunctionCount": "The number of your account's existing functions per region.
", + "AccountLimit$TotalCodeSize": "The amount of storage space that you can use for all deployment packages and layer archives.
", + "AccountLimit$CodeSizeUnzipped": "The maximum size of your function's code and layers when extracted.
", + "AccountLimit$CodeSizeZipped": "The maximum size of a deployment package when uploaded direcly to AWS Lambda. Use Amazon S3 for larger files.
", + "AccountUsage$TotalCodeSize": "The amount of storage space, in bytes, in use by deployment packages and layer archives.
", + "AccountUsage$FunctionCount": "The number of Lambda functions.
", "FunctionConfiguration$CodeSize": "The size of the function's deployment package in bytes.
", "Layer$CodeSize": "The size of the layer archive in bytes.
", "LayerVersionContentOutput$CodeSize": "The size of the layer archive in bytes.
" @@ -792,7 +792,7 @@ "MasterRegion": { "base": null, "refs": { - "ListFunctionsRequest$MasterRegion": "Specify a region (e.g. us-east-2
) to only list functions that were created in that region, or ALL
to include functions replicated from any region. If specified, you also must specify the FunctionVersion
.
For Lambda@Edge functions, the region of the master function. For example, us-east-2
or ALL
. If specified, you must set FunctionVersion
to ALL
.
Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.
", + "ListAliasesRequest$MaxItems": "Limit the number of aliases returned.
", "ListEventSourceMappingsRequest$MaxItems": "The maximum number of event source mappings to return.
", - "ListFunctionsRequest$MaxItems": "Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0. The absolute maximum of AWS Lambda functions that can be returned is 50.
", - "ListVersionsByFunctionRequest$MaxItems": "Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.
" + "ListFunctionsRequest$MaxItems": "Specify a value between 1 and 50 to limit the number of functions in the response.
", + "ListVersionsByFunctionRequest$MaxItems": "Limit the number of versions returned.
" } }, "MemorySize": { @@ -822,18 +822,18 @@ "NameSpacedFunctionArn": { "base": null, "refs": { - "FunctionConfiguration$FunctionArn": "The function's Amazon Resource Name.
" + "FunctionConfiguration$FunctionArn": "The function's Amazon Resource Name (ARN).
" } }, "NamespacedFunctionName": { "base": null, "refs": { "FunctionConfiguration$FunctionName": "The name of the function.
", - "GetFunctionConfigurationRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "GetFunctionRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "GetPolicyRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "InvocationRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", - "InvokeAsyncRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "GetFunctionConfigurationRequest$FunctionName": "The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "GetFunctionRequest$FunctionName": "The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "GetPolicyRequest$FunctionName": "The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "InvocationRequest$FunctionName": "The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", + "InvokeAsyncRequest$FunctionName": "The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
", "ListVersionsByFunctionRequest$FunctionName": "The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
" } }, @@ -862,7 +862,7 @@ "Principal": { "base": null, "refs": { - "AddPermissionRequest$Principal": "The principal who is getting this permission. The principal can be an AWS service (e.g. s3.amazonaws.com
or sns.amazonaws.com
) for service triggers, or an account ID for cross-account access. If you specify a service as a principal, use the SourceArn
parameter to limit who can invoke the function through that service.
The AWS service or account that invokes the function. If you specify a service, use SourceArn
or SourceAccount
to limit who can invoke the function through that service.
Specify a version to delete. You cannot delete a version that is referenced by an alias.
", "GetFunctionConfigurationRequest$Qualifier": "Specify a version or alias to get details about a published version of the function.
", "GetFunctionRequest$Qualifier": "Specify a version or alias to get details about a published version of the function.
", - "GetPolicyRequest$Qualifier": "You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.
", + "GetPolicyRequest$Qualifier": "Specify a version or alias to get the policy for that resource.
", "InvocationRequest$Qualifier": "Specify a version or alias to invoke a published version of the function.
", "RemovePermissionRequest$Qualifier": "Specify a version or alias to remove permissions from a published version of the function.
" } @@ -916,7 +916,7 @@ "base": null, "refs": { "Concurrency$ReservedConcurrentExecutions": "The number of concurrent executions reserved for this function. For more information, see Managing Concurrency.
", - "PutFunctionConcurrencyRequest$ReservedConcurrentExecutions": "The concurrent execution limit reserved for this function.
" + "PutFunctionConcurrencyRequest$ReservedConcurrentExecutions": "The number of simultaneous executions to reserve for the function.
" } }, "ResourceArn": { @@ -931,7 +931,7 @@ } }, "ResourceInUseException": { - "base": "The operation conflicts with the resource's availability. For example, you attempted to update an EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state.
", + "base": "The operation conflicts with the resource's availability. For example, you attempted to update an EventSource Mapping in CREATING, or tried to delete a EventSource mapping currently in the UPDATING state.
", "refs": { } }, @@ -943,7 +943,7 @@ "RoleArn": { "base": null, "refs": { - "CreateFunctionRequest$Role": "The Amazon Resource Name (ARN) of the function's execution role.
", + "CreateFunctionRequest$Role": "The Amazon Resource Name (ARN) of the function's execution role.
", "FunctionConfiguration$Role": "The function's execution role.
", "UpdateFunctionConfigurationRequest$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
" } @@ -952,7 +952,7 @@ "base": null, "refs": { "CompatibleRuntimes$member": null, - "CreateFunctionRequest$Runtime": "The runtime version for the function.
", + "CreateFunctionRequest$Runtime": "The identifier of the function's runtime.
", "FunctionConfiguration$Runtime": "The runtime environment for the Lambda function.
", "ListLayerVersionsRequest$CompatibleRuntime": "A runtime identifier. For example, go1.x
.
A runtime identifier. For example, go1.x
.
An Amazon S3 bucket in the same region as your function.
", + "FunctionCode$S3Bucket": "An Amazon S3 bucket in the same region as your function. The bucket can be in a different AWS account.
", "LayerVersionContentInput$S3Bucket": "The Amazon S3 bucket of the layer archive.
", - "UpdateFunctionCodeRequest$S3Bucket": "Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.
" + "UpdateFunctionCodeRequest$S3Bucket": "An Amazon S3 bucket in the same region as your function. The bucket can be in a different AWS account.
" } }, "S3Key": { @@ -972,7 +972,7 @@ "refs": { "FunctionCode$S3Key": "The Amazon S3 key of the deployment package.
", "LayerVersionContentInput$S3Key": "The Amazon S3 key of the layer archive.
", - "UpdateFunctionCodeRequest$S3Key": "The Amazon S3 object (the deployment package) key name you want to upload.
" + "UpdateFunctionCodeRequest$S3Key": "The Amazon S3 key of the deployment package.
" } }, "S3ObjectVersion": { @@ -980,7 +980,7 @@ "refs": { "FunctionCode$S3ObjectVersion": "For versioned objects, the version of the deployment package object to use.
", "LayerVersionContentInput$S3ObjectVersion": "For versioned objects, the version of the layer archive object to use.
", - "UpdateFunctionCodeRequest$S3ObjectVersion": "The Amazon S3 object (the deployment package) version you want to upload.
" + "UpdateFunctionCodeRequest$S3ObjectVersion": "For versioned objects, the version of the deployment package object to use.
" } }, "SecurityGroupId": { @@ -1010,14 +1010,14 @@ "SourceOwner": { "base": null, "refs": { - "AddPermissionRequest$SourceAccount": "This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn
identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn
) owned by a specific account.
For AWS services, the ID of the account that owns the resource. Use instead of SourceArn
to grant permission to resources owned by another account (e.g. all of an account's Amazon S3 buckets). Or use together with SourceArn
to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.
An identifier that distinguishes the policy from others on the same layer version.
", - "AddPermissionRequest$StatementId": "A unique statement identifier.
", + "AddPermissionRequest$StatementId": "A statement identifier that differentiates the statement from others in the same policy.
", "RemoveLayerVersionPermissionRequest$StatementId": "The identifier that was specified when the statement was added.
" } }, @@ -1027,9 +1027,9 @@ "AddLayerVersionPermissionRequest$RevisionId": "Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
", "AddLayerVersionPermissionResponse$Statement": "The permission statement.
", "AddLayerVersionPermissionResponse$RevisionId": "A unique identifier for the current revision of the policy.
", - "AddPermissionRequest$RevisionId": "An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias
The permission statement you specified in the request. The response returns the same as a string using a backslash (\"\\\") as an escape character in the JSON.
", - "AliasConfiguration$RevisionId": "Represents the latest updated revision of the function or alias.
", + "AddPermissionRequest$RevisionId": "Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
", + "AddPermissionResponse$Statement": "The permission statement added to the function policy.
", + "AliasConfiguration$RevisionId": "A unique identifier that changes when you update the alias.
", "CodeStorageExceededException$Type": "The exception type.
", "CodeStorageExceededException$message": null, "DeleteEventSourceMappingRequest$UUID": "The identifier of the event source mapping.
", @@ -1047,15 +1047,15 @@ "EventSourceMappingConfiguration$LastProcessingResult": "The result of the last AWS Lambda invocation of your Lambda function.
", "EventSourceMappingConfiguration$State": "The state of the event source mapping. It can be one of the following: Creating
, Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
The cause of the last state change, either User initiated
or Lambda initiated
.
The repository from which you can download the function.
", - "FunctionCodeLocation$Location": "The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.
", + "FunctionCodeLocation$RepositoryType": "The service hosting the file.
", + "FunctionCodeLocation$Location": "A pre-signed URL that you can use to download the deployment package.
", "FunctionConfiguration$CodeSha256": "The SHA256 hash of the function's deployment package.
", "FunctionConfiguration$RevisionId": "Represents the latest updated revision of the function or alias.
", "GetEventSourceMappingRequest$UUID": "The identifier of the event source mapping.
", "GetLayerVersionPolicyResponse$Policy": "The policy document.
", "GetLayerVersionPolicyResponse$RevisionId": "A unique identifier for the current revision of the policy.
", - "GetPolicyResponse$Policy": "The resource policy associated with the specified function. The response returns the same as a string using a backslash (\"\\\") as an escape character in the JSON.
", - "GetPolicyResponse$RevisionId": "Represents the latest updated revision of the function or alias.
", + "GetPolicyResponse$Policy": "The resource-based policy.
", + "GetPolicyResponse$RevisionId": "A unique identifier for the current revision of the policy.
", "InvalidParameterValueException$Type": "The exception type.
", "InvalidParameterValueException$message": "The exception message.
", "InvalidRequestContentException$Type": "The exception type.
", @@ -1068,9 +1068,9 @@ "InvalidSubnetIDException$Message": null, "InvalidZipFileException$Type": null, "InvalidZipFileException$Message": null, - "InvocationRequest$ClientContext": "Using the ClientContext
you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext
JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.
The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.
ClientContext
information is returned only if you use the synchronous (RequestResponse
) invocation type.
Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled
or Unhandled
. Handled
errors are errors that are reported by the function while the Unhandled
errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled
error, see Programming Model.
It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse
and the logs were requested.
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
", + "InvocationResponse$FunctionError": "If present, indicates that an error occured during function execution. Details about the error are included in the response payload.
Handled
- The runtime caught an error thrown by the function and formatted it into a JSON document.
Unhandled
- The runtime did not handle the error. For example, the function ran out of memory or timed out.
The last 4 KB of the execution log, base64 encoded.
", "KMSAccessDeniedException$Type": null, "KMSAccessDeniedException$Message": null, "KMSDisabledException$Type": null, @@ -1081,26 +1081,26 @@ "KMSNotFoundException$Message": null, "LayerVersionContentOutput$Location": "A link to the layer archive in Amazon S3 that is valid for 10 minutes.
", "LayerVersionContentOutput$CodeSha256": "The SHA-256 hash of the layer archive.
", - "ListAliasesRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListAliases
operation. If present, indicates where to continue the listing.
A string, present if there are more aliases.
", + "ListAliasesRequest$Marker": "Specify the pagination token returned by a previous request to retrieve the next page of results.
", + "ListAliasesResponse$NextMarker": "Pagination token included if more results are available.
", "ListEventSourceMappingsRequest$Marker": "A pagination token returned by a previous call.
", "ListEventSourceMappingsResponse$NextMarker": "A pagination token that's returned when the response doesn't contain all event source mappings.
", - "ListFunctionsRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListFunctions
operation. If present, indicates where to continue the listing.
A string, present if there are more functions.
", + "ListFunctionsRequest$Marker": "Specify the pagination token returned by a previous request to retrieve the next page of results.
", + "ListFunctionsResponse$NextMarker": "Pagination token included if more results are available.
", "ListLayerVersionsRequest$Marker": "A pagination token returned by a previous call.
", "ListLayerVersionsResponse$NextMarker": "A pagination token returned when the response doesn't contain all versions.
", "ListLayersRequest$Marker": "A pagination token returned by a previous call.
", "ListLayersResponse$NextMarker": "A pagination token returned when the response doesn't contain all layers.
", - "ListVersionsByFunctionRequest$Marker": " Optional string. An opaque pagination token returned from a previous ListVersionsByFunction
operation. If present, indicates where to continue the listing.
A string, present if there are more function versions.
", + "ListVersionsByFunctionRequest$Marker": "Specify the pagination token returned by a previous request to retrieve the next page of results.
", + "ListVersionsByFunctionResponse$NextMarker": "Pagination token included if more results are available.
", "PolicyLengthExceededException$Type": null, "PolicyLengthExceededException$message": null, "PreconditionFailedException$Type": "The exception type.
", "PreconditionFailedException$message": "The exception message.
", - "PublishVersionRequest$CodeSha256": "The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter, the value must match the SHA256 of the $LATEST version for the publication to succeed. You can use the DryRun parameter of UpdateFunctionCode to verify the hash value that will be returned before publishing your new version.
", - "PublishVersionRequest$RevisionId": "An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
Only publish a version if the hash matches the value specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version you uploaded from the output of UpdateFunctionCode.
", + "PublishVersionRequest$RevisionId": "Only update the function if the revision ID matches the ID specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
", "RemoveLayerVersionPermissionRequest$RevisionId": "Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
", - "RemovePermissionRequest$RevisionId": "An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
", "RequestTooLargeException$Type": null, "RequestTooLargeException$message": null, "ResourceConflictException$Type": "The exception type.
", @@ -1118,10 +1118,10 @@ "TooManyRequestsException$message": null, "UnsupportedMediaTypeException$Type": null, "UnsupportedMediaTypeException$message": null, - "UpdateAliasRequest$RevisionId": "An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
Only update the alias if the revision ID matches the ID specified. Use this option to avoid modifying an alias that has changed since you last read it.
", "UpdateEventSourceMappingRequest$UUID": "The identifier of the event source mapping.
", - "UpdateFunctionCodeRequest$RevisionId": "An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either using using either GetFunction or GetAlias.
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
Only update the function if the revision ID matches the ID specified. Use this option to avoid modifying a function that has changed since you last read it.
", + "UpdateFunctionConfigurationRequest$RevisionId": "Only update the function if the revision ID matches the ID specified. Use this option to avoid modifying a function that has changed since you last read it.
" } }, "SubnetIPAddressLimitReachedException": { @@ -1152,7 +1152,7 @@ "TagKeyList": { "base": null, "refs": { - "UntagResourceRequest$TagKeys": "The list of tag keys to be deleted from the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
" + "UntagResourceRequest$TagKeys": "A list of tag keys to remove from the function.
" } }, "TagResourceRequest": { @@ -1169,10 +1169,10 @@ "Tags": { "base": null, "refs": { - "CreateFunctionRequest$Tags": "The list of tags (key-value pairs) assigned to the new function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "GetFunctionResponse$Tags": "Returns the list of tags associated with the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "ListTagsResponse$Tags": "The list of tags assigned to the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
", - "TagResourceRequest$Tags": "The list of tags (key-value pairs) you are assigning to the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
" + "CreateFunctionRequest$Tags": "A list of tags to apply to the function.
", + "GetFunctionResponse$Tags": "The function's tags.
", + "ListTagsResponse$Tags": "The function's tags.
", + "TagResourceRequest$Tags": "A list of tags to apply to the function.
" } }, "ThrottleReason": { @@ -1199,7 +1199,7 @@ } }, "TooManyRequestsException": { - "base": "Request throughput limit exceeded
", + "base": "Request throughput limit exceeded.
", "refs": { } }, @@ -1226,7 +1226,7 @@ "UnreservedConcurrentExecutions": { "base": null, "refs": { - "AccountLimit$UnreservedConcurrentExecutions": "The number of concurrent executions available to functions that do not have concurrency limits set. For more information, see Managing Concurrency.
" + "AccountLimit$UnreservedConcurrentExecutions": "The maximum number of simultaneous function executions, less the concurrency reserved for individual functions with PutFunctionConcurrency.
" } }, "UnsupportedMediaTypeException": { @@ -1262,18 +1262,18 @@ "Version": { "base": null, "refs": { - "AliasConfiguration$FunctionVersion": "Function version to which the alias points.
", - "CreateAliasRequest$FunctionVersion": "Lambda function version for which you are creating the alias.
", + "AliasConfiguration$FunctionVersion": "The function version that the alias invokes.
", + "CreateAliasRequest$FunctionVersion": "The function version that the alias invokes.
", "FunctionConfiguration$Version": "The version of the Lambda function.
", - "InvocationResponse$ExecutedVersion": "The function version that has been executed. This value is returned only if the invocation type is RequestResponse
. For more information, see Traffic Shifting Using Aliases.
If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.
", - "UpdateAliasRequest$FunctionVersion": "Using this parameter you can change the Lambda function version to which the alias points.
" + "InvocationResponse$ExecutedVersion": "The version of the function that executed. When you invoke a function with an alias, indicates which version the alias resolved to.
", + "ListAliasesRequest$FunctionVersion": "Specify a function version to only list aliases that invoke that version.
", + "UpdateAliasRequest$FunctionVersion": "The function version that the alias invokes.
" } }, "VpcConfig": { "base": "The VPC security groups and subnets attached to a Lambda function.
", "refs": { - "CreateFunctionRequest$VpcConfig": "If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
", + "CreateFunctionRequest$VpcConfig": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
", "UpdateFunctionConfigurationRequest$VpcConfig": "Specify security groups and subnets in a VPC to which your Lambda function needs access.
" } }, diff --git a/src/data/lambda/2015-03-31/docs-2.json.php b/src/data/lambda/2015-03-31/docs-2.json.php index 4aee906671..a9ed2fbcdd 100644 --- a/src/data/lambda/2015-03-31/docs-2.json.php +++ b/src/data/lambda/2015-03-31/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
', 'operations' => [ 'AddLayerVersionPermission' => 'Adds permissions to the resource-based policy of a version of a function layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
', 'AddPermission' => 'Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use the push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source permission to invoke the Lambda function.
Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the unpublished version of the function), or include a version or alias. If a client uses a version or alias to invoke a function, use the Qualifier
parameter to apply permissions to that ARN. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:AddPermission
action.
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.
Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.
', 'CreateEventSourceMapping' => 'Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
Creates a new Lambda function. The function configuration is created from the request parameters, and the code for the function is provided by a .zip file. The function name is case-sensitive.
This operation requires permission for the lambda:CreateFunction
action.
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
', 'DeleteEventSourceMapping' => 'Deletes an event source mapping.
', 'DeleteFunction' => 'Deletes a Lambda function. To delete a specific function version, use the Qualifier
parameter. Otherwise, all versions and aliases are deleted. Event source mappings are not deleted.
This operation requires permission for the lambda:DeleteFunction
action.
Removes concurrent execution limits from this function. For more information, see Managing Concurrency.
', 'DeleteLayerVersion' => 'Deletes a version of a function layer. Deleted versions can no longer be viewed or added to functions. However, a copy of the version remains in Lambda until no functions refer to it.
', 'GetAccountSettings' => 'Retrieves details about your account\'s limits and usage in a region.
', 'GetAlias' => 'Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:GetAlias
action.
Returns details about an event source mapping.
', 'GetFunction' => 'Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
Use the Qualifier
parameter to retrieve a published version of the function. Otherwise, returns the unpublished version ($LATEST
). For more information, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunction
action.
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier
parameter and specifying the function version or alias that points to it. If you don\'t provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunctionConfiguration
operation.
Returns information about a version of a function layer, with a link to download the layer archive that\'s valid for 10 minutes.
', 'GetLayerVersionPolicy' => 'Returns the permission policy for a layer version. For more information, see AddLayerVersionPermission.
', 'GetPolicy' => 'Returns the resource policy associated with the specified Lambda function.
This action requires permission for the lambda:GetPolicy action.
Invokes a Lambda function. For an example, see Create the Lambda Function and Test It Manually.
Specify just a function name to invoke the latest version of the function. To invoke a published version, use the Qualifier
parameter to specify a version or alias.
If you use the RequestResponse
(synchronous) invocation option, the function will be invoked only once. If you use the Event
(asynchronous) invocation option, the function will be invoked at least once in response to an event and the function must be idempotent to handle this.
For functions with a long timeout, your client may be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction
action.
The TooManyRequestsException
noted below will return the following: ConcurrentInvocationLimitExceeded
will be returned if you have no functions with reserved concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds the account\'s unreserved concurrency limit. ReservedFunctionConcurrentInvocationLimitExceeded
will be returned when a function with reserved concurrency exceeds its configured concurrency limit.
For asynchronous function invocation, use Invoke.
Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.
This operation requires permission for the lambda:InvokeFunction
action.
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:ListAliases action.
', 'ListEventSourceMappings' => 'Lists event source mappings. Specify an EventSourceArn
to only show event source mappings for a single event source.
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions
action.
If you are using the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
Lists the versions of a function layer. Versions that have been deleted aren\'t listed. Specify a runtime identifier to list only versions that indicate that they\'re compatible with that runtime.
', 'ListLayers' => 'Lists function layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they\'re compatible with that runtime.
', 'ListTags' => 'Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name). For more information on Tagging, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'ListVersionsByFunction' => 'Lists all versions of a function. For information about versioning, see AWS Lambda Function Versioning and Aliases.
', 'PublishLayerVersion' => 'Creates a function layer from a ZIP archive. Each time you call PublishLayerVersion
with the same version name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
', 'PublishVersion' => 'Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
', 'PutFunctionConcurrency' => 'Sets a limit on the number of concurrent executions available to this function. It is a subset of your account\'s total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see Managing Concurrency.
', 'RemoveLayerVersionPermission' => 'Removes a statement from the permissions policy for a layer version. For more information, see AddLayerVersionPermission.
', 'RemovePermission' => 'Removes permissions from a function. You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. When you remove permissions, disable the event source mapping or trigger configuration first to avoid errors.
Permissions apply to the Amazon Resource Name (ARN) used to invoke the function, which can be unqualified (the unpublished version of the function), or include a version or alias. If a client uses a version or alias to invoke a function, use the Qualifier
parameter to apply permissions to that ARN. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
You need permission for the lambda:RemovePermission
action.
Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'UntagResource' => 'Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name). For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'UpdateAlias' => 'Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:UpdateAlias action.
', 'UpdateEventSourceMapping' => 'Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
', 'UpdateFunctionCode' => 'Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionCode
action.
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function\'s code.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionConfiguration
action.
Provides limits of code size and concurrency associated with the current account and region. For more information or to request a limit increase for concurrent executions, see Lambda Limits.
', 'refs' => [ 'GetAccountSettingsResponse$AccountLimit' => 'Limits related to concurrency and code storage.
', ], ], 'AccountUsage' => [ 'base' => 'Provides code size usage and function count associated with the current account and region.
', 'refs' => [ 'GetAccountSettingsResponse$AccountUsage' => 'The number of functions and amount of storage in use.
', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$Action' => 'The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda:
followed by the API name . For example, lambda:CreateFunction
. You can use wildcard (lambda:*
) to grant permission for all AWS Lambda actions.
The name of the second alias, and the percentage of traffic that is routed to it.
', ], ], 'Alias' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$Name' => 'Alias name.
', 'CreateAliasRequest$Name' => 'Name for the alias you are creating.
', 'DeleteAliasRequest$Name' => 'Name of the alias to delete.
', 'GetAliasRequest$Name' => 'Name of the alias for which you want to retrieve information.
', 'UpdateAliasRequest$Name' => 'The alias name.
', ], ], 'AliasConfiguration' => [ 'base' => 'Provides configuration information about a Lambda function version alias.
', 'refs' => [ 'AliasList$member' => NULL, ], ], 'AliasList' => [ 'base' => NULL, 'refs' => [ 'ListAliasesResponse$Aliases' => 'A list of aliases.
', ], ], 'AliasRoutingConfiguration' => [ 'base' => 'The alias\'s traffic shifting configuration.
', 'refs' => [ 'AliasConfiguration$RoutingConfig' => 'Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version.
', 'CreateAliasRequest$RoutingConfig' => 'Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see Traffic Shifting Using Aliases.
', 'UpdateAliasRequest$RoutingConfig' => 'Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see Traffic Shifting Using Aliases.
', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceArn' => 'The Amazon Resource Name of the invoker.
If you add a permission to a service principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can invoke your Lambda function.
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
The Amazon Resource Name (ARN) of the event source.
', 'ListEventSourceMappingsRequest$EventSourceArn' => 'The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
The maximum number of items to retrieve in a single batch.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
The maximum number of items to retrieve in a single batch.
', 'UpdateEventSourceMappingRequest$BatchSize' => 'The maximum number of items to retrieve in a single batch.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
The base64-encoded contents of your zip file containing your deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
', 'InvocationRequest$Payload' => 'JSON that you want to provide to your Lambda function as input.
', 'InvocationResponse$Payload' => ' It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse
.
In the event of a function error this field contains a message describing the error. For the Handled
errors the Lambda function will report this message. For Unhandled
errors AWS Lambda reports the message.
The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.
', 'UpdateFunctionCodeRequest$ZipFile' => 'The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions.
', ], ], 'BlobStream' => [ 'base' => NULL, 'refs' => [ 'InvokeAsyncRequest$InvokeArgs' => 'JSON that you want to provide to your Lambda function as input.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Publish' => 'Set to true to publish the first version of the function during creation.
', 'UpdateFunctionCodeRequest$Publish' => 'This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.
', 'UpdateFunctionCodeRequest$DryRun' => 'This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the CodeSha256
hash value of the provided code will also be computed and returned in the response.
You have exceeded your maximum total code size per account. Limits
', 'refs' => [], ], 'CompatibleRuntimes' => [ 'base' => NULL, 'refs' => [ 'GetLayerVersionResponse$CompatibleRuntimes' => 'The layer\'s compatible runtimes.
', 'LayerVersionsListItem$CompatibleRuntimes' => 'The layer\'s compatible runtimes.
', 'PublishLayerVersionRequest$CompatibleRuntimes' => 'A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
', 'PublishLayerVersionResponse$CompatibleRuntimes' => 'The layer\'s compatible runtimes.
', ], ], 'Concurrency' => [ 'base' => NULL, 'refs' => [ 'GetFunctionResponse$Concurrency' => 'The concurrent execution limit set for this function. For more information, see Managing Concurrency.
', ], ], 'CreateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$StartingPositionTimestamp' => 'With StartingPosition
set to AT_TIMESTAMP
, the Unix time in seconds from which to start reading.
The date that the event source mapping was last updated, in Unix time seconds.
', ], ], 'DeadLetterConfig' => [ 'base' => 'The dead letter queue for failed asynchronous invocations.
', 'refs' => [ 'CreateFunctionRequest$DeadLetterConfig' => 'A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
', 'FunctionConfiguration$DeadLetterConfig' => 'The function\'s dead letter queue.
', 'UpdateFunctionConfigurationRequest$DeadLetterConfig' => 'A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
', ], ], 'DeleteAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFunctionConcurrencyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLayerVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$Description' => 'Alias description.
', 'CreateAliasRequest$Description' => 'Description of the alias.
', 'CreateFunctionRequest$Description' => 'A description of the function.
', 'FunctionConfiguration$Description' => 'The function\'s description.
', 'GetLayerVersionResponse$Description' => 'The description of the version.
', 'LayerVersionsListItem$Description' => 'The description of the version.
', 'PublishLayerVersionRequest$Description' => 'The description of the version.
', 'PublishLayerVersionResponse$Description' => 'The description of the version.
', 'PublishVersionRequest$Description' => 'The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.
', 'UpdateAliasRequest$Description' => 'You can change the description of the alias using this parameter.
', 'UpdateFunctionConfigurationRequest$Description' => 'A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
', ], ], 'EC2AccessDeniedException' => [ 'base' => 'Need additional permissions to configure VPC settings.
', 'refs' => [], ], 'EC2ThrottledException' => [ 'base' => 'AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
', 'refs' => [], ], 'EC2UnexpectedException' => [ 'base' => 'AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
', 'refs' => [], ], 'ENILimitReachedException' => [ 'base' => 'AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
', 'refs' => [], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$Enabled' => 'Disables the event source mapping to pause polling and invocation.
', 'UpdateEventSourceMappingRequest$Enabled' => 'Disables the event source mapping to pause polling and invocation.
', ], ], 'Environment' => [ 'base' => 'A function\'s environment variable settings.
', 'refs' => [ 'CreateFunctionRequest$Environment' => 'Environment variables that are accessible from function code during execution.
', 'UpdateFunctionConfigurationRequest$Environment' => 'The parent object that contains your environment\'s configuration settings.
', ], ], 'EnvironmentError' => [ 'base' => 'Error messages for environment variables that could not be applied.
', 'refs' => [ 'EnvironmentResponse$Error' => 'Error messages for environment variables that could not be applied.
', ], ], 'EnvironmentResponse' => [ 'base' => 'The results of a configuration update that applied environment variables.
', 'refs' => [ 'FunctionConfiguration$Environment' => 'The function\'s environment variables.
', ], ], 'EnvironmentVariableName' => [ 'base' => NULL, 'refs' => [ 'EnvironmentVariables$key' => NULL, ], ], 'EnvironmentVariableValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentVariables$value' => NULL, ], ], 'EnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'Environment$Variables' => 'Environment variable key-value pairs.
', 'EnvironmentResponse$Variables' => 'Environment variable key-value pairs.
', ], ], 'EventSourceMappingConfiguration' => [ 'base' => 'A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
', 'refs' => [ 'EventSourceMappingsList$member' => NULL, ], ], 'EventSourceMappingsList' => [ 'base' => NULL, 'refs' => [ 'ListEventSourceMappingsResponse$EventSourceMappings' => 'A list of event source mappings.
', ], ], 'EventSourcePosition' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$StartingPosition' => 'The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.
', ], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$AliasArn' => 'Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA
that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.
The ARN of the Lambda function.
', 'FunctionConfiguration$MasterArn' => 'The ARN of the master function.
', 'ListTagsRequest$Resource' => 'The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'TagResourceRequest$Resource' => 'The ARN (Amazon Resource Name) of the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'UntagResourceRequest$Resource' => 'The ARN (Amazon Resource Name) of the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', ], ], 'FunctionCode' => [ 'base' => 'The code for the Lambda function. You can specify either an S3 location, or upload a deployment package directly.
', 'refs' => [ 'CreateFunctionRequest$Code' => 'The code for the function.
', ], ], 'FunctionCodeLocation' => [ 'base' => 'The object for the Lambda function location.
', 'refs' => [ 'GetFunctionResponse$Code' => 'The function\'s code.
', ], ], 'FunctionConfiguration' => [ 'base' => 'A Lambda function\'s configuration settings.
', 'refs' => [ 'FunctionList$member' => NULL, 'GetFunctionResponse$Configuration' => 'The function\'s configuration.
', ], ], 'FunctionList' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsResponse$Functions' => 'A list of Lambda functions.
', 'ListVersionsByFunctionResponse$Versions' => 'A list of Lambda function versions.
', ], ], 'FunctionName' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'CreateAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'CreateEventSourceMappingRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it\'s limited to 64 characters in length.
', 'CreateFunctionRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'DeleteAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'DeleteFunctionConcurrencyRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'DeleteFunctionRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'GetAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'ListAliasesRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'ListEventSourceMappingsRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it\'s limited to 64 characters in length.
', 'PublishVersionRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'PutFunctionConcurrencyRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'RemovePermissionRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'UpdateAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'UpdateEventSourceMappingRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it\'s limited to 64 characters in length.
', 'UpdateFunctionCodeRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'UpdateFunctionConfigurationRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', ], ], 'FunctionVersion' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsRequest$FunctionVersion' => 'Set to ALL
to list all published versions. If not specified, only the latest unpublished version ARN is returned.
This response contains the object for the Lambda function location (see FunctionCodeLocation.
', 'refs' => [], ], 'GetLayerVersionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLayerVersionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLayerVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLayerVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Handler' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Handler' => 'The name of the method within your code that Lambda calls to execute your function. For more information, see Programming Model.
', 'FunctionConfiguration$Handler' => 'The function Lambda calls to begin executing your function.
', 'UpdateFunctionConfigurationRequest$Handler' => 'The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export
value in your function.
It will be 202 upon success.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$ConcurrentExecutions' => 'Number of simultaneous executions of your function per region. The default limit is 1000.
', 'InvocationResponse$StatusCode' => 'The HTTP status code will be in the 200 range for successful request. For the RequestResponse
invocation type this status code will be 200. For the Event
invocation type this status code will be 202. For the DryRun
invocation type the status code will be 204.
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this exception.
The request body could not be parsed as JSON.
', 'refs' => [], ], 'InvalidRuntimeException' => [ 'base' => 'The runtime or runtime version specified is not supported.
', 'refs' => [], ], 'InvalidSecurityGroupIDException' => [ 'base' => 'The Security Group ID provided in the Lambda function VPC configuration is invalid.
', 'refs' => [], ], 'InvalidSubnetIDException' => [ 'base' => 'The Subnet ID provided in the Lambda function VPC configuration is invalid.
', 'refs' => [], ], 'InvalidZipFileException' => [ 'base' => 'AWS Lambda could not unzip the deployment package.
', 'refs' => [], ], 'InvocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvocationResponse' => [ 'base' => 'Upon success, returns an empty response. Otherwise, throws an exception.
', 'refs' => [], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$InvocationType' => 'Choose from the following options.
RequestResponse
(default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the function\'s dead-letter queue (if configured).
DryRun
- Validate parameter values and verify that the user or role has permission to invoke the function.
Upon success, it returns empty response. Otherwise, throws an exception.
', 'refs' => [], ], 'KMSAccessDeniedException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function\'s KMS permissions.
', 'refs' => [], ], 'KMSDisabledException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function\'s KMS key settings.
', 'refs' => [], ], 'KMSInvalidStateException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function\'s KMS key settings.
', 'refs' => [], ], 'KMSKeyArn' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$KMSKeyArn' => 'The ARN of the KMS key used to encrypt your function\'s environment variables. If not provided, AWS Lambda will use a default service key.
', 'FunctionConfiguration$KMSKeyArn' => 'The KMS key used to encrypt the function\'s environment variables. Only returned if you\'ve configured a customer managed CMK.
', 'UpdateFunctionConfigurationRequest$KMSKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key used to encrypt your function\'s environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.
', ], ], 'KMSNotFoundException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function\'s KMS key settings.
', 'refs' => [], ], 'Layer' => [ 'base' => 'A function layer.
', 'refs' => [ 'LayersReferenceList$member' => NULL, ], ], 'LayerArn' => [ 'base' => NULL, 'refs' => [ 'GetLayerVersionResponse$LayerArn' => 'The Amazon Resource Name (ARN) of the function layer.
', 'LayersListItem$LayerArn' => 'The Amazon Resource Name (ARN) of the function layer.
', 'PublishLayerVersionResponse$LayerArn' => 'The Amazon Resource Name (ARN) of the function layer.
', ], ], 'LayerList' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Layers' => 'A list of function layers to add to the function\'s execution environment.
', 'UpdateFunctionConfigurationRequest$Layers' => 'A list of function layers to add to the function\'s execution environment.
', ], ], 'LayerName' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$LayerName' => 'The name of the layer.
', 'DeleteLayerVersionRequest$LayerName' => 'The name of the layer.
', 'GetLayerVersionPolicyRequest$LayerName' => 'The name of the layer.
', 'GetLayerVersionRequest$LayerName' => 'The name of the layer.
', 'LayersListItem$LayerName' => 'The name of the layer.
', 'ListLayerVersionsRequest$LayerName' => 'The name of the layer.
', 'PublishLayerVersionRequest$LayerName' => 'The name of the layer.
', 'RemoveLayerVersionPermissionRequest$LayerName' => 'The name of the layer.
', ], ], 'LayerPermissionAllowedAction' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$Action' => 'The API action that grants access to the layer. For example, lambda:GetLayerVersion
.
An account ID, or *
to grant permission to all AWS accounts.
The ARN of the layer version.
', 'Layer$Arn' => 'The Amazon Resource Name (ARN) of the function layer.
', 'LayerList$member' => NULL, 'LayerVersionsListItem$LayerVersionArn' => 'The ARN of the layer version.
', 'PublishLayerVersionResponse$LayerVersionArn' => 'The ARN of the layer version.
', ], ], 'LayerVersionContentInput' => [ 'base' => 'A ZIP archive that contains the contents of the function layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
', 'refs' => [ 'PublishLayerVersionRequest$Content' => 'The function layer archive.
', ], ], 'LayerVersionContentOutput' => [ 'base' => 'Details about a layer version.
', 'refs' => [ 'GetLayerVersionResponse$Content' => 'Details about the layer version.
', 'PublishLayerVersionResponse$Content' => 'Details about the layer version.
', ], ], 'LayerVersionNumber' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$VersionNumber' => 'The version number.
', 'DeleteLayerVersionRequest$VersionNumber' => 'The version number.
', 'GetLayerVersionPolicyRequest$VersionNumber' => 'The version number.
', 'GetLayerVersionRequest$VersionNumber' => 'The version number.
', 'GetLayerVersionResponse$Version' => 'The version number.
', 'LayerVersionsListItem$Version' => 'The version number.
', 'PublishLayerVersionResponse$Version' => 'The version number.
', 'RemoveLayerVersionPermissionRequest$VersionNumber' => 'The version number.
', ], ], 'LayerVersionsList' => [ 'base' => NULL, 'refs' => [ 'ListLayerVersionsResponse$LayerVersions' => 'A list of versions.
', ], ], 'LayerVersionsListItem' => [ 'base' => 'Details about a layer version.
', 'refs' => [ 'LayerVersionsList$member' => NULL, 'LayersListItem$LatestMatchingVersion' => 'The newest version of the layer.
', ], ], 'LayersList' => [ 'base' => NULL, 'refs' => [ 'ListLayersResponse$Layers' => 'A list of function layers.
', ], ], 'LayersListItem' => [ 'base' => 'Details about a function layer.
', 'refs' => [ 'LayersList$member' => NULL, ], ], 'LayersReferenceList' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$Layers' => 'A list of function layers.
', ], ], 'LicenseInfo' => [ 'base' => NULL, 'refs' => [ 'GetLayerVersionResponse$LicenseInfo' => 'The layer\'s software license.
', 'LayerVersionsListItem$LicenseInfo' => 'The layer\'s open-source license.
', 'PublishLayerVersionRequest$LicenseInfo' => 'The layer\'s software license. It can be any of the following:
An SPDX license identifier. For example, MIT
.
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT
.
The full text of the license.
The layer\'s software license.
', ], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEventSourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventSourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsResponse' => [ 'base' => 'A list of Lambda functions.
', 'refs' => [], ], 'ListLayerVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLayerVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLayersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLayersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVersionsByFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVersionsByFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$LogType' => 'You can set this optional parameter to Tail
in the request only if you specify the InvocationType
parameter with value RequestResponse
. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result
header.
Maximum size, in bytes, of a code package you can upload per region. The default size is 75 GB.
', 'AccountLimit$CodeSizeUnzipped' => 'Size, in bytes, of code/dependencies that you can zip into a deployment package (uncompressed zip/jar size) for uploading. The default limit is 250 MB.
', 'AccountLimit$CodeSizeZipped' => 'Size, in bytes, of a single zipped code/dependencies package you can upload for your Lambda function(.zip/.jar file). Try using Amazon S3 for uploading larger files. Default limit is 50 MB.
', 'AccountUsage$TotalCodeSize' => 'Total size, in bytes, of the account\'s deployment packages per region.
', 'AccountUsage$FunctionCount' => 'The number of your account\'s existing functions per region.
', 'FunctionConfiguration$CodeSize' => 'The size of the function\'s deployment package in bytes.
', 'Layer$CodeSize' => 'The size of the layer archive in bytes.
', 'LayerVersionContentOutput$CodeSize' => 'The size of the layer archive in bytes.
', ], ], 'MasterRegion' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsRequest$MasterRegion' => 'Specify a region (e.g. us-east-2
) to only list functions that were created in that region, or ALL
to include functions replicated from any region. If specified, you also must specify the FunctionVersion
.
The maximum number of versions to return.
', 'ListLayersRequest$MaxItems' => 'The maximum number of layers to return.
', ], ], 'MaxListItems' => [ 'base' => NULL, 'refs' => [ 'ListAliasesRequest$MaxItems' => 'Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.
', 'ListEventSourceMappingsRequest$MaxItems' => 'The maximum number of event source mappings to return.
', 'ListFunctionsRequest$MaxItems' => 'Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0. The absolute maximum of AWS Lambda functions that can be returned is 50.
', 'ListVersionsByFunctionRequest$MaxItems' => 'Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.
', ], ], 'MemorySize' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$MemorySize' => 'The amount of memory that your function has access to. Increasing the function\'s memory also increases it\'s CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
', 'FunctionConfiguration$MemorySize' => 'The memory allocated to the function
', 'UpdateFunctionConfigurationRequest$MemorySize' => 'The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
', ], ], 'NameSpacedFunctionArn' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$FunctionArn' => 'The function\'s Amazon Resource Name.
', ], ], 'NamespacedFunctionName' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$FunctionName' => 'The name of the function.
', 'GetFunctionConfigurationRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'GetFunctionRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'GetPolicyRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'InvocationRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'InvokeAsyncRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'ListVersionsByFunctionRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', ], ], 'NamespacedStatementId' => [ 'base' => NULL, 'refs' => [ 'RemovePermissionRequest$StatementId' => 'Statement ID of the permission to remove.
', ], ], 'OrganizationId' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$OrganizationId' => 'With the principal set to *
, grant permission to all accounts in the specified organization.
Lambda function access policy is limited to 20 KB.
', 'refs' => [], ], 'PreconditionFailedException' => [ 'base' => 'The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your resource.
The principal who is getting this permission. The principal can be an AWS service (e.g. s3.amazonaws.com
or sns.amazonaws.com
) for service triggers, or an account ID for cross-account access. If you specify a service as a principal, use the SourceArn
parameter to limit who can invoke the function through that service.
Specify a version or alias to add permissions to a published version of the function.
', 'DeleteFunctionRequest$Qualifier' => 'Specify a version to delete. You cannot delete a version that is referenced by an alias.
', 'GetFunctionConfigurationRequest$Qualifier' => 'Specify a version or alias to get details about a published version of the function.
', 'GetFunctionRequest$Qualifier' => 'Specify a version or alias to get details about a published version of the function.
', 'GetPolicyRequest$Qualifier' => 'You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don\'t provide this parameter, the API will return permissions that apply to the unqualified function ARN.
', 'InvocationRequest$Qualifier' => 'Specify a version or alias to invoke a published version of the function.
', 'RemovePermissionRequest$Qualifier' => 'Specify a version or alias to remove permissions from a published version of the function.
', ], ], 'RemoveLayerVersionPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemovePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestTooLargeException' => [ 'base' => 'The request payload exceeded the Invoke
request body JSON input limit. For more information, see Limits.
The number of concurrent executions reserved for this function. For more information, see Managing Concurrency.
', 'PutFunctionConcurrencyRequest$ReservedConcurrentExecutions' => 'The concurrent execution limit reserved for this function.
', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'DeadLetterConfig$TargetArn' => 'The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
', ], ], 'ResourceConflictException' => [ 'base' => 'The resource already exists.
', 'refs' => [], ], 'ResourceInUseException' => [ 'base' => 'The operation conflicts with the resource\'s availability. For example, you attempted to update an EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Role' => 'The Amazon Resource Name (ARN) of the function\'s execution role.
', 'FunctionConfiguration$Role' => 'The function\'s execution role.
', 'UpdateFunctionConfigurationRequest$Role' => 'The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
', ], ], 'Runtime' => [ 'base' => NULL, 'refs' => [ 'CompatibleRuntimes$member' => NULL, 'CreateFunctionRequest$Runtime' => 'The runtime version for the function.
', 'FunctionConfiguration$Runtime' => 'The runtime environment for the Lambda function.
', 'ListLayerVersionsRequest$CompatibleRuntime' => 'A runtime identifier. For example, go1.x
.
A runtime identifier. For example, go1.x
.
The runtime version for the function.
', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Bucket' => 'An Amazon S3 bucket in the same region as your function.
', 'LayerVersionContentInput$S3Bucket' => 'The Amazon S3 bucket of the layer archive.
', 'UpdateFunctionCodeRequest$S3Bucket' => 'Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.
', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Key' => 'The Amazon S3 key of the deployment package.
', 'LayerVersionContentInput$S3Key' => 'The Amazon S3 key of the layer archive.
', 'UpdateFunctionCodeRequest$S3Key' => 'The Amazon S3 object (the deployment package) key name you want to upload.
', ], ], 'S3ObjectVersion' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3ObjectVersion' => 'For versioned objects, the version of the deployment package object to use.
', 'LayerVersionContentInput$S3ObjectVersion' => 'For versioned objects, the version of the layer archive object to use.
', 'UpdateFunctionCodeRequest$S3ObjectVersion' => 'The Amazon S3 object (the deployment package) version you want to upload.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => 'A list of VPC security groups IDs.
', 'VpcConfigResponse$SecurityGroupIds' => 'A list of VPC security groups IDs.
', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'EnvironmentError$Message' => 'The error message.
', ], ], 'ServiceException' => [ 'base' => 'The AWS Lambda service encountered an internal error.
', 'refs' => [], ], 'SourceOwner' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceAccount' => 'This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn
identifies a bucket, then this is the bucket owner\'s account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don\'t specify the SourceArn
) owned by a specific account.
An identifier that distinguishes the policy from others on the same layer version.
', 'AddPermissionRequest$StatementId' => 'A unique statement identifier.
', 'RemoveLayerVersionPermissionRequest$StatementId' => 'The identifier that was specified when the statement was added.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$RevisionId' => 'Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
', 'AddLayerVersionPermissionResponse$Statement' => 'The permission statement.
', 'AddLayerVersionPermissionResponse$RevisionId' => 'A unique identifier for the current revision of the policy.
', 'AddPermissionRequest$RevisionId' => 'An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn\'t match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias
The permission statement you specified in the request. The response returns the same as a string using a backslash ("\\") as an escape character in the JSON.
', 'AliasConfiguration$RevisionId' => 'Represents the latest updated revision of the function or alias.
', 'CodeStorageExceededException$Type' => 'The exception type.
', 'CodeStorageExceededException$message' => NULL, 'DeleteEventSourceMappingRequest$UUID' => 'The identifier of the event source mapping.
', 'EC2AccessDeniedException$Type' => NULL, 'EC2AccessDeniedException$Message' => NULL, 'EC2ThrottledException$Type' => NULL, 'EC2ThrottledException$Message' => NULL, 'EC2UnexpectedException$Type' => NULL, 'EC2UnexpectedException$Message' => NULL, 'EC2UnexpectedException$EC2ErrorCode' => NULL, 'ENILimitReachedException$Type' => NULL, 'ENILimitReachedException$Message' => NULL, 'EnvironmentError$ErrorCode' => 'The error code.
', 'EventSourceMappingConfiguration$UUID' => 'The identifier of the event source mapping.
', 'EventSourceMappingConfiguration$LastProcessingResult' => 'The result of the last AWS Lambda invocation of your Lambda function.
', 'EventSourceMappingConfiguration$State' => 'The state of the event source mapping. It can be one of the following: Creating
, Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
The cause of the last state change, either User initiated
or Lambda initiated
.
The repository from which you can download the function.
', 'FunctionCodeLocation$Location' => 'The presigned URL you can use to download the function\'s .zip file that you previously uploaded. The URL is valid for up to 10 minutes.
', 'FunctionConfiguration$CodeSha256' => 'The SHA256 hash of the function\'s deployment package.
', 'FunctionConfiguration$RevisionId' => 'Represents the latest updated revision of the function or alias.
', 'GetEventSourceMappingRequest$UUID' => 'The identifier of the event source mapping.
', 'GetLayerVersionPolicyResponse$Policy' => 'The policy document.
', 'GetLayerVersionPolicyResponse$RevisionId' => 'A unique identifier for the current revision of the policy.
', 'GetPolicyResponse$Policy' => 'The resource policy associated with the specified function. The response returns the same as a string using a backslash ("\\") as an escape character in the JSON.
', 'GetPolicyResponse$RevisionId' => 'Represents the latest updated revision of the function or alias.
', 'InvalidParameterValueException$Type' => 'The exception type.
', 'InvalidParameterValueException$message' => 'The exception message.
', 'InvalidRequestContentException$Type' => 'The exception type.
', 'InvalidRequestContentException$message' => 'The exception message.
', 'InvalidRuntimeException$Type' => NULL, 'InvalidRuntimeException$Message' => NULL, 'InvalidSecurityGroupIDException$Type' => NULL, 'InvalidSecurityGroupIDException$Message' => NULL, 'InvalidSubnetIDException$Type' => NULL, 'InvalidSubnetIDException$Message' => NULL, 'InvalidZipFileException$Type' => NULL, 'InvalidZipFileException$Message' => NULL, 'InvocationRequest$ClientContext' => 'Using the ClientContext
you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext
JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.
The ClientContext JSON must be base64-encoded and has a maximum size of 3583 bytes.
ClientContext
information is returned only if you use the synchronous (RequestResponse
) invocation type.
Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled
or Unhandled
. Handled
errors are errors that are reported by the function while the Unhandled
errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled
error, see Programming Model.
It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse
and the logs were requested.
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
', 'LayerVersionContentOutput$CodeSha256' => 'The SHA-256 hash of the layer archive.
', 'ListAliasesRequest$Marker' => 'Optional string. An opaque pagination token returned from a previous ListAliases
operation. If present, indicates where to continue the listing.
A string, present if there are more aliases.
', 'ListEventSourceMappingsRequest$Marker' => 'A pagination token returned by a previous call.
', 'ListEventSourceMappingsResponse$NextMarker' => 'A pagination token that\'s returned when the response doesn\'t contain all event source mappings.
', 'ListFunctionsRequest$Marker' => 'Optional string. An opaque pagination token returned from a previous ListFunctions
operation. If present, indicates where to continue the listing.
A string, present if there are more functions.
', 'ListLayerVersionsRequest$Marker' => 'A pagination token returned by a previous call.
', 'ListLayerVersionsResponse$NextMarker' => 'A pagination token returned when the response doesn\'t contain all versions.
', 'ListLayersRequest$Marker' => 'A pagination token returned by a previous call.
', 'ListLayersResponse$NextMarker' => 'A pagination token returned when the response doesn\'t contain all layers.
', 'ListVersionsByFunctionRequest$Marker' => ' Optional string. An opaque pagination token returned from a previous ListVersionsByFunction
operation. If present, indicates where to continue the listing.
A string, present if there are more function versions.
', 'PolicyLengthExceededException$Type' => NULL, 'PolicyLengthExceededException$message' => NULL, 'PreconditionFailedException$Type' => 'The exception type.
', 'PreconditionFailedException$message' => 'The exception message.
', 'PublishVersionRequest$CodeSha256' => 'The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter, the value must match the SHA256 of the $LATEST version for the publication to succeed. You can use the DryRun parameter of UpdateFunctionCode to verify the hash value that will be returned before publishing your new version.
', 'PublishVersionRequest$RevisionId' => 'An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn\'t match the latest RevisionId
of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
', 'RemovePermissionRequest$RevisionId' => 'An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn\'t match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
The exception type.
', 'ResourceConflictException$message' => 'The exception message.
', 'ResourceInUseException$Type' => NULL, 'ResourceInUseException$Message' => NULL, 'ResourceNotFoundException$Type' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ServiceException$Type' => NULL, 'ServiceException$Message' => NULL, 'SubnetIPAddressLimitReachedException$Type' => NULL, 'SubnetIPAddressLimitReachedException$Message' => NULL, 'TooManyRequestsException$retryAfterSeconds' => 'The number of seconds the caller should wait before retrying.
', 'TooManyRequestsException$Type' => NULL, 'TooManyRequestsException$message' => NULL, 'UnsupportedMediaTypeException$Type' => NULL, 'UnsupportedMediaTypeException$message' => NULL, 'UpdateAliasRequest$RevisionId' => 'An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn\'t match the latest RevisionId
of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
The identifier of the event source mapping.
', 'UpdateFunctionCodeRequest$RevisionId' => 'An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn\'t match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either using using either GetFunction or GetAlias.
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn\'t match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either GetFunction or GetAlias.
AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
', 'refs' => [], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SubnetIds' => 'A list of VPC subnet IDs.
', 'VpcConfigResponse$SubnetIds' => 'A list of VPC subnet IDs.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The list of tag keys to be deleted from the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Tags' => 'The list of tags (key-value pairs) assigned to the new function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'GetFunctionResponse$Tags' => 'Returns the list of tags associated with the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'ListTagsResponse$Tags' => 'The list of tags assigned to the function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', 'TagResourceRequest$Tags' => 'The list of tags (key-value pairs) you are assigning to the Lambda function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
', ], ], 'ThrottleReason' => [ 'base' => NULL, 'refs' => [ 'TooManyRequestsException$Reason' => NULL, ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Timeout' => 'The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.
', 'FunctionConfiguration$Timeout' => 'The amount of time that Lambda allows a function to run before terminating it.
', 'UpdateFunctionConfigurationRequest$Timeout' => 'The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$LastModified' => 'The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
', 'GetLayerVersionResponse$CreatedDate' => 'The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
', 'LayerVersionsListItem$CreatedDate' => 'The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000
.
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
', ], ], 'TooManyRequestsException' => [ 'base' => 'Request throughput limit exceeded
', 'refs' => [], ], 'TracingConfig' => [ 'base' => 'The function\'s AWS X-Ray tracing configuration.
', 'refs' => [ 'CreateFunctionRequest$TracingConfig' => 'Set Mode
to Active
to sample and trace a subset of incoming requests with AWS X-Ray.
Set Mode
to Active
to sample and trace a subset of incoming requests with AWS X-Ray.
The function\'s AWS X-Ray tracing configuration.
', 'refs' => [ 'FunctionConfiguration$TracingConfig' => 'The function\'s AWS X-Ray tracing configuration.
', ], ], 'TracingMode' => [ 'base' => NULL, 'refs' => [ 'TracingConfig$Mode' => 'The tracing mode.
', 'TracingConfigResponse$Mode' => 'The tracing mode.
', ], ], 'UnreservedConcurrentExecutions' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$UnreservedConcurrentExecutions' => 'The number of concurrent executions available to functions that do not have concurrency limits set. For more information, see Managing Concurrency.
', ], ], 'UnsupportedMediaTypeException' => [ 'base' => 'The content type of the Invoke
request body is not JSON.
Function version to which the alias points.
', 'CreateAliasRequest$FunctionVersion' => 'Lambda function version for which you are creating the alias.
', 'FunctionConfiguration$Version' => 'The version of the Lambda function.
', 'InvocationResponse$ExecutedVersion' => 'The function version that has been executed. This value is returned only if the invocation type is RequestResponse
. For more information, see Traffic Shifting Using Aliases.
If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.
', 'UpdateAliasRequest$FunctionVersion' => 'Using this parameter you can change the Lambda function version to which the alias points.
', ], ], 'VpcConfig' => [ 'base' => 'The VPC security groups and subnets attached to a Lambda function.
', 'refs' => [ 'CreateFunctionRequest$VpcConfig' => 'If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
', 'UpdateFunctionConfigurationRequest$VpcConfig' => 'Specify security groups and subnets in a VPC to which your Lambda function needs access.
', ], ], 'VpcConfigResponse' => [ 'base' => 'The VPC security groups and subnets attached to a Lambda function.
', 'refs' => [ 'FunctionConfiguration$VpcConfig' => 'The function\'s networking configuration.
', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'VpcConfigResponse$VpcId' => 'The ID of the VPC.
', ], ], 'Weight' => [ 'base' => NULL, 'refs' => [ 'AdditionalVersionWeights$value' => NULL, ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
', 'operations' => [ 'AddLayerVersionPermission' => 'Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
', 'AddPermission' => 'Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal
. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com
or sns.amazonaws.com
. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn
or SourceAccount
. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies.
', 'CreateAlias' => 'Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the RoutingConfig
parameter to specify a second version and the percentage of invocation requests that it receives.
Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
A function has an unpublished version, and can have published versions and aliases. A published version is a snapshot of your function code and configuration that can not be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish
parameter to create version 1
of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
If another account or a AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.
', 'DeleteAlias' => 'Deletes a Lambda function alias.
', 'DeleteEventSourceMapping' => 'Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
', 'DeleteFunction' => 'Deletes a Lambda function. To delete a specific function version, use the Qualifier
parameter. Otherwise, all versions and aliases are deleted.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
', 'DeleteFunctionConcurrency' => 'Removes a concurrent execution limit from a function.
', 'DeleteLayerVersion' => 'Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.
', 'GetAccountSettings' => 'Retrieves details about your account\'s limits and usage in a region.
', 'GetAlias' => 'Returns details about a Lambda function alias.
', 'GetEventSourceMapping' => 'Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
', 'GetFunction' => 'Returns information about function or function version, with a link to download the deployment package that\'s valid for 10 minutes. If you specify a function version, only details specific to that version are returned.
', 'GetFunctionConfiguration' => 'Returns a the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.
To get all of a function\'s details, including function-level settings, use GetFunction.
', 'GetLayerVersion' => 'Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that\'s valid for 10 minutes.
', 'GetLayerVersionPolicy' => 'Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
', 'GetPolicy' => 'Returns the resource-based IAM policy for a function, version, or alias.
', 'Invoke' => 'Invokes a Lambda function. You can invoke a function synchronously and wait for the response, or asynchronously. To invoke a function asynchronously, set InvocationType
to Event
.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. To record function errors for asynchronous invocations, configure your function with a dead letter queue.
The status code in the API response does not reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function\'s code and configuration. For example, Lambda returns TooManyRequestsException
if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded
) or function level (ReservedFunctionConcurrentInvocationLimitExceeded
).
For functions with a long timeout, your client may be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction
action.
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
', 'ListAliases' => 'Returns a list of aliases for a Lambda function.
', 'ListEventSourceMappings' => 'Lists event source mappings. Specify an EventSourceArn
to only show event source mappings for a single event source.
Returns a list of Lambda functions, with the version-specific configuration of each.
Set FunctionVersion
to ALL
to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.
Lists the versions of an AWS Lambda layer. Versions that have been deleted aren\'t listed. Specify a runtime identifier to list only versions that indicate that they\'re compatible with that runtime.
', 'ListLayers' => 'Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they\'re compatible with that runtime.
', 'ListTags' => 'Returns a function\'s tags. You can also view tags with GetFunction.
', 'ListVersionsByFunction' => 'Returns a list of versions, with the version-specific configuration of each.
', 'PublishLayerVersion' => 'Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion
with the same version name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
', 'PublishVersion' => 'Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn\'t change.
AWS Lambda does not publish a version if the function\'s configuration and code hasn\'t changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function prior to publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.
', 'PutFunctionConcurrency' => 'Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both guarantees that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren\'t configured with a per-function limit. For more information, see Managing Concurrency.
', 'RemoveLayerVersionPermission' => 'Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.
', 'RemovePermission' => 'Revokes function use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.
', 'TagResource' => 'Adds tags to a function.
', 'UntagResource' => 'Removes tags from a function.
', 'UpdateAlias' => 'Updates the configuration of a Lambda function alias.
', 'UpdateEventSourceMapping' => 'Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
', 'UpdateFunctionCode' => 'Updates a Lambda function\'s code.
The function\'s code is locked when you publish a version. You cannot modify the code of a published version, only the unpublished version.
', 'UpdateFunctionConfiguration' => 'Modify the version-specifc settings of a Lambda function.
These settings can vary between versions of a function and are locked when you publish a version. You cannot modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.
', ], 'shapes' => [ 'AccountLimit' => [ 'base' => 'Limits related to concurrency and code storage. All file and storage sizes are in bytes.
', 'refs' => [ 'GetAccountSettingsResponse$AccountLimit' => 'Limits related to concurrency and code storage.
', ], ], 'AccountUsage' => [ 'base' => 'The number of functions and amount of storage in use.
', 'refs' => [ 'GetAccountSettingsResponse$AccountUsage' => 'The number of functions and amount of storage in use.
', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$Action' => 'The action that the principal can use on the function. For example, lambda:InvokeFunction
or lambda:GetFunction
.
The name of the second alias, and the percentage of traffic that is routed to it.
', ], ], 'Alias' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$Name' => 'The name of the alias.
', 'CreateAliasRequest$Name' => 'The name of the alias.
', 'DeleteAliasRequest$Name' => 'The name of the alias.
', 'GetAliasRequest$Name' => 'The name of the alias.
', 'UpdateAliasRequest$Name' => 'The name of the alias.
', ], ], 'AliasConfiguration' => [ 'base' => 'Provides configuration information about a Lambda function alias.
', 'refs' => [ 'AliasList$member' => NULL, ], ], 'AliasList' => [ 'base' => NULL, 'refs' => [ 'ListAliasesResponse$Aliases' => 'A list of aliases.
', ], ], 'AliasRoutingConfiguration' => [ 'base' => 'A Lambda function alias\'s traffic shifting configuration.
', 'refs' => [ 'AliasConfiguration$RoutingConfig' => 'The routing configuration of the alias.
', 'CreateAliasRequest$RoutingConfig' => 'The routing configuration of the alias.
', 'UpdateAliasRequest$RoutingConfig' => 'The routing configuration of the alias.
', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceArn' => 'For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
', 'CreateEventSourceMappingRequest$EventSourceArn' => 'The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
The Amazon Resource Name (ARN) of the event source.
', 'ListEventSourceMappingsRequest$EventSourceArn' => 'The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis - The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - The ARN of the stream.
Amazon Simple Queue Service - The ARN of the queue.
The maximum number of items to retrieve in a single batch.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
The maximum number of items to retrieve in a single batch.
', 'UpdateEventSourceMappingRequest$BatchSize' => 'The maximum number of items to retrieve in a single batch.
Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,000.
Amazon Simple Queue Service - Default 10. Max 10.
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
', 'InvocationRequest$Payload' => 'JSON that you want to provide to your Lambda function as input.
', 'InvocationResponse$Payload' => 'The response from the function, or an error object.
', 'LayerVersionContentInput$ZipFile' => 'The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.
', 'UpdateFunctionCodeRequest$ZipFile' => 'The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
', ], ], 'BlobStream' => [ 'base' => NULL, 'refs' => [ 'InvokeAsyncRequest$InvokeArgs' => 'JSON that you want to provide to your Lambda function as input.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Publish' => 'Set to true to publish the first version of the function during creation.
', 'UpdateFunctionCodeRequest$Publish' => 'Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
', 'UpdateFunctionCodeRequest$DryRun' => 'Set to true to validate the request parameters and access permissions without modifying the function code.
', ], ], 'CodeStorageExceededException' => [ 'base' => 'You have exceeded your maximum total code size per account. Limits
', 'refs' => [], ], 'CompatibleRuntimes' => [ 'base' => NULL, 'refs' => [ 'GetLayerVersionResponse$CompatibleRuntimes' => 'The layer\'s compatible runtimes.
', 'LayerVersionsListItem$CompatibleRuntimes' => 'The layer\'s compatible runtimes.
', 'PublishLayerVersionRequest$CompatibleRuntimes' => 'A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
', 'PublishLayerVersionResponse$CompatibleRuntimes' => 'The layer\'s compatible runtimes.
', ], ], 'Concurrency' => [ 'base' => NULL, 'refs' => [ 'GetFunctionResponse$Concurrency' => 'The function\'s reserved concurrency.
', ], ], 'CreateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$StartingPositionTimestamp' => 'With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
The date that the event source mapping was last updated.
', ], ], 'DeadLetterConfig' => [ 'base' => 'The dead letter queue for failed asynchronous invocations.
', 'refs' => [ 'CreateFunctionRequest$DeadLetterConfig' => 'A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
', 'FunctionConfiguration$DeadLetterConfig' => 'The function\'s dead letter queue.
', 'UpdateFunctionConfigurationRequest$DeadLetterConfig' => 'A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
', ], ], 'DeleteAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFunctionConcurrencyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLayerVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$Description' => 'A description of the alias.
', 'CreateAliasRequest$Description' => 'A description of the alias.
', 'CreateFunctionRequest$Description' => 'A description of the function.
', 'FunctionConfiguration$Description' => 'The function\'s description.
', 'GetLayerVersionResponse$Description' => 'The description of the version.
', 'LayerVersionsListItem$Description' => 'The description of the version.
', 'PublishLayerVersionRequest$Description' => 'The description of the version.
', 'PublishLayerVersionResponse$Description' => 'The description of the version.
', 'PublishVersionRequest$Description' => 'Specify a description for the version to override the description in the function configuration.
', 'UpdateAliasRequest$Description' => 'A description of the alias.
', 'UpdateFunctionConfigurationRequest$Description' => 'A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
', ], ], 'EC2AccessDeniedException' => [ 'base' => 'Need additional permissions to configure VPC settings.
', 'refs' => [], ], 'EC2ThrottledException' => [ 'base' => 'AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.
', 'refs' => [], ], 'EC2UnexpectedException' => [ 'base' => 'AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
', 'refs' => [], ], 'ENILimitReachedException' => [ 'base' => 'AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
', 'refs' => [], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$Enabled' => 'Disables the event source mapping to pause polling and invocation.
', 'UpdateEventSourceMappingRequest$Enabled' => 'Disables the event source mapping to pause polling and invocation.
', ], ], 'Environment' => [ 'base' => 'A function\'s environment variable settings.
', 'refs' => [ 'CreateFunctionRequest$Environment' => 'Environment variables that are accessible from function code during execution.
', 'UpdateFunctionConfigurationRequest$Environment' => 'The parent object that contains your environment\'s configuration settings.
', ], ], 'EnvironmentError' => [ 'base' => 'Error messages for environment variables that could not be applied.
', 'refs' => [ 'EnvironmentResponse$Error' => 'Error messages for environment variables that could not be applied.
', ], ], 'EnvironmentResponse' => [ 'base' => 'The results of a configuration update that applied environment variables.
', 'refs' => [ 'FunctionConfiguration$Environment' => 'The function\'s environment variables.
', ], ], 'EnvironmentVariableName' => [ 'base' => NULL, 'refs' => [ 'EnvironmentVariables$key' => NULL, ], ], 'EnvironmentVariableValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentVariables$value' => NULL, ], ], 'EnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'Environment$Variables' => 'Environment variable key-value pairs.
', 'EnvironmentResponse$Variables' => 'Environment variable key-value pairs.
', ], ], 'EventSourceMappingConfiguration' => [ 'base' => 'A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.
', 'refs' => [ 'EventSourceMappingsList$member' => NULL, ], ], 'EventSourceMappingsList' => [ 'base' => NULL, 'refs' => [ 'ListEventSourceMappingsResponse$EventSourceMappings' => 'A list of event source mappings.
', ], ], 'EventSourcePosition' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$StartingPosition' => 'The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP
is only supported for Amazon Kinesis streams.
For Alexa Smart Home functions, a token that must be supplied by the invoker.
', ], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$AliasArn' => 'The Amazon Resource Name (ARN) of the alias.
', 'EventSourceMappingConfiguration$FunctionArn' => 'The ARN of the Lambda function.
', 'FunctionConfiguration$MasterArn' => 'For Lambda@Edge functions, the ARN of the master function.
', 'ListTagsRequest$Resource' => 'The function\'s Amazon Resource Name (ARN).
', 'TagResourceRequest$Resource' => 'The function\'s Amazon Resource Name (ARN).
', 'UntagResourceRequest$Resource' => 'The function\'s Amazon Resource Name (ARN).
', ], ], 'FunctionCode' => [ 'base' => 'The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.
', 'refs' => [ 'CreateFunctionRequest$Code' => 'The code for the function.
', ], ], 'FunctionCodeLocation' => [ 'base' => 'Details about a function\'s deployment package.
', 'refs' => [ 'GetFunctionResponse$Code' => 'The deployment package of the function or version.
', ], ], 'FunctionConfiguration' => [ 'base' => 'Details about a function\'s configuration.
', 'refs' => [ 'FunctionList$member' => NULL, 'GetFunctionResponse$Configuration' => 'The configuration of the function or version.
', ], ], 'FunctionList' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsResponse$Functions' => 'A list of Lambda functions.
', 'ListVersionsByFunctionResponse$Versions' => 'A list of Lambda function versions.
', ], ], 'FunctionName' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$FunctionName' => 'The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'CreateAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'CreateEventSourceMappingRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it\'s limited to 64 characters in length.
', 'CreateFunctionRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'DeleteAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'DeleteFunctionConcurrencyRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'DeleteFunctionRequest$FunctionName' => 'The name of the Lambda function or version.
Name formats
Function name - my-function
(name-only), my-function:1
(with version).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'GetAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'ListAliasesRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'ListEventSourceMappingsRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it\'s limited to 64 characters in length.
', 'PublishVersionRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'PutFunctionConcurrencyRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'RemovePermissionRequest$FunctionName' => 'The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'UpdateAliasRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'UpdateEventSourceMappingRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it\'s limited to 64 characters in length.
', 'UpdateFunctionCodeRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'UpdateFunctionConfigurationRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', ], ], 'FunctionVersion' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsRequest$FunctionVersion' => 'Set to ALL
to include entries for all published versions of each function.
The name of the method within your code that Lambda calls to execute your function. The format includes the filename and can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
', 'FunctionConfiguration$Handler' => 'The function Lambda calls to begin executing your function.
', 'UpdateFunctionConfigurationRequest$Handler' => 'The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export
value in your function.
It will be 202 upon success.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$ConcurrentExecutions' => 'The maximum number of simultaneous function executions.
', 'InvocationResponse$StatusCode' => 'The HTTP status code will be in the 200 range for successful request. For the RequestResponse
invocation type this status code will be 200. For the Event
invocation type this status code will be 202. For the DryRun
invocation type the status code will be 204.
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction
or the UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this exception.
The request body could not be parsed as JSON.
', 'refs' => [], ], 'InvalidRuntimeException' => [ 'base' => 'The runtime or runtime version specified is not supported.
', 'refs' => [], ], 'InvalidSecurityGroupIDException' => [ 'base' => 'The Security Group ID provided in the Lambda function VPC configuration is invalid.
', 'refs' => [], ], 'InvalidSubnetIDException' => [ 'base' => 'The Subnet ID provided in the Lambda function VPC configuration is invalid.
', 'refs' => [], ], 'InvalidZipFileException' => [ 'base' => 'AWS Lambda could not unzip the deployment package.
', 'refs' => [], ], 'InvocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvocationResponse' => [ 'base' => NULL, 'refs' => [], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$InvocationType' => 'Choose from the following options.
RequestResponse
(default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.
Event
- Invoke the function asynchronously. Send events that fail multiple times to the function\'s dead-letter queue (if configured). The API response only includes a status code.
DryRun
- Validate parameter values and verify that the user or role has permission to invoke the function.
Upon success, it returns empty response. Otherwise, throws an exception.
', 'refs' => [], ], 'KMSAccessDeniedException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function\'s KMS permissions.
', 'refs' => [], ], 'KMSDisabledException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function\'s KMS key settings.
', 'refs' => [], ], 'KMSInvalidStateException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function\'s KMS key settings.
', 'refs' => [], ], 'KMSKeyArn' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$KMSKeyArn' => 'The ARN of the AWS Key Management Service key used to encrypt your function\'s environment variables. If not provided, AWS Lambda uses a default service key.
', 'FunctionConfiguration$KMSKeyArn' => 'The KMS key used to encrypt the function\'s environment variables. Only returned if you\'ve configured a customer managed CMK.
', 'UpdateFunctionConfigurationRequest$KMSKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key used to encrypt your function\'s environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter.
', ], ], 'KMSNotFoundException' => [ 'base' => 'Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function\'s KMS key settings.
', 'refs' => [], ], 'Layer' => [ 'base' => 'An AWS Lambda layer.
', 'refs' => [ 'LayersReferenceList$member' => NULL, ], ], 'LayerArn' => [ 'base' => NULL, 'refs' => [ 'GetLayerVersionResponse$LayerArn' => 'The ARN of the layer.
', 'LayersListItem$LayerArn' => 'The Amazon Resource Name (ARN) of the function layer.
', 'PublishLayerVersionResponse$LayerArn' => 'The ARN of the layer.
', ], ], 'LayerList' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Layers' => 'A list of function layers to add to the function\'s execution environment. Specify each layer by ARN, including the version.
', 'UpdateFunctionConfigurationRequest$Layers' => 'A list of function layers to add to the function\'s execution environment.
', ], ], 'LayerName' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$LayerName' => 'The name or Amazon Resource Name (ARN) of the layer.
', 'DeleteLayerVersionRequest$LayerName' => 'The name or Amazon Resource Name (ARN) of the layer.
', 'GetLayerVersionPolicyRequest$LayerName' => 'The name or Amazon Resource Name (ARN) of the layer.
', 'GetLayerVersionRequest$LayerName' => 'The name or Amazon Resource Name (ARN) of the layer.
', 'LayersListItem$LayerName' => 'The name of the layer.
', 'ListLayerVersionsRequest$LayerName' => 'The name or Amazon Resource Name (ARN) of the layer.
', 'PublishLayerVersionRequest$LayerName' => 'The name or Amazon Resource Name (ARN) of the layer.
', 'RemoveLayerVersionPermissionRequest$LayerName' => 'The name or Amazon Resource Name (ARN) of the layer.
', ], ], 'LayerPermissionAllowedAction' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$Action' => 'The API action that grants access to the layer. For example, lambda:GetLayerVersion
.
An account ID, or *
to grant permission to all AWS accounts.
The ARN of the layer version.
', 'Layer$Arn' => 'The Amazon Resource Name (ARN) of the function layer.
', 'LayerList$member' => NULL, 'LayerVersionsListItem$LayerVersionArn' => 'The ARN of the layer version.
', 'PublishLayerVersionResponse$LayerVersionArn' => 'The ARN of the layer version.
', ], ], 'LayerVersionContentInput' => [ 'base' => 'A ZIP archive that contains the contents of an AWS Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
', 'refs' => [ 'PublishLayerVersionRequest$Content' => 'The function layer archive.
', ], ], 'LayerVersionContentOutput' => [ 'base' => 'Details about a version of an AWS Lambda layer.
', 'refs' => [ 'GetLayerVersionResponse$Content' => 'Details about the layer version.
', 'PublishLayerVersionResponse$Content' => 'Details about the layer version.
', ], ], 'LayerVersionNumber' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$VersionNumber' => 'The version number.
', 'DeleteLayerVersionRequest$VersionNumber' => 'The version number.
', 'GetLayerVersionPolicyRequest$VersionNumber' => 'The version number.
', 'GetLayerVersionRequest$VersionNumber' => 'The version number.
', 'GetLayerVersionResponse$Version' => 'The version number.
', 'LayerVersionsListItem$Version' => 'The version number.
', 'PublishLayerVersionResponse$Version' => 'The version number.
', 'RemoveLayerVersionPermissionRequest$VersionNumber' => 'The version number.
', ], ], 'LayerVersionsList' => [ 'base' => NULL, 'refs' => [ 'ListLayerVersionsResponse$LayerVersions' => 'A list of versions.
', ], ], 'LayerVersionsListItem' => [ 'base' => 'Details about a version of an AWS Lambda layer.
', 'refs' => [ 'LayerVersionsList$member' => NULL, 'LayersListItem$LatestMatchingVersion' => 'The newest version of the layer.
', ], ], 'LayersList' => [ 'base' => NULL, 'refs' => [ 'ListLayersResponse$Layers' => 'A list of function layers.
', ], ], 'LayersListItem' => [ 'base' => 'Details about an AWS Lambda layer.
', 'refs' => [ 'LayersList$member' => NULL, ], ], 'LayersReferenceList' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$Layers' => 'The function\'s layers
', ], ], 'LicenseInfo' => [ 'base' => NULL, 'refs' => [ 'GetLayerVersionResponse$LicenseInfo' => 'The layer\'s software license.
', 'LayerVersionsListItem$LicenseInfo' => 'The layer\'s open-source license.
', 'PublishLayerVersionRequest$LicenseInfo' => 'The layer\'s software license. It can be any of the following:
An SPDX license identifier. For example, MIT
.
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT
.
The full text of the license.
The layer\'s software license.
', ], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEventSourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventSourceMappingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsResponse' => [ 'base' => 'A list of Lambda functions.
', 'refs' => [], ], 'ListLayerVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLayerVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLayersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLayersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVersionsByFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVersionsByFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$LogType' => 'Set to Tail
to include the execution log in the response.
The amount of storage space that you can use for all deployment packages and layer archives.
', 'AccountLimit$CodeSizeUnzipped' => 'The maximum size of your function\'s code and layers when extracted.
', 'AccountLimit$CodeSizeZipped' => 'The maximum size of a deployment package when uploaded direcly to AWS Lambda. Use Amazon S3 for larger files.
', 'AccountUsage$TotalCodeSize' => 'The amount of storage space, in bytes, in use by deployment packages and layer archives.
', 'AccountUsage$FunctionCount' => 'The number of Lambda functions.
', 'FunctionConfiguration$CodeSize' => 'The size of the function\'s deployment package in bytes.
', 'Layer$CodeSize' => 'The size of the layer archive in bytes.
', 'LayerVersionContentOutput$CodeSize' => 'The size of the layer archive in bytes.
', ], ], 'MasterRegion' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsRequest$MasterRegion' => 'For Lambda@Edge functions, the region of the master function. For example, us-east-2
or ALL
. If specified, you must set FunctionVersion
to ALL
.
The maximum number of versions to return.
', 'ListLayersRequest$MaxItems' => 'The maximum number of layers to return.
', ], ], 'MaxListItems' => [ 'base' => NULL, 'refs' => [ 'ListAliasesRequest$MaxItems' => 'Limit the number of aliases returned.
', 'ListEventSourceMappingsRequest$MaxItems' => 'The maximum number of event source mappings to return.
', 'ListFunctionsRequest$MaxItems' => 'Specify a value between 1 and 50 to limit the number of functions in the response.
', 'ListVersionsByFunctionRequest$MaxItems' => 'Limit the number of versions returned.
', ], ], 'MemorySize' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$MemorySize' => 'The amount of memory that your function has access to. Increasing the function\'s memory also increases it\'s CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
', 'FunctionConfiguration$MemorySize' => 'The memory allocated to the function
', 'UpdateFunctionConfigurationRequest$MemorySize' => 'The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
', ], ], 'NameSpacedFunctionArn' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$FunctionArn' => 'The function\'s Amazon Resource Name (ARN).
', ], ], 'NamespacedFunctionName' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$FunctionName' => 'The name of the function.
', 'GetFunctionConfigurationRequest$FunctionName' => 'The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'GetFunctionRequest$FunctionName' => 'The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'GetPolicyRequest$FunctionName' => 'The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'InvocationRequest$FunctionName' => 'The name of the Lambda function, version, or alias.
Name formats
Function name - my-function
(name-only), my-function:v1
(with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'InvokeAsyncRequest$FunctionName' => 'The name of the Lambda function.
Name formats
Function name - my-function
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function
.
Partial ARN - 123456789012:function:my-function
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', 'ListVersionsByFunctionRequest$FunctionName' => 'The name of the lambda function.
Name formats
Function name - MyFunction
.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.
Partial ARN - 123456789012:function:MyFunction
.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
', ], ], 'NamespacedStatementId' => [ 'base' => NULL, 'refs' => [ 'RemovePermissionRequest$StatementId' => 'Statement ID of the permission to remove.
', ], ], 'OrganizationId' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$OrganizationId' => 'With the principal set to *
, grant permission to all accounts in the specified organization.
Lambda function access policy is limited to 20 KB.
', 'refs' => [], ], 'PreconditionFailedException' => [ 'base' => 'The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction
or the GetAlias
API to retrieve the latest RevisionId for your resource.
The AWS service or account that invokes the function. If you specify a service, use SourceArn
or SourceAccount
to limit who can invoke the function through that service.
Specify a version or alias to add permissions to a published version of the function.
', 'DeleteFunctionRequest$Qualifier' => 'Specify a version to delete. You cannot delete a version that is referenced by an alias.
', 'GetFunctionConfigurationRequest$Qualifier' => 'Specify a version or alias to get details about a published version of the function.
', 'GetFunctionRequest$Qualifier' => 'Specify a version or alias to get details about a published version of the function.
', 'GetPolicyRequest$Qualifier' => 'Specify a version or alias to get the policy for that resource.
', 'InvocationRequest$Qualifier' => 'Specify a version or alias to invoke a published version of the function.
', 'RemovePermissionRequest$Qualifier' => 'Specify a version or alias to remove permissions from a published version of the function.
', ], ], 'RemoveLayerVersionPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemovePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestTooLargeException' => [ 'base' => 'The request payload exceeded the Invoke
request body JSON input limit. For more information, see Limits.
The number of concurrent executions reserved for this function. For more information, see Managing Concurrency.
', 'PutFunctionConcurrencyRequest$ReservedConcurrentExecutions' => 'The number of simultaneous executions to reserve for the function.
', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'DeadLetterConfig$TargetArn' => 'The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
', ], ], 'ResourceConflictException' => [ 'base' => 'The resource already exists.
', 'refs' => [], ], 'ResourceInUseException' => [ 'base' => 'The operation conflicts with the resource\'s availability. For example, you attempted to update an EventSource Mapping in CREATING, or tried to delete a EventSource mapping currently in the UPDATING state.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Role' => 'The Amazon Resource Name (ARN) of the function\'s execution role.
', 'FunctionConfiguration$Role' => 'The function\'s execution role.
', 'UpdateFunctionConfigurationRequest$Role' => 'The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
', ], ], 'Runtime' => [ 'base' => NULL, 'refs' => [ 'CompatibleRuntimes$member' => NULL, 'CreateFunctionRequest$Runtime' => 'The identifier of the function\'s runtime.
', 'FunctionConfiguration$Runtime' => 'The runtime environment for the Lambda function.
', 'ListLayerVersionsRequest$CompatibleRuntime' => 'A runtime identifier. For example, go1.x
.
A runtime identifier. For example, go1.x
.
The runtime version for the function.
', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Bucket' => 'An Amazon S3 bucket in the same region as your function. The bucket can be in a different AWS account.
', 'LayerVersionContentInput$S3Bucket' => 'The Amazon S3 bucket of the layer archive.
', 'UpdateFunctionCodeRequest$S3Bucket' => 'An Amazon S3 bucket in the same region as your function. The bucket can be in a different AWS account.
', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Key' => 'The Amazon S3 key of the deployment package.
', 'LayerVersionContentInput$S3Key' => 'The Amazon S3 key of the layer archive.
', 'UpdateFunctionCodeRequest$S3Key' => 'The Amazon S3 key of the deployment package.
', ], ], 'S3ObjectVersion' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3ObjectVersion' => 'For versioned objects, the version of the deployment package object to use.
', 'LayerVersionContentInput$S3ObjectVersion' => 'For versioned objects, the version of the layer archive object to use.
', 'UpdateFunctionCodeRequest$S3ObjectVersion' => 'For versioned objects, the version of the deployment package object to use.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => 'A list of VPC security groups IDs.
', 'VpcConfigResponse$SecurityGroupIds' => 'A list of VPC security groups IDs.
', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'EnvironmentError$Message' => 'The error message.
', ], ], 'ServiceException' => [ 'base' => 'The AWS Lambda service encountered an internal error.
', 'refs' => [], ], 'SourceOwner' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceAccount' => 'For AWS services, the ID of the account that owns the resource. Use instead of SourceArn
to grant permission to resources owned by another account (e.g. all of an account\'s Amazon S3 buckets). Or use together with SourceArn
to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.
An identifier that distinguishes the policy from others on the same layer version.
', 'AddPermissionRequest$StatementId' => 'A statement identifier that differentiates the statement from others in the same policy.
', 'RemoveLayerVersionPermissionRequest$StatementId' => 'The identifier that was specified when the statement was added.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddLayerVersionPermissionRequest$RevisionId' => 'Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
', 'AddLayerVersionPermissionResponse$Statement' => 'The permission statement.
', 'AddLayerVersionPermissionResponse$RevisionId' => 'A unique identifier for the current revision of the policy.
', 'AddPermissionRequest$RevisionId' => 'Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
', 'AddPermissionResponse$Statement' => 'The permission statement added to the function policy.
', 'AliasConfiguration$RevisionId' => 'A unique identifier that changes when you update the alias.
', 'CodeStorageExceededException$Type' => 'The exception type.
', 'CodeStorageExceededException$message' => NULL, 'DeleteEventSourceMappingRequest$UUID' => 'The identifier of the event source mapping.
', 'EC2AccessDeniedException$Type' => NULL, 'EC2AccessDeniedException$Message' => NULL, 'EC2ThrottledException$Type' => NULL, 'EC2ThrottledException$Message' => NULL, 'EC2UnexpectedException$Type' => NULL, 'EC2UnexpectedException$Message' => NULL, 'EC2UnexpectedException$EC2ErrorCode' => NULL, 'ENILimitReachedException$Type' => NULL, 'ENILimitReachedException$Message' => NULL, 'EnvironmentError$ErrorCode' => 'The error code.
', 'EventSourceMappingConfiguration$UUID' => 'The identifier of the event source mapping.
', 'EventSourceMappingConfiguration$LastProcessingResult' => 'The result of the last AWS Lambda invocation of your Lambda function.
', 'EventSourceMappingConfiguration$State' => 'The state of the event source mapping. It can be one of the following: Creating
, Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
The cause of the last state change, either User initiated
or Lambda initiated
.
The service hosting the file.
', 'FunctionCodeLocation$Location' => 'A pre-signed URL that you can use to download the deployment package.
', 'FunctionConfiguration$CodeSha256' => 'The SHA256 hash of the function\'s deployment package.
', 'FunctionConfiguration$RevisionId' => 'Represents the latest updated revision of the function or alias.
', 'GetEventSourceMappingRequest$UUID' => 'The identifier of the event source mapping.
', 'GetLayerVersionPolicyResponse$Policy' => 'The policy document.
', 'GetLayerVersionPolicyResponse$RevisionId' => 'A unique identifier for the current revision of the policy.
', 'GetPolicyResponse$Policy' => 'The resource-based policy.
', 'GetPolicyResponse$RevisionId' => 'A unique identifier for the current revision of the policy.
', 'InvalidParameterValueException$Type' => 'The exception type.
', 'InvalidParameterValueException$message' => 'The exception message.
', 'InvalidRequestContentException$Type' => 'The exception type.
', 'InvalidRequestContentException$message' => 'The exception message.
', 'InvalidRuntimeException$Type' => NULL, 'InvalidRuntimeException$Message' => NULL, 'InvalidSecurityGroupIDException$Type' => NULL, 'InvalidSecurityGroupIDException$Message' => NULL, 'InvalidSubnetIDException$Type' => NULL, 'InvalidSubnetIDException$Message' => NULL, 'InvalidZipFileException$Type' => NULL, 'InvalidZipFileException$Message' => NULL, 'InvocationRequest$ClientContext' => 'Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
', 'InvocationResponse$FunctionError' => 'If present, indicates that an error occured during function execution. Details about the error are included in the response payload.
Handled
- The runtime caught an error thrown by the function and formatted it into a JSON document.
Unhandled
- The runtime did not handle the error. For example, the function ran out of memory or timed out.
The last 4 KB of the execution log, base64 encoded.
', 'KMSAccessDeniedException$Type' => NULL, 'KMSAccessDeniedException$Message' => NULL, 'KMSDisabledException$Type' => NULL, 'KMSDisabledException$Message' => NULL, 'KMSInvalidStateException$Type' => NULL, 'KMSInvalidStateException$Message' => NULL, 'KMSNotFoundException$Type' => NULL, 'KMSNotFoundException$Message' => NULL, 'LayerVersionContentOutput$Location' => 'A link to the layer archive in Amazon S3 that is valid for 10 minutes.
', 'LayerVersionContentOutput$CodeSha256' => 'The SHA-256 hash of the layer archive.
', 'ListAliasesRequest$Marker' => 'Specify the pagination token returned by a previous request to retrieve the next page of results.
', 'ListAliasesResponse$NextMarker' => 'Pagination token included if more results are available.
', 'ListEventSourceMappingsRequest$Marker' => 'A pagination token returned by a previous call.
', 'ListEventSourceMappingsResponse$NextMarker' => 'A pagination token that\'s returned when the response doesn\'t contain all event source mappings.
', 'ListFunctionsRequest$Marker' => 'Specify the pagination token returned by a previous request to retrieve the next page of results.
', 'ListFunctionsResponse$NextMarker' => 'Pagination token included if more results are available.
', 'ListLayerVersionsRequest$Marker' => 'A pagination token returned by a previous call.
', 'ListLayerVersionsResponse$NextMarker' => 'A pagination token returned when the response doesn\'t contain all versions.
', 'ListLayersRequest$Marker' => 'A pagination token returned by a previous call.
', 'ListLayersResponse$NextMarker' => 'A pagination token returned when the response doesn\'t contain all layers.
', 'ListVersionsByFunctionRequest$Marker' => 'Specify the pagination token returned by a previous request to retrieve the next page of results.
', 'ListVersionsByFunctionResponse$NextMarker' => 'Pagination token included if more results are available.
', 'PolicyLengthExceededException$Type' => NULL, 'PolicyLengthExceededException$message' => NULL, 'PreconditionFailedException$Type' => 'The exception type.
', 'PreconditionFailedException$message' => 'The exception message.
', 'PublishVersionRequest$CodeSha256' => 'Only publish a version if the hash matches the value specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version you uploaded from the output of UpdateFunctionCode.
', 'PublishVersionRequest$RevisionId' => 'Only update the function if the revision ID matches the ID specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
', 'RemoveLayerVersionPermissionRequest$RevisionId' => 'Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
', 'RemovePermissionRequest$RevisionId' => 'Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.
', 'RequestTooLargeException$Type' => NULL, 'RequestTooLargeException$message' => NULL, 'ResourceConflictException$Type' => 'The exception type.
', 'ResourceConflictException$message' => 'The exception message.
', 'ResourceInUseException$Type' => NULL, 'ResourceInUseException$Message' => NULL, 'ResourceNotFoundException$Type' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ServiceException$Type' => NULL, 'ServiceException$Message' => NULL, 'SubnetIPAddressLimitReachedException$Type' => NULL, 'SubnetIPAddressLimitReachedException$Message' => NULL, 'TooManyRequestsException$retryAfterSeconds' => 'The number of seconds the caller should wait before retrying.
', 'TooManyRequestsException$Type' => NULL, 'TooManyRequestsException$message' => NULL, 'UnsupportedMediaTypeException$Type' => NULL, 'UnsupportedMediaTypeException$message' => NULL, 'UpdateAliasRequest$RevisionId' => 'Only update the alias if the revision ID matches the ID specified. Use this option to avoid modifying an alias that has changed since you last read it.
', 'UpdateEventSourceMappingRequest$UUID' => 'The identifier of the event source mapping.
', 'UpdateFunctionCodeRequest$RevisionId' => 'Only update the function if the revision ID matches the ID specified. Use this option to avoid modifying a function that has changed since you last read it.
', 'UpdateFunctionConfigurationRequest$RevisionId' => 'Only update the function if the revision ID matches the ID specified. Use this option to avoid modifying a function that has changed since you last read it.
', ], ], 'SubnetIPAddressLimitReachedException' => [ 'base' => 'AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
', 'refs' => [], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SubnetIds' => 'A list of VPC subnet IDs.
', 'VpcConfigResponse$SubnetIds' => 'A list of VPC subnet IDs.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'A list of tag keys to remove from the function.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Tags' => 'A list of tags to apply to the function.
', 'GetFunctionResponse$Tags' => 'The function\'s tags.
', 'ListTagsResponse$Tags' => 'The function\'s tags.
', 'TagResourceRequest$Tags' => 'A list of tags to apply to the function.
', ], ], 'ThrottleReason' => [ 'base' => NULL, 'refs' => [ 'TooManyRequestsException$Reason' => NULL, ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Timeout' => 'The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.
', 'FunctionConfiguration$Timeout' => 'The amount of time that Lambda allows a function to run before terminating it.
', 'UpdateFunctionConfigurationRequest$Timeout' => 'The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$LastModified' => 'The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
', 'GetLayerVersionResponse$CreatedDate' => 'The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
', 'LayerVersionsListItem$CreatedDate' => 'The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000
.
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
', ], ], 'TooManyRequestsException' => [ 'base' => 'Request throughput limit exceeded.
', 'refs' => [], ], 'TracingConfig' => [ 'base' => 'The function\'s AWS X-Ray tracing configuration.
', 'refs' => [ 'CreateFunctionRequest$TracingConfig' => 'Set Mode
to Active
to sample and trace a subset of incoming requests with AWS X-Ray.
Set Mode
to Active
to sample and trace a subset of incoming requests with AWS X-Ray.
The function\'s AWS X-Ray tracing configuration.
', 'refs' => [ 'FunctionConfiguration$TracingConfig' => 'The function\'s AWS X-Ray tracing configuration.
', ], ], 'TracingMode' => [ 'base' => NULL, 'refs' => [ 'TracingConfig$Mode' => 'The tracing mode.
', 'TracingConfigResponse$Mode' => 'The tracing mode.
', ], ], 'UnreservedConcurrentExecutions' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$UnreservedConcurrentExecutions' => 'The maximum number of simultaneous function executions, less the concurrency reserved for individual functions with PutFunctionConcurrency.
', ], ], 'UnsupportedMediaTypeException' => [ 'base' => 'The content type of the Invoke
request body is not JSON.
The function version that the alias invokes.
', 'CreateAliasRequest$FunctionVersion' => 'The function version that the alias invokes.
', 'FunctionConfiguration$Version' => 'The version of the Lambda function.
', 'InvocationResponse$ExecutedVersion' => 'The version of the function that executed. When you invoke a function with an alias, indicates which version the alias resolved to.
', 'ListAliasesRequest$FunctionVersion' => 'Specify a function version to only list aliases that invoke that version.
', 'UpdateAliasRequest$FunctionVersion' => 'The function version that the alias invokes.
', ], ], 'VpcConfig' => [ 'base' => 'The VPC security groups and subnets attached to a Lambda function.
', 'refs' => [ 'CreateFunctionRequest$VpcConfig' => 'For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
', 'UpdateFunctionConfigurationRequest$VpcConfig' => 'Specify security groups and subnets in a VPC to which your Lambda function needs access.
', ], ], 'VpcConfigResponse' => [ 'base' => 'The VPC security groups and subnets attached to a Lambda function.
', 'refs' => [ 'FunctionConfiguration$VpcConfig' => 'The function\'s networking configuration.
', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'VpcConfigResponse$VpcId' => 'The ID of the VPC.
', ], ], 'Weight' => [ 'base' => NULL, 'refs' => [ 'AdditionalVersionWeights$value' => NULL, ], ], ],]; diff --git a/src/data/lambda/2015-03-31/examples-1.json b/src/data/lambda/2015-03-31/examples-1.json index c5a45d3fc3..41c4bc60d9 100644 --- a/src/data/lambda/2015-03-31/examples-1.json +++ b/src/data/lambda/2015-03-31/examples-1.json @@ -36,7 +36,7 @@ "MemorySize": 128, "Publish": true, "Role": "arn:aws:iam::123456789012:role/service-role/role-name", - "Runtime": "nodejs4.3", + "Runtime": "nodejs8.10", "Timeout": 15, "VpcConfig": { } @@ -51,7 +51,7 @@ "LastModified": "2016-11-21T19:49:20.006+0000", "MemorySize": 128, "Role": "arn:aws:iam::123456789012:role/service-role/role-name", - "Runtime": "nodejs4.3", + "Runtime": "nodejs8.10", "Timeout": 123, "Version": "1", "VpcConfig": { @@ -226,7 +226,7 @@ "LastModified": "2016-11-21T19:49:20.006+0000", "MemorySize": 128, "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", - "Runtime": "nodejs4.3", + "Runtime": "nodejs8.10", "Timeout": 3, "Version": "$LATEST", "VpcConfig": { diff --git a/src/data/lambda/2015-03-31/examples-1.json.php b/src/data/lambda/2015-03-31/examples-1.json.php index 4b8428d8dc..553c1edfbe 100644 --- a/src/data/lambda/2015-03-31/examples-1.json.php +++ b/src/data/lambda/2015-03-31/examples-1.json.php @@ -1,3 +1,3 @@ '1.0', 'examples' => [ 'AddPermission' => [ [ 'input' => [ 'Action' => 'lambda:InvokeFunction', 'FunctionName' => 'MyFunction', 'Principal' => 's3.amazonaws.com', 'SourceAccount' => '123456789012', 'SourceArn' => 'arn:aws:s3:::examplebucket/*', 'StatementId' => 'ID-1', ], 'output' => [ 'Statement' => 'ID-1', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This example adds a permission for an S3 bucket to invoke a Lambda function.', 'id' => 'add-permission-1474651469455', 'title' => 'add-permission', ], ], 'CreateFunction' => [ [ 'input' => [ 'Code' => [], 'Description' => '', 'FunctionName' => 'MyFunction', 'Handler' => 'souce_file.handler_name', 'MemorySize' => 128, 'Publish' => true, 'Role' => 'arn:aws:iam::123456789012:role/service-role/role-name', 'Runtime' => 'nodejs4.3', 'Timeout' => 15, 'VpcConfig' => [], ], 'output' => [ 'CodeSha256' => '', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:MyFunction', 'FunctionName' => 'MyFunction', 'Handler' => 'source_file.handler_name', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/service-role/role-name', 'Runtime' => 'nodejs4.3', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [ 'Handler' => 'is of the form of the name of your source file and then name of your function handler', 'Role' => 'replace with the actual arn of the execution role you created', ], 'output' => [], ], 'description' => 'This example creates a Lambda function.', 'id' => 'create-function-1474653449931', 'title' => 'create-function', ], ], 'DeleteAlias' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Name' => 'alias', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation deletes a Lambda function alias', 'id' => 'to-delete-a-lambda-function-alias-1481660370804', 'title' => 'To delete a Lambda function alias', ], ], 'DeleteEventSourceMapping' => [ [ 'input' => [ 'UUID' => '12345kxodurf3443', ], 'output' => [ 'BatchSize' => 123, 'EventSourceArn' => 'arn:aws:s3:::examplebucket/*', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'LastProcessingResult' => '', 'State' => '', 'StateTransitionReason' => '', 'UUID' => '12345kxodurf3443', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation deletes a Lambda function event source mapping', 'id' => 'to-delete-a-lambda-function-event-source-mapping-1481658973862', 'title' => 'To delete a Lambda function event source mapping', ], ], 'DeleteFunction' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation deletes a Lambda function', 'id' => 'to-delete-a-lambda-function-1481648553696', 'title' => 'To delete a Lambda function', ], ], 'GetAccountSettings' => [ [ 'input' => [], 'output' => [ 'AccountLimit' => [], 'AccountUsage' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda customer\'s account settings', 'id' => 'to-retrieves-a-lambda-customers-account-settings-1481657495274', 'title' => 'To retrieves a Lambda customer\'s account settings', ], ], 'GetAlias' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Name' => 'myFunctionAlias', ], 'output' => [ 'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias', 'Description' => '', 'FunctionVersion' => '1', 'Name' => 'myFunctionAlias', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function alias', 'id' => 'to-retrieve-a-lambda-function-alias-1481648742254', 'title' => 'To retrieve a Lambda function alias', ], ], 'GetEventSourceMapping' => [ [ 'input' => [ 'UUID' => '123489-xxxxx-kdla8d89d7', ], 'output' => [ 'BatchSize' => 123, 'EventSourceArn' => 'arn:aws:iam::123456789012:eventsource', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'LastProcessingResult' => '', 'State' => '', 'StateTransitionReason' => '', 'UUID' => '123489-xxxxx-kdla8d89d7', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s event source mapping', 'id' => 'to-retrieve-a-lambda-functions-event-source-mapping-1481661622799', 'title' => 'To retrieve a Lambda function\'s event source mapping', ], ], 'GetFunction' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'output' => [ 'Code' => [ 'Location' => 'somelocation', 'RepositoryType' => 'S3', ], 'Configuration' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 262, 'Description' => 'A starter AWS Lambda function.', 'Environment' => [ 'Variables' => [ 'S3_BUCKET' => 'test', ], ], 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'nodejs4.3', 'Timeout' => 3, 'Version' => '$LATEST', 'VpcConfig' => [ 'SecurityGroupIds' => [], 'SubnetIds' => [], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s event source mapping', 'id' => 'to-retrieve-a-lambda-functions-event-source-mapping-1481661622799', 'title' => 'To retrieve a Lambda function\'s event source mapping', ], ], 'GetFunctionConfiguration' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'output' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 123, 'DeadLetterConfig' => [], 'Description' => '', 'Environment' => [], 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'KMSKeyArn' => '', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s event source mapping', 'id' => 'to-retrieve-a-lambda-functions-event-source-mapping-1481661622799', 'title' => 'To retrieve a Lambda function\'s event source mapping', ], ], 'GetPolicy' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'output' => [ 'Policy' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function policy', 'id' => 'to-retrieve-a-lambda-function-policy-1481649319053', 'title' => 'To retrieve a Lambda function policy', ], ], 'Invoke' => [ [ 'input' => [ 'ClientContext' => 'MyApp', 'FunctionName' => 'MyFunction', 'InvocationType' => 'Event', 'LogType' => 'Tail', 'Payload' => 'fileb://file-path/input.json', 'Qualifier' => '1', ], 'output' => [ 'FunctionError' => '', 'LogResult' => '', 'Payload' => '?', 'StatusCode' => 123, ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation invokes a Lambda function', 'id' => 'to-invoke-a-lambda-function-1481659683915', 'title' => 'To invoke a Lambda function', ], ], 'InvokeAsync' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'InvokeArgs' => 'fileb://file-path/input.json', ], 'output' => [ 'Status' => 123, ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation invokes a Lambda function asynchronously', 'id' => 'to-invoke-a-lambda-function-asynchronously-1481649694923', 'title' => 'To invoke a Lambda function asynchronously', ], ], 'ListAliases' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'FunctionVersion' => '1', 'Marker' => '', 'MaxItems' => 123, ], 'output' => [ 'Aliases' => [], 'NextMarker' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s aliases', 'id' => 'to-retrieve-a-lambda-function-aliases-1481650199732', 'title' => 'To retrieve a Lambda function aliases', ], ], 'ListFunctions' => [ [ 'input' => [ 'Marker' => '', 'MaxItems' => 123, ], 'output' => [ 'Functions' => [], 'NextMarker' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda functions', 'id' => 'to-retrieve-a-list-of-lambda-functions-1481650507425', 'title' => 'To retrieve a list of Lambda functions', ], ], 'ListVersionsByFunction' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Marker' => '', 'MaxItems' => 123, ], 'output' => [ 'NextMarker' => '', 'Versions' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function versions', 'id' => 'to-retrieve-a-list-of-lambda-function-versions-1481650603750', 'title' => 'To retrieve a list of Lambda function versions', ], ], 'PublishVersion' => [ [ 'input' => [ 'CodeSha256' => '', 'Description' => '', 'FunctionName' => 'myFunction', ], 'output' => [ 'CodeSha256' => '', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation publishes a version of a Lambda function', 'id' => 'to-publish-a-version-of-a-lambda-function-1481650704986', 'title' => 'To publish a version of a Lambda function', ], ], 'RemovePermission' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', 'StatementId' => 'role-statement-id', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation removes a Lambda function\'s permissions', 'id' => 'to-remove-a-lambda-functions-permissions-1481661337021', 'title' => 'To remove a Lambda function\'s permissions', ], ], 'UpdateAlias' => [ [ 'input' => [ 'Description' => '', 'FunctionName' => 'myFunction', 'FunctionVersion' => '1', 'Name' => 'functionAlias', ], 'output' => [ 'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:functionAlias', 'Description' => '', 'FunctionVersion' => '1', 'Name' => 'functionAlias', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function alias', 'id' => 'to-update-a-lambda-function-alias-1481650817950', 'title' => 'To update a Lambda function alias', ], ], 'UpdateEventSourceMapping' => [ [ 'input' => [ 'BatchSize' => 123, 'Enabled' => true, 'FunctionName' => 'myFunction', 'UUID' => '1234xCy789012', ], 'output' => [ 'BatchSize' => 123, 'EventSourceArn' => 'arn:aws:s3:::examplebucket/*', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'LastProcessingResult' => '', 'State' => '', 'StateTransitionReason' => '', 'UUID' => '1234xCy789012', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function event source mapping', 'id' => 'to-update-a-lambda-function-event-source-mapping-1481650907413', 'title' => 'To update a Lambda function event source mapping', ], ], 'UpdateFunctionCode' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Publish' => true, 'S3Bucket' => 'myBucket', 'S3Key' => 'myKey', 'S3ObjectVersion' => '1', 'ZipFile' => 'fileb://file-path/file.zip', ], 'output' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function\'s code', 'id' => 'to-update-a-lambda-functions-code-1481650992672', 'title' => 'To update a Lambda function\'s code', ], ], 'UpdateFunctionConfiguration' => [ [ 'input' => [ 'Description' => '', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'VpcConfig' => [], ], 'output' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function\'s configuration', 'id' => 'to-update-a-lambda-functions-configuration-1481651096447', 'title' => 'To update a Lambda function\'s configuration', ], ], ],]; +return [ 'version' => '1.0', 'examples' => [ 'AddPermission' => [ [ 'input' => [ 'Action' => 'lambda:InvokeFunction', 'FunctionName' => 'MyFunction', 'Principal' => 's3.amazonaws.com', 'SourceAccount' => '123456789012', 'SourceArn' => 'arn:aws:s3:::examplebucket/*', 'StatementId' => 'ID-1', ], 'output' => [ 'Statement' => 'ID-1', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This example adds a permission for an S3 bucket to invoke a Lambda function.', 'id' => 'add-permission-1474651469455', 'title' => 'add-permission', ], ], 'CreateFunction' => [ [ 'input' => [ 'Code' => [], 'Description' => '', 'FunctionName' => 'MyFunction', 'Handler' => 'souce_file.handler_name', 'MemorySize' => 128, 'Publish' => true, 'Role' => 'arn:aws:iam::123456789012:role/service-role/role-name', 'Runtime' => 'nodejs8.10', 'Timeout' => 15, 'VpcConfig' => [], ], 'output' => [ 'CodeSha256' => '', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:MyFunction', 'FunctionName' => 'MyFunction', 'Handler' => 'source_file.handler_name', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/service-role/role-name', 'Runtime' => 'nodejs8.10', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [ 'Handler' => 'is of the form of the name of your source file and then name of your function handler', 'Role' => 'replace with the actual arn of the execution role you created', ], 'output' => [], ], 'description' => 'This example creates a Lambda function.', 'id' => 'create-function-1474653449931', 'title' => 'create-function', ], ], 'DeleteAlias' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Name' => 'alias', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation deletes a Lambda function alias', 'id' => 'to-delete-a-lambda-function-alias-1481660370804', 'title' => 'To delete a Lambda function alias', ], ], 'DeleteEventSourceMapping' => [ [ 'input' => [ 'UUID' => '12345kxodurf3443', ], 'output' => [ 'BatchSize' => 123, 'EventSourceArn' => 'arn:aws:s3:::examplebucket/*', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'LastProcessingResult' => '', 'State' => '', 'StateTransitionReason' => '', 'UUID' => '12345kxodurf3443', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation deletes a Lambda function event source mapping', 'id' => 'to-delete-a-lambda-function-event-source-mapping-1481658973862', 'title' => 'To delete a Lambda function event source mapping', ], ], 'DeleteFunction' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation deletes a Lambda function', 'id' => 'to-delete-a-lambda-function-1481648553696', 'title' => 'To delete a Lambda function', ], ], 'GetAccountSettings' => [ [ 'input' => [], 'output' => [ 'AccountLimit' => [], 'AccountUsage' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda customer\'s account settings', 'id' => 'to-retrieves-a-lambda-customers-account-settings-1481657495274', 'title' => 'To retrieves a Lambda customer\'s account settings', ], ], 'GetAlias' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Name' => 'myFunctionAlias', ], 'output' => [ 'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias', 'Description' => '', 'FunctionVersion' => '1', 'Name' => 'myFunctionAlias', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function alias', 'id' => 'to-retrieve-a-lambda-function-alias-1481648742254', 'title' => 'To retrieve a Lambda function alias', ], ], 'GetEventSourceMapping' => [ [ 'input' => [ 'UUID' => '123489-xxxxx-kdla8d89d7', ], 'output' => [ 'BatchSize' => 123, 'EventSourceArn' => 'arn:aws:iam::123456789012:eventsource', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'LastProcessingResult' => '', 'State' => '', 'StateTransitionReason' => '', 'UUID' => '123489-xxxxx-kdla8d89d7', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s event source mapping', 'id' => 'to-retrieve-a-lambda-functions-event-source-mapping-1481661622799', 'title' => 'To retrieve a Lambda function\'s event source mapping', ], ], 'GetFunction' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'output' => [ 'Code' => [ 'Location' => 'somelocation', 'RepositoryType' => 'S3', ], 'Configuration' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 262, 'Description' => 'A starter AWS Lambda function.', 'Environment' => [ 'Variables' => [ 'S3_BUCKET' => 'test', ], ], 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'nodejs8.10', 'Timeout' => 3, 'Version' => '$LATEST', 'VpcConfig' => [ 'SecurityGroupIds' => [], 'SubnetIds' => [], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s event source mapping', 'id' => 'to-retrieve-a-lambda-functions-event-source-mapping-1481661622799', 'title' => 'To retrieve a Lambda function\'s event source mapping', ], ], 'GetFunctionConfiguration' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'output' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 123, 'DeadLetterConfig' => [], 'Description' => '', 'Environment' => [], 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'KMSKeyArn' => '', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s event source mapping', 'id' => 'to-retrieve-a-lambda-functions-event-source-mapping-1481661622799', 'title' => 'To retrieve a Lambda function\'s event source mapping', ], ], 'GetPolicy' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', ], 'output' => [ 'Policy' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function policy', 'id' => 'to-retrieve-a-lambda-function-policy-1481649319053', 'title' => 'To retrieve a Lambda function policy', ], ], 'Invoke' => [ [ 'input' => [ 'ClientContext' => 'MyApp', 'FunctionName' => 'MyFunction', 'InvocationType' => 'Event', 'LogType' => 'Tail', 'Payload' => 'fileb://file-path/input.json', 'Qualifier' => '1', ], 'output' => [ 'FunctionError' => '', 'LogResult' => '', 'Payload' => '?', 'StatusCode' => 123, ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation invokes a Lambda function', 'id' => 'to-invoke-a-lambda-function-1481659683915', 'title' => 'To invoke a Lambda function', ], ], 'InvokeAsync' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'InvokeArgs' => 'fileb://file-path/input.json', ], 'output' => [ 'Status' => 123, ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation invokes a Lambda function asynchronously', 'id' => 'to-invoke-a-lambda-function-asynchronously-1481649694923', 'title' => 'To invoke a Lambda function asynchronously', ], ], 'ListAliases' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'FunctionVersion' => '1', 'Marker' => '', 'MaxItems' => 123, ], 'output' => [ 'Aliases' => [], 'NextMarker' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function\'s aliases', 'id' => 'to-retrieve-a-lambda-function-aliases-1481650199732', 'title' => 'To retrieve a Lambda function aliases', ], ], 'ListFunctions' => [ [ 'input' => [ 'Marker' => '', 'MaxItems' => 123, ], 'output' => [ 'Functions' => [], 'NextMarker' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda functions', 'id' => 'to-retrieve-a-list-of-lambda-functions-1481650507425', 'title' => 'To retrieve a list of Lambda functions', ], ], 'ListVersionsByFunction' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Marker' => '', 'MaxItems' => 123, ], 'output' => [ 'NextMarker' => '', 'Versions' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation retrieves a Lambda function versions', 'id' => 'to-retrieve-a-list-of-lambda-function-versions-1481650603750', 'title' => 'To retrieve a list of Lambda function versions', ], ], 'PublishVersion' => [ [ 'input' => [ 'CodeSha256' => '', 'Description' => '', 'FunctionName' => 'myFunction', ], 'output' => [ 'CodeSha256' => '', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation publishes a version of a Lambda function', 'id' => 'to-publish-a-version-of-a-lambda-function-1481650704986', 'title' => 'To publish a version of a Lambda function', ], ], 'RemovePermission' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Qualifier' => '1', 'StatementId' => 'role-statement-id', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation removes a Lambda function\'s permissions', 'id' => 'to-remove-a-lambda-functions-permissions-1481661337021', 'title' => 'To remove a Lambda function\'s permissions', ], ], 'UpdateAlias' => [ [ 'input' => [ 'Description' => '', 'FunctionName' => 'myFunction', 'FunctionVersion' => '1', 'Name' => 'functionAlias', ], 'output' => [ 'AliasArn' => 'arn:aws:lambda:us-west-2:123456789012:function:functionAlias', 'Description' => '', 'FunctionVersion' => '1', 'Name' => 'functionAlias', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function alias', 'id' => 'to-update-a-lambda-function-alias-1481650817950', 'title' => 'To update a Lambda function alias', ], ], 'UpdateEventSourceMapping' => [ [ 'input' => [ 'BatchSize' => 123, 'Enabled' => true, 'FunctionName' => 'myFunction', 'UUID' => '1234xCy789012', ], 'output' => [ 'BatchSize' => 123, 'EventSourceArn' => 'arn:aws:s3:::examplebucket/*', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'LastProcessingResult' => '', 'State' => '', 'StateTransitionReason' => '', 'UUID' => '1234xCy789012', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function event source mapping', 'id' => 'to-update-a-lambda-function-event-source-mapping-1481650907413', 'title' => 'To update a Lambda function event source mapping', ], ], 'UpdateFunctionCode' => [ [ 'input' => [ 'FunctionName' => 'myFunction', 'Publish' => true, 'S3Bucket' => 'myBucket', 'S3Key' => 'myKey', 'S3ObjectVersion' => '1', 'ZipFile' => 'fileb://file-path/file.zip', ], 'output' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function\'s code', 'id' => 'to-update-a-lambda-functions-code-1481650992672', 'title' => 'To update a Lambda function\'s code', ], ], 'UpdateFunctionConfiguration' => [ [ 'input' => [ 'Description' => '', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'VpcConfig' => [], ], 'output' => [ 'CodeSha256' => 'LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=', 'CodeSize' => 123, 'Description' => '', 'FunctionArn' => 'arn:aws:lambda:us-west-2:123456789012:function:myFunction', 'FunctionName' => 'myFunction', 'Handler' => 'index.handler', 'LastModified' => '2016-11-21T19:49:20.006+0000', 'MemorySize' => 128, 'Role' => 'arn:aws:iam::123456789012:role/lambda_basic_execution', 'Runtime' => 'python2.7', 'Timeout' => 123, 'Version' => '1', 'VpcConfig' => [], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation updates a Lambda function\'s configuration', 'id' => 'to-update-a-lambda-functions-configuration-1481651096447', 'title' => 'To update a Lambda function\'s configuration', ], ], ],]; diff --git a/src/data/lightsail/2016-11-28/api-2.json b/src/data/lightsail/2016-11-28/api-2.json index 0678d3aa13..ce6760ad9a 100644 --- a/src/data/lightsail/2016-11-28/api-2.json +++ b/src/data/lightsail/2016-11-28/api-2.json @@ -2115,13 +2115,11 @@ }, "CreateDiskSnapshotRequest":{ "type":"structure", - "required":[ - "diskName", - "diskSnapshotName" - ], + "required":["diskSnapshotName"], "members":{ "diskName":{"shape":"ResourceName"}, "diskSnapshotName":{"shape":"ResourceName"}, + "instanceName":{"shape":"ResourceName"}, "tags":{"shape":"TagList"} } }, @@ -2634,7 +2632,9 @@ "state":{"shape":"DiskSnapshotState"}, "progress":{"shape":"string"}, "fromDiskName":{"shape":"ResourceName"}, - "fromDiskArn":{"shape":"NonEmptyString"} + "fromDiskArn":{"shape":"NonEmptyString"}, + "fromInstanceName":{"shape":"ResourceName"}, + "fromInstanceArn":{"shape":"NonEmptyString"} } }, "DiskSnapshotInfo":{ @@ -4174,7 +4174,8 @@ "enum":[ "DEFAULT", "INSTANCE", - "NONE" + "NONE", + "CLOSED" ] }, "PortList":{ diff --git a/src/data/lightsail/2016-11-28/api-2.json.php b/src/data/lightsail/2016-11-28/api-2.json.php index d87e133af4..1f766da66a 100644 --- a/src/data/lightsail/2016-11-28/api-2.json.php +++ b/src/data/lightsail/2016-11-28/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2016-11-28', 'endpointPrefix' => 'lightsail', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon Lightsail', 'serviceId' => 'Lightsail', 'signatureVersion' => 'v4', 'targetPrefix' => 'Lightsail_20161128', 'uid' => 'lightsail-2016-11-28', ], 'operations' => [ 'AllocateStaticIp' => [ 'name' => 'AllocateStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateStaticIpRequest', ], 'output' => [ 'shape' => 'AllocateStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachDisk' => [ 'name' => 'AttachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachDiskRequest', ], 'output' => [ 'shape' => 'AttachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachInstancesToLoadBalancer' => [ 'name' => 'AttachInstancesToLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachInstancesToLoadBalancerRequest', ], 'output' => [ 'shape' => 'AttachInstancesToLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachLoadBalancerTlsCertificate' => [ 'name' => 'AttachLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'AttachLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachStaticIp' => [ 'name' => 'AttachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachStaticIpRequest', ], 'output' => [ 'shape' => 'AttachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CloseInstancePublicPorts' => [ 'name' => 'CloseInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CloseInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'CloseInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CopySnapshot' => [ 'name' => 'CopySnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopySnapshotRequest', ], 'output' => [ 'shape' => 'CopySnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateCloudFormationStack' => [ 'name' => 'CreateCloudFormationStack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCloudFormationStackRequest', ], 'output' => [ 'shape' => 'CreateCloudFormationStackResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDisk' => [ 'name' => 'CreateDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskRequest', ], 'output' => [ 'shape' => 'CreateDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskFromSnapshot' => [ 'name' => 'CreateDiskFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskSnapshot' => [ 'name' => 'CreateDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomainEntry' => [ 'name' => 'CreateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainEntryRequest', ], 'output' => [ 'shape' => 'CreateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstanceSnapshot' => [ 'name' => 'CreateInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstances' => [ 'name' => 'CreateInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesRequest', ], 'output' => [ 'shape' => 'CreateInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstancesFromSnapshot' => [ 'name' => 'CreateInstancesFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstancesFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateKeyPair' => [ 'name' => 'CreateKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateKeyPairRequest', ], 'output' => [ 'shape' => 'CreateKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancer' => [ 'name' => 'CreateLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancerTlsCertificate' => [ 'name' => 'CreateLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabase' => [ 'name' => 'CreateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseFromSnapshot' => [ 'name' => 'CreateRelationalDatabaseFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseSnapshot' => [ 'name' => 'CreateRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDisk' => [ 'name' => 'DeleteDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskRequest', ], 'output' => [ 'shape' => 'DeleteDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDiskSnapshot' => [ 'name' => 'DeleteDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomainEntry' => [ 'name' => 'DeleteDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainEntryRequest', ], 'output' => [ 'shape' => 'DeleteDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstance' => [ 'name' => 'DeleteInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceRequest', ], 'output' => [ 'shape' => 'DeleteInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstanceSnapshot' => [ 'name' => 'DeleteInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteKeyPair' => [ 'name' => 'DeleteKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKeyPairRequest', ], 'output' => [ 'shape' => 'DeleteKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancer' => [ 'name' => 'DeleteLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancerTlsCertificate' => [ 'name' => 'DeleteLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabase' => [ 'name' => 'DeleteRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabaseSnapshot' => [ 'name' => 'DeleteRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachDisk' => [ 'name' => 'DetachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachDiskRequest', ], 'output' => [ 'shape' => 'DetachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachInstancesFromLoadBalancer' => [ 'name' => 'DetachInstancesFromLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachInstancesFromLoadBalancerRequest', ], 'output' => [ 'shape' => 'DetachInstancesFromLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachStaticIp' => [ 'name' => 'DetachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachStaticIpRequest', ], 'output' => [ 'shape' => 'DetachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DownloadDefaultKeyPair' => [ 'name' => 'DownloadDefaultKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDefaultKeyPairRequest', ], 'output' => [ 'shape' => 'DownloadDefaultKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ExportSnapshot' => [ 'name' => 'ExportSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExportSnapshotRequest', ], 'output' => [ 'shape' => 'ExportSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetActiveNames' => [ 'name' => 'GetActiveNames', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetActiveNamesRequest', ], 'output' => [ 'shape' => 'GetActiveNamesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBlueprints' => [ 'name' => 'GetBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBlueprintsRequest', ], 'output' => [ 'shape' => 'GetBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBundles' => [ 'name' => 'GetBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBundlesRequest', ], 'output' => [ 'shape' => 'GetBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCloudFormationStackRecords' => [ 'name' => 'GetCloudFormationStackRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCloudFormationStackRecordsRequest', ], 'output' => [ 'shape' => 'GetCloudFormationStackRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisk' => [ 'name' => 'GetDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskRequest', ], 'output' => [ 'shape' => 'GetDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshot' => [ 'name' => 'GetDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshots' => [ 'name' => 'GetDiskSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotsRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisks' => [ 'name' => 'GetDisks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDisksRequest', ], 'output' => [ 'shape' => 'GetDisksResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomain' => [ 'name' => 'GetDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainRequest', ], 'output' => [ 'shape' => 'GetDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomains' => [ 'name' => 'GetDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainsRequest', ], 'output' => [ 'shape' => 'GetDomainsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetExportSnapshotRecords' => [ 'name' => 'GetExportSnapshotRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetExportSnapshotRecordsRequest', ], 'output' => [ 'shape' => 'GetExportSnapshotRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstance' => [ 'name' => 'GetInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceRequest', ], 'output' => [ 'shape' => 'GetInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceAccessDetails' => [ 'name' => 'GetInstanceAccessDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceAccessDetailsRequest', ], 'output' => [ 'shape' => 'GetInstanceAccessDetailsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceMetricData' => [ 'name' => 'GetInstanceMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceMetricDataRequest', ], 'output' => [ 'shape' => 'GetInstanceMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstancePortStates' => [ 'name' => 'GetInstancePortStates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancePortStatesRequest', ], 'output' => [ 'shape' => 'GetInstancePortStatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshot' => [ 'name' => 'GetInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshots' => [ 'name' => 'GetInstanceSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotsRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceState' => [ 'name' => 'GetInstanceState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceStateRequest', ], 'output' => [ 'shape' => 'GetInstanceStateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstances' => [ 'name' => 'GetInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancesRequest', ], 'output' => [ 'shape' => 'GetInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPair' => [ 'name' => 'GetKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairRequest', ], 'output' => [ 'shape' => 'GetKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPairs' => [ 'name' => 'GetKeyPairs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairsRequest', ], 'output' => [ 'shape' => 'GetKeyPairsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancer' => [ 'name' => 'GetLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerMetricData' => [ 'name' => 'GetLoadBalancerMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerMetricDataRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerTlsCertificates' => [ 'name' => 'GetLoadBalancerTlsCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerTlsCertificatesRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerTlsCertificatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancers' => [ 'name' => 'GetLoadBalancers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancersRequest', ], 'output' => [ 'shape' => 'GetLoadBalancersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperation' => [ 'name' => 'GetOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationRequest', ], 'output' => [ 'shape' => 'GetOperationResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperations' => [ 'name' => 'GetOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsRequest', ], 'output' => [ 'shape' => 'GetOperationsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperationsForResource' => [ 'name' => 'GetOperationsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsForResourceRequest', ], 'output' => [ 'shape' => 'GetOperationsForResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRegions' => [ 'name' => 'GetRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRegionsRequest', ], 'output' => [ 'shape' => 'GetRegionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabase' => [ 'name' => 'GetRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBlueprints' => [ 'name' => 'GetRelationalDatabaseBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBlueprintsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBundles' => [ 'name' => 'GetRelationalDatabaseBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBundlesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseEvents' => [ 'name' => 'GetRelationalDatabaseEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogEvents' => [ 'name' => 'GetRelationalDatabaseLogEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogStreams' => [ 'name' => 'GetRelationalDatabaseLogStreams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogStreamsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogStreamsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMasterUserPassword' => [ 'name' => 'GetRelationalDatabaseMasterUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMetricData' => [ 'name' => 'GetRelationalDatabaseMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMetricDataRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseParameters' => [ 'name' => 'GetRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshot' => [ 'name' => 'GetRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshots' => [ 'name' => 'GetRelationalDatabaseSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabases' => [ 'name' => 'GetRelationalDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabasesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabasesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIp' => [ 'name' => 'GetStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpRequest', ], 'output' => [ 'shape' => 'GetStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIps' => [ 'name' => 'GetStaticIps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpsRequest', ], 'output' => [ 'shape' => 'GetStaticIpsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ImportKeyPair' => [ 'name' => 'ImportKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportKeyPairRequest', ], 'output' => [ 'shape' => 'ImportKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'IsVpcPeered' => [ 'name' => 'IsVpcPeered', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IsVpcPeeredRequest', ], 'output' => [ 'shape' => 'IsVpcPeeredResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'OpenInstancePublicPorts' => [ 'name' => 'OpenInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'OpenInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'OpenInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PeerVpc' => [ 'name' => 'PeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PeerVpcRequest', ], 'output' => [ 'shape' => 'PeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PutInstancePublicPorts' => [ 'name' => 'PutInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'PutInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootInstance' => [ 'name' => 'RebootInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootInstanceRequest', ], 'output' => [ 'shape' => 'RebootInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootRelationalDatabase' => [ 'name' => 'RebootRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'RebootRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ReleaseStaticIp' => [ 'name' => 'ReleaseStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleaseStaticIpRequest', ], 'output' => [ 'shape' => 'ReleaseStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartInstance' => [ 'name' => 'StartInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInstanceRequest', ], 'output' => [ 'shape' => 'StartInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartRelationalDatabase' => [ 'name' => 'StartRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StartRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopInstance' => [ 'name' => 'StopInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInstanceRequest', ], 'output' => [ 'shape' => 'StopInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopRelationalDatabase' => [ 'name' => 'StopRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StopRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UnpeerVpc' => [ 'name' => 'UnpeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UnpeerVpcRequest', ], 'output' => [ 'shape' => 'UnpeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDomainEntry' => [ 'name' => 'UpdateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainEntryRequest', ], 'output' => [ 'shape' => 'UpdateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateLoadBalancerAttribute' => [ 'name' => 'UpdateLoadBalancerAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateLoadBalancerAttributeRequest', ], 'output' => [ 'shape' => 'UpdateLoadBalancerAttributeResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabase' => [ 'name' => 'UpdateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabaseParameters' => [ 'name' => 'UpdateRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AccessDirection' => [ 'type' => 'string', 'enum' => [ 'inbound', 'outbound', ], ], 'AccountSetupInProgressException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AllocateStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'AllocateStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'instanceName', 'diskPath', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'diskPath' => [ 'shape' => 'NonEmptyString', ], ], ], 'AttachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachInstancesToLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'AttachInstancesToLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', 'instanceName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachedDiskMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceName', ], 'value' => [ 'shape' => 'DiskMapList', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'zoneName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'NonEmptyString', ], ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'Base64' => [ 'type' => 'string', ], 'Blueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'ResourceName', ], 'group' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'BlueprintType', ], 'description' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'minPower' => [ 'shape' => 'integer', ], 'version' => [ 'shape' => 'string', ], 'versionCode' => [ 'shape' => 'string', ], 'productUrl' => [ 'shape' => 'string', ], 'licenseUrl' => [ 'shape' => 'string', ], 'platform' => [ 'shape' => 'InstancePlatform', ], ], ], 'BlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Blueprint', ], ], 'BlueprintType' => [ 'type' => 'string', 'enum' => [ 'os', 'app', ], ], 'Bundle' => [ 'type' => 'structure', 'members' => [ 'price' => [ 'shape' => 'float', ], 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'instanceType' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'name' => [ 'shape' => 'string', ], 'power' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'supportedPlatforms' => [ 'shape' => 'InstancePlatformList', ], ], ], 'BundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bundle', ], ], 'CloseInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'CloseInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CloudFormationStackRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'CloudFormationStackRecordSourceInfoList', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'CloudFormationStackRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecord', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'CloudFormationStackRecordSourceType', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecordSourceInfo', ], ], 'CloudFormationStackRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'ExportSnapshotRecord', ], ], 'CopySnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'sourceSnapshotName', 'targetSnapshotName', 'sourceRegion', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], 'targetSnapshotName' => [ 'shape' => 'ResourceName', ], 'sourceRegion' => [ 'shape' => 'RegionName', ], ], ], 'CopySnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateCloudFormationStackRequest' => [ 'type' => 'structure', 'required' => [ 'instances', ], 'members' => [ 'instances' => [ 'shape' => 'InstanceEntryList', ], ], ], 'CreateCloudFormationStackResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'diskSnapshotName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'diskSnapshotName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'CreateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', 'instanceName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'instanceSnapshotName', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'attachedDiskMapping' => [ 'shape' => 'AttachedDiskMap', ], 'availabilityZone' => [ 'shape' => 'string', ], 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstancesFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'blueprintId', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'availabilityZone' => [ 'shape' => 'string', ], 'customImageName' => [ 'shape' => 'ResourceName', 'deprecated' => true, ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstancesResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instancePort', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instancePort' => [ 'shape' => 'Port', ], 'healthCheckPath' => [ 'shape' => 'string', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', 'certificateDomainName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'sourceRelationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'restoreTime' => [ 'shape' => 'IsoDate', ], 'useLatestRestorableTime' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseBlueprintId', 'relationalDatabaseBundleId', 'masterDatabaseName', 'masterUsername', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'string', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'masterUsername' => [ 'shape' => 'string', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'DeleteDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'DeleteDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'DeleteLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'skipFinalSnapshot' => [ 'shape' => 'boolean', ], 'finalRelationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DestinationInfo' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'service' => [ 'shape' => 'NonEmptyString', ], ], ], 'DetachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'DetachInstancesFromLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'Disk' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], 'iops' => [ 'shape' => 'integer', ], 'path' => [ 'shape' => 'string', ], 'state' => [ 'shape' => 'DiskState', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'attachmentState' => [ 'shape' => 'string', 'deprecated' => true, ], 'gbInUse' => [ 'shape' => 'integer', 'deprecated' => true, ], ], ], 'DiskInfo' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'path' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], ], ], 'DiskInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskInfo', ], ], 'DiskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Disk', ], ], 'DiskMap' => [ 'type' => 'structure', 'members' => [ 'originalDiskPath' => [ 'shape' => 'NonEmptyString', ], 'newDiskName' => [ 'shape' => 'ResourceName', ], ], ], 'DiskMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskMap', ], ], 'DiskSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'DiskSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromDiskName' => [ 'shape' => 'ResourceName', ], 'fromDiskArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'DiskSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'DiskSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskSnapshot', ], ], 'DiskSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'completed', 'error', 'unknown', ], ], 'DiskState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', 'in-use', 'unknown', ], ], 'Domain' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'domainEntries' => [ 'shape' => 'DomainEntryList', ], ], ], 'DomainEntry' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'DomainName', ], 'target' => [ 'shape' => 'string', ], 'isAlias' => [ 'shape' => 'boolean', ], 'type' => [ 'shape' => 'DomainEntryType', ], 'options' => [ 'shape' => 'DomainEntryOptions', 'deprecated' => true, ], ], ], 'DomainEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainEntry', ], ], 'DomainEntryOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'DomainEntryOptionsKeys', ], 'value' => [ 'shape' => 'string', ], ], 'DomainEntryOptionsKeys' => [ 'type' => 'string', ], 'DomainEntryType' => [ 'type' => 'string', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Domain', ], ], 'DomainName' => [ 'type' => 'string', ], 'DomainNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'DownloadDefaultKeyPairRequest' => [ 'type' => 'structure', 'members' => [], ], 'DownloadDefaultKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], ], ], 'ExportSnapshotRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'ExportSnapshotRecordSourceInfo', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'ExportSnapshotRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportSnapshotRecord', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ExportSnapshotRecordSourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'fromResourceName' => [ 'shape' => 'NonEmptyString', ], 'fromResourceArn' => [ 'shape' => 'NonEmptyString', ], 'instanceSnapshotInfo' => [ 'shape' => 'InstanceSnapshotInfo', ], 'diskSnapshotInfo' => [ 'shape' => 'DiskSnapshotInfo', ], ], ], 'ExportSnapshotRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'InstanceSnapshot', 'DiskSnapshot', ], ], 'ExportSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'sourceSnapshotName', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'ExportSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'GetActiveNamesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetActiveNamesResult' => [ 'type' => 'structure', 'members' => [ 'activeNames' => [ 'shape' => 'StringList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'BlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'BundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsResult' => [ 'type' => 'structure', 'members' => [ 'cloudFormationStackRecords' => [ 'shape' => 'CloudFormationStackRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskResult' => [ 'type' => 'structure', 'members' => [ 'disk' => [ 'shape' => 'Disk', ], ], ], 'GetDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshot' => [ 'shape' => 'DiskSnapshot', ], ], ], 'GetDiskSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDiskSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshots' => [ 'shape' => 'DiskSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksResult' => [ 'type' => 'structure', 'members' => [ 'disks' => [ 'shape' => 'DiskList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'GetDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'Domain', ], ], ], 'GetDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainsResult' => [ 'type' => 'structure', 'members' => [ 'domains' => [ 'shape' => 'DomainList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsResult' => [ 'type' => 'structure', 'members' => [ 'exportSnapshotRecords' => [ 'shape' => 'ExportSnapshotRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceAccessDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], ], ], 'GetInstanceAccessDetailsResult' => [ 'type' => 'structure', 'members' => [ 'accessDetails' => [ 'shape' => 'InstanceAccessDetails', ], ], ], 'GetInstanceMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetInstanceMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetInstancePortStatesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstancePortStatesResult' => [ 'type' => 'structure', 'members' => [ 'portStates' => [ 'shape' => 'InstancePortStateList', ], ], ], 'GetInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceResult' => [ 'type' => 'structure', 'members' => [ 'instance' => [ 'shape' => 'Instance', ], ], ], 'GetInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshot' => [ 'shape' => 'InstanceSnapshot', ], ], ], 'GetInstanceSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshots' => [ 'shape' => 'InstanceSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceStateRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceStateResult' => [ 'type' => 'structure', 'members' => [ 'state' => [ 'shape' => 'InstanceState', ], ], ], 'GetInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstancesResult' => [ 'type' => 'structure', 'members' => [ 'instances' => [ 'shape' => 'InstanceList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'GetKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], ], ], 'GetKeyPairsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetKeyPairsResult' => [ 'type' => 'structure', 'members' => [ 'keyPairs' => [ 'shape' => 'KeyPairList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancerMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetLoadBalancerMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancer' => [ 'shape' => 'LoadBalancer', ], ], ], 'GetLoadBalancerTlsCertificatesRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerTlsCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'tlsCertificates' => [ 'shape' => 'LoadBalancerTlsCertificateList', ], ], ], 'GetLoadBalancersRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancersResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancers' => [ 'shape' => 'LoadBalancerList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationRequest' => [ 'type' => 'structure', 'required' => [ 'operationId', ], 'members' => [ 'operationId' => [ 'shape' => 'NonEmptyString', ], ], ], 'GetOperationResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'GetOperationsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageCount' => [ 'shape' => 'string', 'deprecated' => true, ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRegionsRequest' => [ 'type' => 'structure', 'members' => [ 'includeAvailabilityZones' => [ 'shape' => 'boolean', ], 'includeRelationalDatabaseAvailabilityZones' => [ 'shape' => 'boolean', ], ], ], 'GetRegionsResult' => [ 'type' => 'structure', 'members' => [ 'regions' => [ 'shape' => 'RegionList', ], ], ], 'GetRelationalDatabaseBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'RelationalDatabaseBlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'RelationalDatabaseBundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'durationInMinutes' => [ 'shape' => 'integer', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseEvents' => [ 'shape' => 'RelationalDatabaseEventList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'logStreamName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'logStreamName' => [ 'shape' => 'string', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'startFromHead' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsResult' => [ 'type' => 'structure', 'members' => [ 'resourceLogEvents' => [ 'shape' => 'LogEventList', ], 'nextBackwardToken' => [ 'shape' => 'string', ], 'nextForwardToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogStreamsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseLogStreamsResult' => [ 'type' => 'structure', 'members' => [ 'logStreams' => [ 'shape' => 'StringList', ], ], ], 'GetRelationalDatabaseMasterUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'passwordVersion' => [ 'shape' => 'RelationalDatabasePasswordVersion', ], ], ], 'GetRelationalDatabaseMasterUserPasswordResult' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'GetRelationalDatabaseMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetRelationalDatabaseMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabase' => [ 'shape' => 'RelationalDatabase', ], ], ], 'GetRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshot' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], ], 'GetRelationalDatabaseSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshots' => [ 'shape' => 'RelationalDatabaseSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabases' => [ 'shape' => 'RelationalDatabaseList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'GetStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'staticIp' => [ 'shape' => 'StaticIp', ], ], ], 'GetStaticIpsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetStaticIpsResult' => [ 'type' => 'structure', 'members' => [ 'staticIps' => [ 'shape' => 'StaticIpList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'ImportKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', 'publicKeyBase64', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], ], ], 'ImportKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'blueprintName' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'isStaticIp' => [ 'shape' => 'boolean', ], 'privateIpAddress' => [ 'shape' => 'IpAddress', ], 'publicIpAddress' => [ 'shape' => 'IpAddress', ], 'ipv6Address' => [ 'shape' => 'IpV6Address', ], 'hardware' => [ 'shape' => 'InstanceHardware', ], 'networking' => [ 'shape' => 'InstanceNetworking', ], 'state' => [ 'shape' => 'InstanceState', ], 'username' => [ 'shape' => 'NonEmptyString', ], 'sshKeyName' => [ 'shape' => 'ResourceName', ], ], ], 'InstanceAccessDetails' => [ 'type' => 'structure', 'members' => [ 'certKey' => [ 'shape' => 'string', ], 'expiresAt' => [ 'shape' => 'IsoDate', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'password' => [ 'shape' => 'string', ], 'passwordData' => [ 'shape' => 'PasswordData', ], 'privateKey' => [ 'shape' => 'string', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'username' => [ 'shape' => 'string', ], ], ], 'InstanceAccessProtocol' => [ 'type' => 'string', 'enum' => [ 'ssh', 'rdp', ], ], 'InstanceEntry' => [ 'type' => 'structure', 'required' => [ 'sourceName', 'instanceType', 'portInfoSource', 'availabilityZone', ], 'members' => [ 'sourceName' => [ 'shape' => 'ResourceName', ], 'instanceType' => [ 'shape' => 'NonEmptyString', ], 'portInfoSource' => [ 'shape' => 'PortInfoSourceType', ], 'userData' => [ 'shape' => 'string', ], 'availabilityZone' => [ 'shape' => 'string', ], ], ], 'InstanceEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceEntry', ], ], 'InstanceHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'disks' => [ 'shape' => 'DiskList', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'InstanceHealthReason' => [ 'type' => 'string', 'enum' => [ 'Lb.RegistrationInProgress', 'Lb.InitialHealthChecking', 'Lb.InternalError', 'Instance.ResponseCodeMismatch', 'Instance.Timeout', 'Instance.FailedHealthChecks', 'Instance.NotRegistered', 'Instance.NotInUse', 'Instance.DeregistrationInProgress', 'Instance.InvalidState', 'Instance.IpUnusable', ], ], 'InstanceHealthState' => [ 'type' => 'string', 'enum' => [ 'initial', 'healthy', 'unhealthy', 'unused', 'draining', 'unavailable', ], ], 'InstanceHealthSummary' => [ 'type' => 'structure', 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'instanceHealth' => [ 'shape' => 'InstanceHealthState', ], 'instanceHealthReason' => [ 'shape' => 'InstanceHealthReason', ], ], ], 'InstanceHealthSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceHealthSummary', ], ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'NetworkIn', 'NetworkOut', 'StatusCheckFailed', 'StatusCheckFailed_Instance', 'StatusCheckFailed_System', ], ], 'InstanceNetworking' => [ 'type' => 'structure', 'members' => [ 'monthlyTransfer' => [ 'shape' => 'MonthlyTransfer', ], 'ports' => [ 'shape' => 'InstancePortInfoList', ], ], ], 'InstancePlatform' => [ 'type' => 'string', 'enum' => [ 'LINUX_UNIX', 'WINDOWS', ], ], 'InstancePlatformList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePlatform', ], ], 'InstancePortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'accessFrom' => [ 'shape' => 'string', ], 'accessType' => [ 'shape' => 'PortAccessType', ], 'commonName' => [ 'shape' => 'string', ], 'accessDirection' => [ 'shape' => 'AccessDirection', ], ], ], 'InstancePortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortInfo', ], ], 'InstancePortState' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'state' => [ 'shape' => 'PortState', ], ], ], 'InstancePortStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortState', ], ], 'InstanceSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'state' => [ 'shape' => 'InstanceSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromAttachedDisks' => [ 'shape' => 'DiskList', ], 'fromInstanceName' => [ 'shape' => 'ResourceName', ], 'fromInstanceArn' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'string', ], 'fromBundleId' => [ 'shape' => 'string', ], 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'InstanceSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'fromBundleId' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'fromDiskInfo' => [ 'shape' => 'DiskInfoList', ], ], ], 'InstanceSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceSnapshot', ], ], 'InstanceSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', ], ], 'InstanceState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'integer', ], 'name' => [ 'shape' => 'string', ], ], ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', 'pattern' => '([0-9]{1,3}\\.){3}[0-9]{1,3}', ], 'IpV6Address' => [ 'type' => 'string', 'pattern' => '([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}', ], 'IsVpcPeeredRequest' => [ 'type' => 'structure', 'members' => [], ], 'IsVpcPeeredResult' => [ 'type' => 'structure', 'members' => [ 'isPeered' => [ 'shape' => 'boolean', ], ], ], 'IsoDate' => [ 'type' => 'timestamp', ], 'KeyPair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'fingerprint' => [ 'shape' => 'Base64', ], ], ], 'KeyPairList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyPair', ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'dnsName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'LoadBalancerState', ], 'protocol' => [ 'shape' => 'LoadBalancerProtocol', ], 'publicPorts' => [ 'shape' => 'PortList', ], 'healthCheckPath' => [ 'shape' => 'NonEmptyString', ], 'instancePort' => [ 'shape' => 'integer', ], 'instanceHealthSummary' => [ 'shape' => 'InstanceHealthSummaryList', ], 'tlsCertificateSummaries' => [ 'shape' => 'LoadBalancerTlsCertificateSummaryList', ], 'configurationOptions' => [ 'shape' => 'LoadBalancerConfigurationOptions', ], ], ], 'LoadBalancerAttributeName' => [ 'type' => 'string', 'enum' => [ 'HealthCheckPath', 'SessionStickinessEnabled', 'SessionStickiness_LB_CookieDurationSeconds', ], ], 'LoadBalancerConfigurationOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LoadBalancerAttributeName', ], 'value' => [ 'shape' => 'string', ], ], 'LoadBalancerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LoadBalancerMetricName' => [ 'type' => 'string', 'enum' => [ 'ClientTLSNegotiationErrorCount', 'HealthyHostCount', 'UnhealthyHostCount', 'HTTPCode_LB_4XX_Count', 'HTTPCode_LB_5XX_Count', 'HTTPCode_Instance_2XX_Count', 'HTTPCode_Instance_3XX_Count', 'HTTPCode_Instance_4XX_Count', 'HTTPCode_Instance_5XX_Count', 'InstanceResponseTime', 'RejectedConnectionCount', 'RequestCount', ], ], 'LoadBalancerProtocol' => [ 'type' => 'string', 'enum' => [ 'HTTP_HTTPS', 'HTTP', ], ], 'LoadBalancerState' => [ 'type' => 'string', 'enum' => [ 'active', 'provisioning', 'active_impaired', 'failed', 'unknown', ], ], 'LoadBalancerTlsCertificate' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'status' => [ 'shape' => 'LoadBalancerTlsCertificateStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainValidationRecords' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecordList', ], 'failureReason' => [ 'shape' => 'LoadBalancerTlsCertificateFailureReason', ], 'issuedAt' => [ 'shape' => 'IsoDate', ], 'issuer' => [ 'shape' => 'NonEmptyString', ], 'keyAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'notAfter' => [ 'shape' => 'IsoDate', ], 'notBefore' => [ 'shape' => 'IsoDate', ], 'renewalSummary' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalSummary', ], 'revocationReason' => [ 'shape' => 'LoadBalancerTlsCertificateRevocationReason', ], 'revokedAt' => [ 'shape' => 'IsoDate', ], 'serial' => [ 'shape' => 'NonEmptyString', ], 'signatureAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'subject' => [ 'shape' => 'NonEmptyString', ], 'subjectAlternativeNames' => [ 'shape' => 'StringList', ], ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'FAILED', 'SUCCESS', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'type' => 'structure', 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOption', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'NonEmptyString', ], 'value' => [ 'shape' => 'NonEmptyString', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecord', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'type' => 'string', 'enum' => [ 'NO_AVAILABLE_CONTACTS', 'ADDITIONAL_VERIFICATION_REQUIRED', 'DOMAIN_NOT_ALLOWED', 'INVALID_PUBLIC_DOMAIN', 'OTHER', ], ], 'LoadBalancerTlsCertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificate', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_AUTO_RENEWAL', 'PENDING_VALIDATION', 'SUCCESS', 'FAILED', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'type' => 'structure', 'members' => [ 'renewalStatus' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalStatus', ], 'domainValidationOptions' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOptionList', ], ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'type' => 'string', 'enum' => [ 'UNSPECIFIED', 'KEY_COMPROMISE', 'CA_COMPROMISE', 'AFFILIATION_CHANGED', 'SUPERCEDED', 'CESSATION_OF_OPERATION', 'CERTIFICATE_HOLD', 'REMOVE_FROM_CRL', 'PRIVILEGE_WITHDRAWN', 'A_A_COMPROMISE', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED', 'UNKNOWN', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateSummary', ], ], 'LogEvent' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], ], ], 'LogEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogEvent', ], ], 'MetricDatapoint' => [ 'type' => 'structure', 'members' => [ 'average' => [ 'shape' => 'double', ], 'maximum' => [ 'shape' => 'double', ], 'minimum' => [ 'shape' => 'double', ], 'sampleCount' => [ 'shape' => 'double', ], 'sum' => [ 'shape' => 'double', ], 'timestamp' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], ], ], 'MetricDatapointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatapoint', ], ], 'MetricPeriod' => [ 'type' => 'integer', 'max' => 86400, 'min' => 60, ], 'MetricStatistic' => [ 'type' => 'string', 'enum' => [ 'Minimum', 'Maximum', 'Sum', 'Average', 'SampleCount', ], ], 'MetricStatisticList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricStatistic', ], ], 'MetricUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Microseconds', 'Milliseconds', 'Bytes', 'Kilobytes', 'Megabytes', 'Gigabytes', 'Terabytes', 'Bits', 'Kilobits', 'Megabits', 'Gigabits', 'Terabits', 'Percent', 'Count', 'Bytes/Second', 'Kilobytes/Second', 'Megabytes/Second', 'Gigabytes/Second', 'Terabytes/Second', 'Bits/Second', 'Kilobits/Second', 'Megabits/Second', 'Gigabits/Second', 'Terabits/Second', 'Count/Second', 'None', ], ], 'MonthlyTransfer' => [ 'type' => 'structure', 'members' => [ 'gbPerMonthAllocated' => [ 'shape' => 'integer', ], ], ], 'NetworkProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'all', 'udp', ], ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'OpenInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'OpenInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'Operation' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'isTerminal' => [ 'shape' => 'boolean', ], 'operationDetails' => [ 'shape' => 'string', ], 'operationType' => [ 'shape' => 'OperationType', ], 'status' => [ 'shape' => 'OperationStatus', ], 'statusChangedAt' => [ 'shape' => 'IsoDate', ], 'errorCode' => [ 'shape' => 'string', ], 'errorDetails' => [ 'shape' => 'string', ], ], ], 'OperationFailureException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'OperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Operation', ], ], 'OperationStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'Started', 'Failed', 'Completed', 'Succeeded', ], ], 'OperationType' => [ 'type' => 'string', 'enum' => [ 'DeleteInstance', 'CreateInstance', 'StopInstance', 'StartInstance', 'RebootInstance', 'OpenInstancePublicPorts', 'PutInstancePublicPorts', 'CloseInstancePublicPorts', 'AllocateStaticIp', 'ReleaseStaticIp', 'AttachStaticIp', 'DetachStaticIp', 'UpdateDomainEntry', 'DeleteDomainEntry', 'CreateDomain', 'DeleteDomain', 'CreateInstanceSnapshot', 'DeleteInstanceSnapshot', 'CreateInstancesFromSnapshot', 'CreateLoadBalancer', 'DeleteLoadBalancer', 'AttachInstancesToLoadBalancer', 'DetachInstancesFromLoadBalancer', 'UpdateLoadBalancerAttribute', 'CreateLoadBalancerTlsCertificate', 'DeleteLoadBalancerTlsCertificate', 'AttachLoadBalancerTlsCertificate', 'CreateDisk', 'DeleteDisk', 'AttachDisk', 'DetachDisk', 'CreateDiskSnapshot', 'DeleteDiskSnapshot', 'CreateDiskFromSnapshot', 'CreateRelationalDatabase', 'UpdateRelationalDatabase', 'DeleteRelationalDatabase', 'CreateRelationalDatabaseFromSnapshot', 'CreateRelationalDatabaseSnapshot', 'DeleteRelationalDatabaseSnapshot', 'UpdateRelationalDatabaseParameters', 'StartRelationalDatabase', 'RebootRelationalDatabase', 'StopRelationalDatabase', ], ], 'PasswordData' => [ 'type' => 'structure', 'members' => [ 'ciphertext' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'PeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'PeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'NonEmptyString', ], 'description' => [ 'shape' => 'NonEmptyString', ], 'currentApplyDate' => [ 'shape' => 'IsoDate', ], ], ], 'PendingMaintenanceActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'string', ], 'engineVersion' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'PortAccessType' => [ 'type' => 'string', 'enum' => [ 'Public', 'Private', ], ], 'PortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], ], ], 'PortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortInfo', ], ], 'PortInfoSourceType' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'INSTANCE', 'NONE', ], ], 'PortList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Port', ], ], 'PortState' => [ 'type' => 'string', 'enum' => [ 'open', 'closed', ], ], 'PutInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfos', 'instanceName', ], 'members' => [ 'portInfos' => [ 'shape' => 'PortInfoList', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'PutInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'RebootInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RebootRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RecordState' => [ 'type' => 'string', 'enum' => [ 'Started', 'Succeeded', 'Failed', ], ], 'Region' => [ 'type' => 'structure', 'members' => [ 'continentCode' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'displayName' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'RegionName', ], 'availabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'relationalDatabaseAvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'RegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'RegionName' => [ 'type' => 'string', 'enum' => [ 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'eu-central-1', 'ca-central-1', 'ap-south-1', 'ap-southeast-1', 'ap-southeast-2', 'ap-northeast-1', 'ap-northeast-2', ], ], 'RelationalDatabase' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'relationalDatabaseBundleId' => [ 'shape' => 'NonEmptyString', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'hardware' => [ 'shape' => 'RelationalDatabaseHardware', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'secondaryAvailabilityZone' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], 'pendingModifiedValues' => [ 'shape' => 'PendingModifiedRelationalDatabaseValues', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'latestRestorableTime' => [ 'shape' => 'IsoDate', ], 'masterUsername' => [ 'shape' => 'NonEmptyString', ], 'parameterApplyStatus' => [ 'shape' => 'NonEmptyString', ], 'preferredBackupWindow' => [ 'shape' => 'NonEmptyString', ], 'preferredMaintenanceWindow' => [ 'shape' => 'NonEmptyString', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'masterEndpoint' => [ 'shape' => 'RelationalDatabaseEndpoint', ], 'pendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActionList', ], ], ], 'RelationalDatabaseBlueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'string', ], 'engine' => [ 'shape' => 'RelationalDatabaseEngine', ], 'engineVersion' => [ 'shape' => 'string', ], 'engineDescription' => [ 'shape' => 'string', ], 'engineVersionDescription' => [ 'shape' => 'string', ], 'isEngineDefault' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBlueprint', ], ], 'RelationalDatabaseBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'cpuCount' => [ 'shape' => 'integer', ], 'isEncrypted' => [ 'shape' => 'boolean', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBundle', ], ], 'RelationalDatabaseEndpoint' => [ 'type' => 'structure', 'members' => [ 'port' => [ 'shape' => 'integer', ], 'address' => [ 'shape' => 'NonEmptyString', ], ], ], 'RelationalDatabaseEngine' => [ 'type' => 'string', 'enum' => [ 'mysql', ], ], 'RelationalDatabaseEvent' => [ 'type' => 'structure', 'members' => [ 'resource' => [ 'shape' => 'ResourceName', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], 'eventCategories' => [ 'shape' => 'StringList', ], ], ], 'RelationalDatabaseEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseEvent', ], ], 'RelationalDatabaseHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'RelationalDatabaseList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabase', ], ], 'RelationalDatabaseMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'DatabaseConnections', 'DiskQueueDepth', 'FreeStorageSpace', 'NetworkReceiveThroughput', 'NetworkTransmitThroughput', ], ], 'RelationalDatabaseParameter' => [ 'type' => 'structure', 'members' => [ 'allowedValues' => [ 'shape' => 'string', ], 'applyMethod' => [ 'shape' => 'string', ], 'applyType' => [ 'shape' => 'string', ], 'dataType' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'isModifiable' => [ 'shape' => 'boolean', ], 'parameterName' => [ 'shape' => 'string', ], 'parameterValue' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseParameter', ], ], 'RelationalDatabasePasswordVersion' => [ 'type' => 'string', 'enum' => [ 'CURRENT', 'PREVIOUS', 'PENDING', ], ], 'RelationalDatabaseSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseName' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseArn' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseBundleId' => [ 'shape' => 'string', ], 'fromRelationalDatabaseBlueprintId' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], 'ReleaseStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'ReleaseStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'ResourceLocation' => [ 'type' => 'structure', 'members' => [ 'availabilityZone' => [ 'shape' => 'string', ], 'regionName' => [ 'shape' => 'RegionName', ], ], ], 'ResourceName' => [ 'type' => 'string', 'pattern' => '\\w[\\w\\-]*\\w', ], 'ResourceNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceName', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'Instance', 'StaticIp', 'KeyPair', 'InstanceSnapshot', 'Domain', 'PeeredVpc', 'LoadBalancer', 'LoadBalancerTlsCertificate', 'Disk', 'DiskSnapshot', 'RelationalDatabase', 'RelationalDatabaseSnapshot', 'ExportSnapshotRecord', 'CloudFormationStackRecord', ], ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'ServiceException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, 'fault' => true, ], 'StartInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'StartInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StartRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'StartRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StaticIp' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'StaticIpList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StaticIp', ], ], 'StopInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'StopInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StopRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'StopRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'string', ], ], 'StringMax256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tags', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'TagValue' => [ 'type' => 'string', ], 'UnauthenticatedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'UnpeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'UnpeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tagKeys', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'UpdateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateLoadBalancerAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'attributeName', 'attributeValue', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'attributeName' => [ 'shape' => 'LoadBalancerAttributeName', ], 'attributeValue' => [ 'shape' => 'StringMax256', ], ], ], 'UpdateLoadBalancerAttributeResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'parameters', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], ], ], 'UpdateRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'rotateMasterUserPassword' => [ 'shape' => 'boolean', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'enableBackupRetention' => [ 'shape' => 'boolean', ], 'disableBackupRetention' => [ 'shape' => 'boolean', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'applyImmediately' => [ 'shape' => 'boolean', ], ], ], 'UpdateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'boolean' => [ 'type' => 'boolean', ], 'double' => [ 'type' => 'double', ], 'float' => [ 'type' => 'float', ], 'integer' => [ 'type' => 'integer', ], 'string' => [ 'type' => 'string', ], 'timestamp' => [ 'type' => 'timestamp', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2016-11-28', 'endpointPrefix' => 'lightsail', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon Lightsail', 'serviceId' => 'Lightsail', 'signatureVersion' => 'v4', 'targetPrefix' => 'Lightsail_20161128', 'uid' => 'lightsail-2016-11-28', ], 'operations' => [ 'AllocateStaticIp' => [ 'name' => 'AllocateStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateStaticIpRequest', ], 'output' => [ 'shape' => 'AllocateStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachDisk' => [ 'name' => 'AttachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachDiskRequest', ], 'output' => [ 'shape' => 'AttachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachInstancesToLoadBalancer' => [ 'name' => 'AttachInstancesToLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachInstancesToLoadBalancerRequest', ], 'output' => [ 'shape' => 'AttachInstancesToLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachLoadBalancerTlsCertificate' => [ 'name' => 'AttachLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'AttachLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachStaticIp' => [ 'name' => 'AttachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachStaticIpRequest', ], 'output' => [ 'shape' => 'AttachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CloseInstancePublicPorts' => [ 'name' => 'CloseInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CloseInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'CloseInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CopySnapshot' => [ 'name' => 'CopySnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopySnapshotRequest', ], 'output' => [ 'shape' => 'CopySnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateCloudFormationStack' => [ 'name' => 'CreateCloudFormationStack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCloudFormationStackRequest', ], 'output' => [ 'shape' => 'CreateCloudFormationStackResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDisk' => [ 'name' => 'CreateDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskRequest', ], 'output' => [ 'shape' => 'CreateDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskFromSnapshot' => [ 'name' => 'CreateDiskFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskSnapshot' => [ 'name' => 'CreateDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomainEntry' => [ 'name' => 'CreateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainEntryRequest', ], 'output' => [ 'shape' => 'CreateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstanceSnapshot' => [ 'name' => 'CreateInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstances' => [ 'name' => 'CreateInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesRequest', ], 'output' => [ 'shape' => 'CreateInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstancesFromSnapshot' => [ 'name' => 'CreateInstancesFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstancesFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateKeyPair' => [ 'name' => 'CreateKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateKeyPairRequest', ], 'output' => [ 'shape' => 'CreateKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancer' => [ 'name' => 'CreateLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancerTlsCertificate' => [ 'name' => 'CreateLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabase' => [ 'name' => 'CreateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseFromSnapshot' => [ 'name' => 'CreateRelationalDatabaseFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseSnapshot' => [ 'name' => 'CreateRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDisk' => [ 'name' => 'DeleteDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskRequest', ], 'output' => [ 'shape' => 'DeleteDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDiskSnapshot' => [ 'name' => 'DeleteDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomainEntry' => [ 'name' => 'DeleteDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainEntryRequest', ], 'output' => [ 'shape' => 'DeleteDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstance' => [ 'name' => 'DeleteInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceRequest', ], 'output' => [ 'shape' => 'DeleteInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstanceSnapshot' => [ 'name' => 'DeleteInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteKeyPair' => [ 'name' => 'DeleteKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKeyPairRequest', ], 'output' => [ 'shape' => 'DeleteKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancer' => [ 'name' => 'DeleteLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancerTlsCertificate' => [ 'name' => 'DeleteLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabase' => [ 'name' => 'DeleteRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabaseSnapshot' => [ 'name' => 'DeleteRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachDisk' => [ 'name' => 'DetachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachDiskRequest', ], 'output' => [ 'shape' => 'DetachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachInstancesFromLoadBalancer' => [ 'name' => 'DetachInstancesFromLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachInstancesFromLoadBalancerRequest', ], 'output' => [ 'shape' => 'DetachInstancesFromLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachStaticIp' => [ 'name' => 'DetachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachStaticIpRequest', ], 'output' => [ 'shape' => 'DetachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DownloadDefaultKeyPair' => [ 'name' => 'DownloadDefaultKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDefaultKeyPairRequest', ], 'output' => [ 'shape' => 'DownloadDefaultKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ExportSnapshot' => [ 'name' => 'ExportSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExportSnapshotRequest', ], 'output' => [ 'shape' => 'ExportSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetActiveNames' => [ 'name' => 'GetActiveNames', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetActiveNamesRequest', ], 'output' => [ 'shape' => 'GetActiveNamesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBlueprints' => [ 'name' => 'GetBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBlueprintsRequest', ], 'output' => [ 'shape' => 'GetBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBundles' => [ 'name' => 'GetBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBundlesRequest', ], 'output' => [ 'shape' => 'GetBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCloudFormationStackRecords' => [ 'name' => 'GetCloudFormationStackRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCloudFormationStackRecordsRequest', ], 'output' => [ 'shape' => 'GetCloudFormationStackRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisk' => [ 'name' => 'GetDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskRequest', ], 'output' => [ 'shape' => 'GetDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshot' => [ 'name' => 'GetDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshots' => [ 'name' => 'GetDiskSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotsRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisks' => [ 'name' => 'GetDisks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDisksRequest', ], 'output' => [ 'shape' => 'GetDisksResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomain' => [ 'name' => 'GetDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainRequest', ], 'output' => [ 'shape' => 'GetDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomains' => [ 'name' => 'GetDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainsRequest', ], 'output' => [ 'shape' => 'GetDomainsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetExportSnapshotRecords' => [ 'name' => 'GetExportSnapshotRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetExportSnapshotRecordsRequest', ], 'output' => [ 'shape' => 'GetExportSnapshotRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstance' => [ 'name' => 'GetInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceRequest', ], 'output' => [ 'shape' => 'GetInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceAccessDetails' => [ 'name' => 'GetInstanceAccessDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceAccessDetailsRequest', ], 'output' => [ 'shape' => 'GetInstanceAccessDetailsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceMetricData' => [ 'name' => 'GetInstanceMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceMetricDataRequest', ], 'output' => [ 'shape' => 'GetInstanceMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstancePortStates' => [ 'name' => 'GetInstancePortStates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancePortStatesRequest', ], 'output' => [ 'shape' => 'GetInstancePortStatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshot' => [ 'name' => 'GetInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshots' => [ 'name' => 'GetInstanceSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotsRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceState' => [ 'name' => 'GetInstanceState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceStateRequest', ], 'output' => [ 'shape' => 'GetInstanceStateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstances' => [ 'name' => 'GetInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancesRequest', ], 'output' => [ 'shape' => 'GetInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPair' => [ 'name' => 'GetKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairRequest', ], 'output' => [ 'shape' => 'GetKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPairs' => [ 'name' => 'GetKeyPairs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairsRequest', ], 'output' => [ 'shape' => 'GetKeyPairsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancer' => [ 'name' => 'GetLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerMetricData' => [ 'name' => 'GetLoadBalancerMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerMetricDataRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerTlsCertificates' => [ 'name' => 'GetLoadBalancerTlsCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerTlsCertificatesRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerTlsCertificatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancers' => [ 'name' => 'GetLoadBalancers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancersRequest', ], 'output' => [ 'shape' => 'GetLoadBalancersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperation' => [ 'name' => 'GetOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationRequest', ], 'output' => [ 'shape' => 'GetOperationResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperations' => [ 'name' => 'GetOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsRequest', ], 'output' => [ 'shape' => 'GetOperationsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperationsForResource' => [ 'name' => 'GetOperationsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsForResourceRequest', ], 'output' => [ 'shape' => 'GetOperationsForResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRegions' => [ 'name' => 'GetRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRegionsRequest', ], 'output' => [ 'shape' => 'GetRegionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabase' => [ 'name' => 'GetRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBlueprints' => [ 'name' => 'GetRelationalDatabaseBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBlueprintsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBundles' => [ 'name' => 'GetRelationalDatabaseBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBundlesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseEvents' => [ 'name' => 'GetRelationalDatabaseEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogEvents' => [ 'name' => 'GetRelationalDatabaseLogEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogStreams' => [ 'name' => 'GetRelationalDatabaseLogStreams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogStreamsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogStreamsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMasterUserPassword' => [ 'name' => 'GetRelationalDatabaseMasterUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMetricData' => [ 'name' => 'GetRelationalDatabaseMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMetricDataRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseParameters' => [ 'name' => 'GetRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshot' => [ 'name' => 'GetRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshots' => [ 'name' => 'GetRelationalDatabaseSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabases' => [ 'name' => 'GetRelationalDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabasesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabasesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIp' => [ 'name' => 'GetStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpRequest', ], 'output' => [ 'shape' => 'GetStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIps' => [ 'name' => 'GetStaticIps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpsRequest', ], 'output' => [ 'shape' => 'GetStaticIpsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ImportKeyPair' => [ 'name' => 'ImportKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportKeyPairRequest', ], 'output' => [ 'shape' => 'ImportKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'IsVpcPeered' => [ 'name' => 'IsVpcPeered', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IsVpcPeeredRequest', ], 'output' => [ 'shape' => 'IsVpcPeeredResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'OpenInstancePublicPorts' => [ 'name' => 'OpenInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'OpenInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'OpenInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PeerVpc' => [ 'name' => 'PeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PeerVpcRequest', ], 'output' => [ 'shape' => 'PeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PutInstancePublicPorts' => [ 'name' => 'PutInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'PutInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootInstance' => [ 'name' => 'RebootInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootInstanceRequest', ], 'output' => [ 'shape' => 'RebootInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootRelationalDatabase' => [ 'name' => 'RebootRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'RebootRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ReleaseStaticIp' => [ 'name' => 'ReleaseStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleaseStaticIpRequest', ], 'output' => [ 'shape' => 'ReleaseStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartInstance' => [ 'name' => 'StartInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInstanceRequest', ], 'output' => [ 'shape' => 'StartInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartRelationalDatabase' => [ 'name' => 'StartRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StartRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopInstance' => [ 'name' => 'StopInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInstanceRequest', ], 'output' => [ 'shape' => 'StopInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopRelationalDatabase' => [ 'name' => 'StopRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StopRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UnpeerVpc' => [ 'name' => 'UnpeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UnpeerVpcRequest', ], 'output' => [ 'shape' => 'UnpeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDomainEntry' => [ 'name' => 'UpdateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainEntryRequest', ], 'output' => [ 'shape' => 'UpdateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateLoadBalancerAttribute' => [ 'name' => 'UpdateLoadBalancerAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateLoadBalancerAttributeRequest', ], 'output' => [ 'shape' => 'UpdateLoadBalancerAttributeResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabase' => [ 'name' => 'UpdateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabaseParameters' => [ 'name' => 'UpdateRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AccessDirection' => [ 'type' => 'string', 'enum' => [ 'inbound', 'outbound', ], ], 'AccountSetupInProgressException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AllocateStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'AllocateStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'instanceName', 'diskPath', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'diskPath' => [ 'shape' => 'NonEmptyString', ], ], ], 'AttachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachInstancesToLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'AttachInstancesToLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', 'instanceName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachedDiskMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceName', ], 'value' => [ 'shape' => 'DiskMapList', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'zoneName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'NonEmptyString', ], ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'Base64' => [ 'type' => 'string', ], 'Blueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'ResourceName', ], 'group' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'BlueprintType', ], 'description' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'minPower' => [ 'shape' => 'integer', ], 'version' => [ 'shape' => 'string', ], 'versionCode' => [ 'shape' => 'string', ], 'productUrl' => [ 'shape' => 'string', ], 'licenseUrl' => [ 'shape' => 'string', ], 'platform' => [ 'shape' => 'InstancePlatform', ], ], ], 'BlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Blueprint', ], ], 'BlueprintType' => [ 'type' => 'string', 'enum' => [ 'os', 'app', ], ], 'Bundle' => [ 'type' => 'structure', 'members' => [ 'price' => [ 'shape' => 'float', ], 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'instanceType' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'name' => [ 'shape' => 'string', ], 'power' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'supportedPlatforms' => [ 'shape' => 'InstancePlatformList', ], ], ], 'BundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bundle', ], ], 'CloseInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'CloseInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CloudFormationStackRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'CloudFormationStackRecordSourceInfoList', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'CloudFormationStackRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecord', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'CloudFormationStackRecordSourceType', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecordSourceInfo', ], ], 'CloudFormationStackRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'ExportSnapshotRecord', ], ], 'CopySnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'sourceSnapshotName', 'targetSnapshotName', 'sourceRegion', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], 'targetSnapshotName' => [ 'shape' => 'ResourceName', ], 'sourceRegion' => [ 'shape' => 'RegionName', ], ], ], 'CopySnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateCloudFormationStackRequest' => [ 'type' => 'structure', 'required' => [ 'instances', ], 'members' => [ 'instances' => [ 'shape' => 'InstanceEntryList', ], ], ], 'CreateCloudFormationStackResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'diskSnapshotName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'CreateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', 'instanceName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'instanceSnapshotName', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'attachedDiskMapping' => [ 'shape' => 'AttachedDiskMap', ], 'availabilityZone' => [ 'shape' => 'string', ], 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstancesFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'blueprintId', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'availabilityZone' => [ 'shape' => 'string', ], 'customImageName' => [ 'shape' => 'ResourceName', 'deprecated' => true, ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstancesResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instancePort', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instancePort' => [ 'shape' => 'Port', ], 'healthCheckPath' => [ 'shape' => 'string', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', 'certificateDomainName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'sourceRelationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'restoreTime' => [ 'shape' => 'IsoDate', ], 'useLatestRestorableTime' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseBlueprintId', 'relationalDatabaseBundleId', 'masterDatabaseName', 'masterUsername', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'string', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'masterUsername' => [ 'shape' => 'string', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'DeleteDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'DeleteDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'DeleteLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'skipFinalSnapshot' => [ 'shape' => 'boolean', ], 'finalRelationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DestinationInfo' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'service' => [ 'shape' => 'NonEmptyString', ], ], ], 'DetachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'DetachInstancesFromLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'Disk' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], 'iops' => [ 'shape' => 'integer', ], 'path' => [ 'shape' => 'string', ], 'state' => [ 'shape' => 'DiskState', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'attachmentState' => [ 'shape' => 'string', 'deprecated' => true, ], 'gbInUse' => [ 'shape' => 'integer', 'deprecated' => true, ], ], ], 'DiskInfo' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'path' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], ], ], 'DiskInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskInfo', ], ], 'DiskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Disk', ], ], 'DiskMap' => [ 'type' => 'structure', 'members' => [ 'originalDiskPath' => [ 'shape' => 'NonEmptyString', ], 'newDiskName' => [ 'shape' => 'ResourceName', ], ], ], 'DiskMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskMap', ], ], 'DiskSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'DiskSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromDiskName' => [ 'shape' => 'ResourceName', ], 'fromDiskArn' => [ 'shape' => 'NonEmptyString', ], 'fromInstanceName' => [ 'shape' => 'ResourceName', ], 'fromInstanceArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'DiskSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'DiskSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskSnapshot', ], ], 'DiskSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'completed', 'error', 'unknown', ], ], 'DiskState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', 'in-use', 'unknown', ], ], 'Domain' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'domainEntries' => [ 'shape' => 'DomainEntryList', ], ], ], 'DomainEntry' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'DomainName', ], 'target' => [ 'shape' => 'string', ], 'isAlias' => [ 'shape' => 'boolean', ], 'type' => [ 'shape' => 'DomainEntryType', ], 'options' => [ 'shape' => 'DomainEntryOptions', 'deprecated' => true, ], ], ], 'DomainEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainEntry', ], ], 'DomainEntryOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'DomainEntryOptionsKeys', ], 'value' => [ 'shape' => 'string', ], ], 'DomainEntryOptionsKeys' => [ 'type' => 'string', ], 'DomainEntryType' => [ 'type' => 'string', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Domain', ], ], 'DomainName' => [ 'type' => 'string', ], 'DomainNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'DownloadDefaultKeyPairRequest' => [ 'type' => 'structure', 'members' => [], ], 'DownloadDefaultKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], ], ], 'ExportSnapshotRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'ExportSnapshotRecordSourceInfo', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'ExportSnapshotRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportSnapshotRecord', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ExportSnapshotRecordSourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'fromResourceName' => [ 'shape' => 'NonEmptyString', ], 'fromResourceArn' => [ 'shape' => 'NonEmptyString', ], 'instanceSnapshotInfo' => [ 'shape' => 'InstanceSnapshotInfo', ], 'diskSnapshotInfo' => [ 'shape' => 'DiskSnapshotInfo', ], ], ], 'ExportSnapshotRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'InstanceSnapshot', 'DiskSnapshot', ], ], 'ExportSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'sourceSnapshotName', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'ExportSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'GetActiveNamesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetActiveNamesResult' => [ 'type' => 'structure', 'members' => [ 'activeNames' => [ 'shape' => 'StringList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'BlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'BundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsResult' => [ 'type' => 'structure', 'members' => [ 'cloudFormationStackRecords' => [ 'shape' => 'CloudFormationStackRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskResult' => [ 'type' => 'structure', 'members' => [ 'disk' => [ 'shape' => 'Disk', ], ], ], 'GetDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshot' => [ 'shape' => 'DiskSnapshot', ], ], ], 'GetDiskSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDiskSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshots' => [ 'shape' => 'DiskSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksResult' => [ 'type' => 'structure', 'members' => [ 'disks' => [ 'shape' => 'DiskList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'GetDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'Domain', ], ], ], 'GetDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainsResult' => [ 'type' => 'structure', 'members' => [ 'domains' => [ 'shape' => 'DomainList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsResult' => [ 'type' => 'structure', 'members' => [ 'exportSnapshotRecords' => [ 'shape' => 'ExportSnapshotRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceAccessDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], ], ], 'GetInstanceAccessDetailsResult' => [ 'type' => 'structure', 'members' => [ 'accessDetails' => [ 'shape' => 'InstanceAccessDetails', ], ], ], 'GetInstanceMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetInstanceMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetInstancePortStatesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstancePortStatesResult' => [ 'type' => 'structure', 'members' => [ 'portStates' => [ 'shape' => 'InstancePortStateList', ], ], ], 'GetInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceResult' => [ 'type' => 'structure', 'members' => [ 'instance' => [ 'shape' => 'Instance', ], ], ], 'GetInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshot' => [ 'shape' => 'InstanceSnapshot', ], ], ], 'GetInstanceSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshots' => [ 'shape' => 'InstanceSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceStateRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceStateResult' => [ 'type' => 'structure', 'members' => [ 'state' => [ 'shape' => 'InstanceState', ], ], ], 'GetInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstancesResult' => [ 'type' => 'structure', 'members' => [ 'instances' => [ 'shape' => 'InstanceList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'GetKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], ], ], 'GetKeyPairsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetKeyPairsResult' => [ 'type' => 'structure', 'members' => [ 'keyPairs' => [ 'shape' => 'KeyPairList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancerMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetLoadBalancerMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancer' => [ 'shape' => 'LoadBalancer', ], ], ], 'GetLoadBalancerTlsCertificatesRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerTlsCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'tlsCertificates' => [ 'shape' => 'LoadBalancerTlsCertificateList', ], ], ], 'GetLoadBalancersRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancersResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancers' => [ 'shape' => 'LoadBalancerList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationRequest' => [ 'type' => 'structure', 'required' => [ 'operationId', ], 'members' => [ 'operationId' => [ 'shape' => 'NonEmptyString', ], ], ], 'GetOperationResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'GetOperationsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageCount' => [ 'shape' => 'string', 'deprecated' => true, ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRegionsRequest' => [ 'type' => 'structure', 'members' => [ 'includeAvailabilityZones' => [ 'shape' => 'boolean', ], 'includeRelationalDatabaseAvailabilityZones' => [ 'shape' => 'boolean', ], ], ], 'GetRegionsResult' => [ 'type' => 'structure', 'members' => [ 'regions' => [ 'shape' => 'RegionList', ], ], ], 'GetRelationalDatabaseBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'RelationalDatabaseBlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'RelationalDatabaseBundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'durationInMinutes' => [ 'shape' => 'integer', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseEvents' => [ 'shape' => 'RelationalDatabaseEventList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'logStreamName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'logStreamName' => [ 'shape' => 'string', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'startFromHead' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsResult' => [ 'type' => 'structure', 'members' => [ 'resourceLogEvents' => [ 'shape' => 'LogEventList', ], 'nextBackwardToken' => [ 'shape' => 'string', ], 'nextForwardToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogStreamsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseLogStreamsResult' => [ 'type' => 'structure', 'members' => [ 'logStreams' => [ 'shape' => 'StringList', ], ], ], 'GetRelationalDatabaseMasterUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'passwordVersion' => [ 'shape' => 'RelationalDatabasePasswordVersion', ], ], ], 'GetRelationalDatabaseMasterUserPasswordResult' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'GetRelationalDatabaseMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetRelationalDatabaseMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabase' => [ 'shape' => 'RelationalDatabase', ], ], ], 'GetRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshot' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], ], 'GetRelationalDatabaseSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshots' => [ 'shape' => 'RelationalDatabaseSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabases' => [ 'shape' => 'RelationalDatabaseList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'GetStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'staticIp' => [ 'shape' => 'StaticIp', ], ], ], 'GetStaticIpsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetStaticIpsResult' => [ 'type' => 'structure', 'members' => [ 'staticIps' => [ 'shape' => 'StaticIpList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'ImportKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', 'publicKeyBase64', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], ], ], 'ImportKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'blueprintName' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'isStaticIp' => [ 'shape' => 'boolean', ], 'privateIpAddress' => [ 'shape' => 'IpAddress', ], 'publicIpAddress' => [ 'shape' => 'IpAddress', ], 'ipv6Address' => [ 'shape' => 'IpV6Address', ], 'hardware' => [ 'shape' => 'InstanceHardware', ], 'networking' => [ 'shape' => 'InstanceNetworking', ], 'state' => [ 'shape' => 'InstanceState', ], 'username' => [ 'shape' => 'NonEmptyString', ], 'sshKeyName' => [ 'shape' => 'ResourceName', ], ], ], 'InstanceAccessDetails' => [ 'type' => 'structure', 'members' => [ 'certKey' => [ 'shape' => 'string', ], 'expiresAt' => [ 'shape' => 'IsoDate', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'password' => [ 'shape' => 'string', ], 'passwordData' => [ 'shape' => 'PasswordData', ], 'privateKey' => [ 'shape' => 'string', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'username' => [ 'shape' => 'string', ], ], ], 'InstanceAccessProtocol' => [ 'type' => 'string', 'enum' => [ 'ssh', 'rdp', ], ], 'InstanceEntry' => [ 'type' => 'structure', 'required' => [ 'sourceName', 'instanceType', 'portInfoSource', 'availabilityZone', ], 'members' => [ 'sourceName' => [ 'shape' => 'ResourceName', ], 'instanceType' => [ 'shape' => 'NonEmptyString', ], 'portInfoSource' => [ 'shape' => 'PortInfoSourceType', ], 'userData' => [ 'shape' => 'string', ], 'availabilityZone' => [ 'shape' => 'string', ], ], ], 'InstanceEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceEntry', ], ], 'InstanceHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'disks' => [ 'shape' => 'DiskList', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'InstanceHealthReason' => [ 'type' => 'string', 'enum' => [ 'Lb.RegistrationInProgress', 'Lb.InitialHealthChecking', 'Lb.InternalError', 'Instance.ResponseCodeMismatch', 'Instance.Timeout', 'Instance.FailedHealthChecks', 'Instance.NotRegistered', 'Instance.NotInUse', 'Instance.DeregistrationInProgress', 'Instance.InvalidState', 'Instance.IpUnusable', ], ], 'InstanceHealthState' => [ 'type' => 'string', 'enum' => [ 'initial', 'healthy', 'unhealthy', 'unused', 'draining', 'unavailable', ], ], 'InstanceHealthSummary' => [ 'type' => 'structure', 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'instanceHealth' => [ 'shape' => 'InstanceHealthState', ], 'instanceHealthReason' => [ 'shape' => 'InstanceHealthReason', ], ], ], 'InstanceHealthSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceHealthSummary', ], ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'NetworkIn', 'NetworkOut', 'StatusCheckFailed', 'StatusCheckFailed_Instance', 'StatusCheckFailed_System', ], ], 'InstanceNetworking' => [ 'type' => 'structure', 'members' => [ 'monthlyTransfer' => [ 'shape' => 'MonthlyTransfer', ], 'ports' => [ 'shape' => 'InstancePortInfoList', ], ], ], 'InstancePlatform' => [ 'type' => 'string', 'enum' => [ 'LINUX_UNIX', 'WINDOWS', ], ], 'InstancePlatformList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePlatform', ], ], 'InstancePortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'accessFrom' => [ 'shape' => 'string', ], 'accessType' => [ 'shape' => 'PortAccessType', ], 'commonName' => [ 'shape' => 'string', ], 'accessDirection' => [ 'shape' => 'AccessDirection', ], ], ], 'InstancePortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortInfo', ], ], 'InstancePortState' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'state' => [ 'shape' => 'PortState', ], ], ], 'InstancePortStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortState', ], ], 'InstanceSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'state' => [ 'shape' => 'InstanceSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromAttachedDisks' => [ 'shape' => 'DiskList', ], 'fromInstanceName' => [ 'shape' => 'ResourceName', ], 'fromInstanceArn' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'string', ], 'fromBundleId' => [ 'shape' => 'string', ], 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'InstanceSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'fromBundleId' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'fromDiskInfo' => [ 'shape' => 'DiskInfoList', ], ], ], 'InstanceSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceSnapshot', ], ], 'InstanceSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', ], ], 'InstanceState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'integer', ], 'name' => [ 'shape' => 'string', ], ], ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', 'pattern' => '([0-9]{1,3}\\.){3}[0-9]{1,3}', ], 'IpV6Address' => [ 'type' => 'string', 'pattern' => '([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}', ], 'IsVpcPeeredRequest' => [ 'type' => 'structure', 'members' => [], ], 'IsVpcPeeredResult' => [ 'type' => 'structure', 'members' => [ 'isPeered' => [ 'shape' => 'boolean', ], ], ], 'IsoDate' => [ 'type' => 'timestamp', ], 'KeyPair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'fingerprint' => [ 'shape' => 'Base64', ], ], ], 'KeyPairList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyPair', ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'dnsName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'LoadBalancerState', ], 'protocol' => [ 'shape' => 'LoadBalancerProtocol', ], 'publicPorts' => [ 'shape' => 'PortList', ], 'healthCheckPath' => [ 'shape' => 'NonEmptyString', ], 'instancePort' => [ 'shape' => 'integer', ], 'instanceHealthSummary' => [ 'shape' => 'InstanceHealthSummaryList', ], 'tlsCertificateSummaries' => [ 'shape' => 'LoadBalancerTlsCertificateSummaryList', ], 'configurationOptions' => [ 'shape' => 'LoadBalancerConfigurationOptions', ], ], ], 'LoadBalancerAttributeName' => [ 'type' => 'string', 'enum' => [ 'HealthCheckPath', 'SessionStickinessEnabled', 'SessionStickiness_LB_CookieDurationSeconds', ], ], 'LoadBalancerConfigurationOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LoadBalancerAttributeName', ], 'value' => [ 'shape' => 'string', ], ], 'LoadBalancerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LoadBalancerMetricName' => [ 'type' => 'string', 'enum' => [ 'ClientTLSNegotiationErrorCount', 'HealthyHostCount', 'UnhealthyHostCount', 'HTTPCode_LB_4XX_Count', 'HTTPCode_LB_5XX_Count', 'HTTPCode_Instance_2XX_Count', 'HTTPCode_Instance_3XX_Count', 'HTTPCode_Instance_4XX_Count', 'HTTPCode_Instance_5XX_Count', 'InstanceResponseTime', 'RejectedConnectionCount', 'RequestCount', ], ], 'LoadBalancerProtocol' => [ 'type' => 'string', 'enum' => [ 'HTTP_HTTPS', 'HTTP', ], ], 'LoadBalancerState' => [ 'type' => 'string', 'enum' => [ 'active', 'provisioning', 'active_impaired', 'failed', 'unknown', ], ], 'LoadBalancerTlsCertificate' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'status' => [ 'shape' => 'LoadBalancerTlsCertificateStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainValidationRecords' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecordList', ], 'failureReason' => [ 'shape' => 'LoadBalancerTlsCertificateFailureReason', ], 'issuedAt' => [ 'shape' => 'IsoDate', ], 'issuer' => [ 'shape' => 'NonEmptyString', ], 'keyAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'notAfter' => [ 'shape' => 'IsoDate', ], 'notBefore' => [ 'shape' => 'IsoDate', ], 'renewalSummary' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalSummary', ], 'revocationReason' => [ 'shape' => 'LoadBalancerTlsCertificateRevocationReason', ], 'revokedAt' => [ 'shape' => 'IsoDate', ], 'serial' => [ 'shape' => 'NonEmptyString', ], 'signatureAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'subject' => [ 'shape' => 'NonEmptyString', ], 'subjectAlternativeNames' => [ 'shape' => 'StringList', ], ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'FAILED', 'SUCCESS', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'type' => 'structure', 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOption', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'NonEmptyString', ], 'value' => [ 'shape' => 'NonEmptyString', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecord', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'type' => 'string', 'enum' => [ 'NO_AVAILABLE_CONTACTS', 'ADDITIONAL_VERIFICATION_REQUIRED', 'DOMAIN_NOT_ALLOWED', 'INVALID_PUBLIC_DOMAIN', 'OTHER', ], ], 'LoadBalancerTlsCertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificate', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_AUTO_RENEWAL', 'PENDING_VALIDATION', 'SUCCESS', 'FAILED', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'type' => 'structure', 'members' => [ 'renewalStatus' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalStatus', ], 'domainValidationOptions' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOptionList', ], ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'type' => 'string', 'enum' => [ 'UNSPECIFIED', 'KEY_COMPROMISE', 'CA_COMPROMISE', 'AFFILIATION_CHANGED', 'SUPERCEDED', 'CESSATION_OF_OPERATION', 'CERTIFICATE_HOLD', 'REMOVE_FROM_CRL', 'PRIVILEGE_WITHDRAWN', 'A_A_COMPROMISE', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED', 'UNKNOWN', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateSummary', ], ], 'LogEvent' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], ], ], 'LogEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogEvent', ], ], 'MetricDatapoint' => [ 'type' => 'structure', 'members' => [ 'average' => [ 'shape' => 'double', ], 'maximum' => [ 'shape' => 'double', ], 'minimum' => [ 'shape' => 'double', ], 'sampleCount' => [ 'shape' => 'double', ], 'sum' => [ 'shape' => 'double', ], 'timestamp' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], ], ], 'MetricDatapointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatapoint', ], ], 'MetricPeriod' => [ 'type' => 'integer', 'max' => 86400, 'min' => 60, ], 'MetricStatistic' => [ 'type' => 'string', 'enum' => [ 'Minimum', 'Maximum', 'Sum', 'Average', 'SampleCount', ], ], 'MetricStatisticList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricStatistic', ], ], 'MetricUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Microseconds', 'Milliseconds', 'Bytes', 'Kilobytes', 'Megabytes', 'Gigabytes', 'Terabytes', 'Bits', 'Kilobits', 'Megabits', 'Gigabits', 'Terabits', 'Percent', 'Count', 'Bytes/Second', 'Kilobytes/Second', 'Megabytes/Second', 'Gigabytes/Second', 'Terabytes/Second', 'Bits/Second', 'Kilobits/Second', 'Megabits/Second', 'Gigabits/Second', 'Terabits/Second', 'Count/Second', 'None', ], ], 'MonthlyTransfer' => [ 'type' => 'structure', 'members' => [ 'gbPerMonthAllocated' => [ 'shape' => 'integer', ], ], ], 'NetworkProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'all', 'udp', ], ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'OpenInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'OpenInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'Operation' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'isTerminal' => [ 'shape' => 'boolean', ], 'operationDetails' => [ 'shape' => 'string', ], 'operationType' => [ 'shape' => 'OperationType', ], 'status' => [ 'shape' => 'OperationStatus', ], 'statusChangedAt' => [ 'shape' => 'IsoDate', ], 'errorCode' => [ 'shape' => 'string', ], 'errorDetails' => [ 'shape' => 'string', ], ], ], 'OperationFailureException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'OperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Operation', ], ], 'OperationStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'Started', 'Failed', 'Completed', 'Succeeded', ], ], 'OperationType' => [ 'type' => 'string', 'enum' => [ 'DeleteInstance', 'CreateInstance', 'StopInstance', 'StartInstance', 'RebootInstance', 'OpenInstancePublicPorts', 'PutInstancePublicPorts', 'CloseInstancePublicPorts', 'AllocateStaticIp', 'ReleaseStaticIp', 'AttachStaticIp', 'DetachStaticIp', 'UpdateDomainEntry', 'DeleteDomainEntry', 'CreateDomain', 'DeleteDomain', 'CreateInstanceSnapshot', 'DeleteInstanceSnapshot', 'CreateInstancesFromSnapshot', 'CreateLoadBalancer', 'DeleteLoadBalancer', 'AttachInstancesToLoadBalancer', 'DetachInstancesFromLoadBalancer', 'UpdateLoadBalancerAttribute', 'CreateLoadBalancerTlsCertificate', 'DeleteLoadBalancerTlsCertificate', 'AttachLoadBalancerTlsCertificate', 'CreateDisk', 'DeleteDisk', 'AttachDisk', 'DetachDisk', 'CreateDiskSnapshot', 'DeleteDiskSnapshot', 'CreateDiskFromSnapshot', 'CreateRelationalDatabase', 'UpdateRelationalDatabase', 'DeleteRelationalDatabase', 'CreateRelationalDatabaseFromSnapshot', 'CreateRelationalDatabaseSnapshot', 'DeleteRelationalDatabaseSnapshot', 'UpdateRelationalDatabaseParameters', 'StartRelationalDatabase', 'RebootRelationalDatabase', 'StopRelationalDatabase', ], ], 'PasswordData' => [ 'type' => 'structure', 'members' => [ 'ciphertext' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'PeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'PeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'NonEmptyString', ], 'description' => [ 'shape' => 'NonEmptyString', ], 'currentApplyDate' => [ 'shape' => 'IsoDate', ], ], ], 'PendingMaintenanceActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'string', ], 'engineVersion' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'PortAccessType' => [ 'type' => 'string', 'enum' => [ 'Public', 'Private', ], ], 'PortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], ], ], 'PortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortInfo', ], ], 'PortInfoSourceType' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'INSTANCE', 'NONE', 'CLOSED', ], ], 'PortList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Port', ], ], 'PortState' => [ 'type' => 'string', 'enum' => [ 'open', 'closed', ], ], 'PutInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfos', 'instanceName', ], 'members' => [ 'portInfos' => [ 'shape' => 'PortInfoList', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'PutInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'RebootInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RebootRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RecordState' => [ 'type' => 'string', 'enum' => [ 'Started', 'Succeeded', 'Failed', ], ], 'Region' => [ 'type' => 'structure', 'members' => [ 'continentCode' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'displayName' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'RegionName', ], 'availabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'relationalDatabaseAvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'RegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'RegionName' => [ 'type' => 'string', 'enum' => [ 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'eu-central-1', 'ca-central-1', 'ap-south-1', 'ap-southeast-1', 'ap-southeast-2', 'ap-northeast-1', 'ap-northeast-2', ], ], 'RelationalDatabase' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'relationalDatabaseBundleId' => [ 'shape' => 'NonEmptyString', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'hardware' => [ 'shape' => 'RelationalDatabaseHardware', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'secondaryAvailabilityZone' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], 'pendingModifiedValues' => [ 'shape' => 'PendingModifiedRelationalDatabaseValues', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'latestRestorableTime' => [ 'shape' => 'IsoDate', ], 'masterUsername' => [ 'shape' => 'NonEmptyString', ], 'parameterApplyStatus' => [ 'shape' => 'NonEmptyString', ], 'preferredBackupWindow' => [ 'shape' => 'NonEmptyString', ], 'preferredMaintenanceWindow' => [ 'shape' => 'NonEmptyString', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'masterEndpoint' => [ 'shape' => 'RelationalDatabaseEndpoint', ], 'pendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActionList', ], ], ], 'RelationalDatabaseBlueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'string', ], 'engine' => [ 'shape' => 'RelationalDatabaseEngine', ], 'engineVersion' => [ 'shape' => 'string', ], 'engineDescription' => [ 'shape' => 'string', ], 'engineVersionDescription' => [ 'shape' => 'string', ], 'isEngineDefault' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBlueprint', ], ], 'RelationalDatabaseBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'cpuCount' => [ 'shape' => 'integer', ], 'isEncrypted' => [ 'shape' => 'boolean', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBundle', ], ], 'RelationalDatabaseEndpoint' => [ 'type' => 'structure', 'members' => [ 'port' => [ 'shape' => 'integer', ], 'address' => [ 'shape' => 'NonEmptyString', ], ], ], 'RelationalDatabaseEngine' => [ 'type' => 'string', 'enum' => [ 'mysql', ], ], 'RelationalDatabaseEvent' => [ 'type' => 'structure', 'members' => [ 'resource' => [ 'shape' => 'ResourceName', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], 'eventCategories' => [ 'shape' => 'StringList', ], ], ], 'RelationalDatabaseEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseEvent', ], ], 'RelationalDatabaseHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'RelationalDatabaseList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabase', ], ], 'RelationalDatabaseMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'DatabaseConnections', 'DiskQueueDepth', 'FreeStorageSpace', 'NetworkReceiveThroughput', 'NetworkTransmitThroughput', ], ], 'RelationalDatabaseParameter' => [ 'type' => 'structure', 'members' => [ 'allowedValues' => [ 'shape' => 'string', ], 'applyMethod' => [ 'shape' => 'string', ], 'applyType' => [ 'shape' => 'string', ], 'dataType' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'isModifiable' => [ 'shape' => 'boolean', ], 'parameterName' => [ 'shape' => 'string', ], 'parameterValue' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseParameter', ], ], 'RelationalDatabasePasswordVersion' => [ 'type' => 'string', 'enum' => [ 'CURRENT', 'PREVIOUS', 'PENDING', ], ], 'RelationalDatabaseSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseName' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseArn' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseBundleId' => [ 'shape' => 'string', ], 'fromRelationalDatabaseBlueprintId' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], 'ReleaseStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'ReleaseStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'ResourceLocation' => [ 'type' => 'structure', 'members' => [ 'availabilityZone' => [ 'shape' => 'string', ], 'regionName' => [ 'shape' => 'RegionName', ], ], ], 'ResourceName' => [ 'type' => 'string', 'pattern' => '\\w[\\w\\-]*\\w', ], 'ResourceNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceName', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'Instance', 'StaticIp', 'KeyPair', 'InstanceSnapshot', 'Domain', 'PeeredVpc', 'LoadBalancer', 'LoadBalancerTlsCertificate', 'Disk', 'DiskSnapshot', 'RelationalDatabase', 'RelationalDatabaseSnapshot', 'ExportSnapshotRecord', 'CloudFormationStackRecord', ], ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'ServiceException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, 'fault' => true, ], 'StartInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'StartInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StartRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'StartRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StaticIp' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'StaticIpList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StaticIp', ], ], 'StopInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'StopInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StopRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'StopRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'string', ], ], 'StringMax256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tags', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'TagValue' => [ 'type' => 'string', ], 'UnauthenticatedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'UnpeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'UnpeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tagKeys', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'UpdateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateLoadBalancerAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'attributeName', 'attributeValue', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'attributeName' => [ 'shape' => 'LoadBalancerAttributeName', ], 'attributeValue' => [ 'shape' => 'StringMax256', ], ], ], 'UpdateLoadBalancerAttributeResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'parameters', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], ], ], 'UpdateRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'rotateMasterUserPassword' => [ 'shape' => 'boolean', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'enableBackupRetention' => [ 'shape' => 'boolean', ], 'disableBackupRetention' => [ 'shape' => 'boolean', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'applyImmediately' => [ 'shape' => 'boolean', ], ], ], 'UpdateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'boolean' => [ 'type' => 'boolean', ], 'double' => [ 'type' => 'double', ], 'float' => [ 'type' => 'float', ], 'integer' => [ 'type' => 'integer', ], 'string' => [ 'type' => 'string', ], 'timestamp' => [ 'type' => 'timestamp', ], ],]; diff --git a/src/data/lightsail/2016-11-28/docs-2.json b/src/data/lightsail/2016-11-28/docs-2.json index 455cdf2e32..7f8d9021dd 100644 --- a/src/data/lightsail/2016-11-28/docs-2.json +++ b/src/data/lightsail/2016-11-28/docs-2.json @@ -12,7 +12,7 @@ "CreateCloudFormationStack": "Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records
operation to get a list of the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack
operation again with the same export snapshot record.
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
The create disk snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name
parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a domain resource for the specified domain (e.g., example.com).
The create domain
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
The create domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
", "DownloadDefaultKeyPair": "Downloads the default SSH key pair from the user's account.
", - "ExportSnapshot": "Exports a Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack
operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot
operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots
or get disk snapshots
operations to get a list of snapshots that you can export to Amazon EC2.
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack
operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot
operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots
or get disk snapshots
operations to get a list of snapshots that you can export to Amazon EC2.
Returns the names of all active (not deleted) resources.
", "GetBlueprints": "Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
", "GetBundles": "Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
", @@ -88,12 +88,12 @@ "OpenInstancePublicPorts": "Adds public ports to an Amazon Lightsail instance.
The open instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Tries to peer the Lightsail VPC with the user's default VPC.
", "PutInstancePublicPorts": "Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
The put instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
The reboot instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Restarts a specific instance.
The reboot instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Restarts a specific database in Amazon Lightsail.
The reboot relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Deletes a specific static IP from your account.
", - "StartInstance": "Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
The start instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance
operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The start instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database
operation.
The start relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Stops a specific Amazon Lightsail instance that is currently running.
The stop instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The stop instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Stops a specific database that is currently running in Amazon Lightsail.
The stop relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.
The tag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide.
Attempts to unpeer the Lightsail VPC from the user's default VPC.
", @@ -1656,7 +1656,8 @@ "DiskInfo$path": "The disk path.
", "DiskMap$originalDiskPath": "The original disk path exposed to the instance (for example, /dev/sdh
).
The Amazon Resource Name (ARN) of the disk snapshot.
", - "DiskSnapshot$fromDiskArn": "The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.
", + "DiskSnapshot$fromDiskArn": "The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
", + "DiskSnapshot$fromInstanceArn": "The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
", "Domain$arn": "The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE
).
The ID of the domain recordset entry.
", "ExportSnapshotRecord$arn": "The Amazon Resource Name (ARN) of the export snapshot record.
", @@ -1882,7 +1883,7 @@ "PortInfoSourceType": { "base": null, "refs": { - "InstanceEntry$portInfoSource": "The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
DEFAULT — Use the default firewall settings from the image.
INSTANCE — Use the firewall settings from the source Lightsail instance.
NONE — Default to Amazon EC2.
The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
DEFAULT — Use the default firewall settings from the image.
INSTANCE — Use the firewall settings from the source Lightsail instance.
NONE — Default to Amazon EC2.
CLOSED — All ports closed.
The unique Lightsail disk name (e.g., my-disk
).
The name of the disk snapshot (e.g., my-snapshot
) from which to create the new storage disk.
The unique Lightsail disk name (e.g., my-disk
).
The unique name of the source disk (e.g., my-source-disk
).
The unique name of the source disk (e.g., Disk-Virginia-1
).
This parameter cannot be defined together with the instance name
parameter. The disk name
and instance name
parameters are mutually exclusive.
The name of the destination disk snapshot (e.g., my-disk-snapshot
) based on the source disk.
The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1
). When this is defined, a snapshot of the instance's system volume is created.
This parameter cannot be defined together with the disk name
parameter. The instance name
and disk name
parameters are mutually exclusive.
The name for your new snapshot.
", "CreateInstanceSnapshotRequest$instanceName": "The Lightsail instance on which to base your snapshot.
", "CreateInstancesFromSnapshotRequest$instanceSnapshotName": "The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
", @@ -2146,7 +2148,8 @@ "Disk$attachedTo": "The resources to which the disk is attached.
", "DiskMap$newDiskName": "The new disk name (e.g., my-new-disk
).
The name of the disk snapshot (e.g., my-disk-snapshot
).
The unique name of the source disk from which you are creating the disk snapshot.
", + "DiskSnapshot$fromDiskName": "The unique name of the source disk from which the disk snapshot was created.
", + "DiskSnapshot$fromInstanceName": "The unique name of the source instance from which the disk (system volume) snapshot was created.
", "Domain$name": "The name of the domain.
", "ExportSnapshotRecord$name": "The export snapshot record name.
", "ExportSnapshotRequest$sourceSnapshotName": "The name of the instance or disk snapshot to be exported to Amazon EC2.
", diff --git a/src/data/lightsail/2016-11-28/docs-2.json.php b/src/data/lightsail/2016-11-28/docs-2.json.php index 046a52e180..b93adabe56 100644 --- a/src/data/lightsail/2016-11-28/docs-2.json.php +++ b/src/data/lightsail/2016-11-28/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
', 'operations' => [ 'AllocateStaticIp' => 'Allocates a static IP address.
', 'AttachDisk' => 'Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk
operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide.
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate
operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The attach load balancer tls certificate
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Attaches a static IP address to a specific Amazon Lightsail instance.
', 'CloseInstancePublicPorts' => 'Closes the public ports on a specific Amazon Lightsail instance.
The close instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.
', 'CreateCloudFormationStack' => 'Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records
operation to get a list of the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack
operation again with the same export snapshot record.
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
The create disk snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a domain resource for the specified domain (e.g., example.com).
The create domain
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
The create domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.
The create instances
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
The create instances from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide.
Creates an SSH key pair.
The create key pair
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute
operation.
The create load balancer
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The create load balancer tls certificate
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Creates a new database in Amazon Lightsail.
The create relational database
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Deletes the specified block storage disk. The disk must be in the available
state (not attached to a Lightsail instance).
The disk may remain in the deleting
state for several minutes.
The delete disk
operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide.
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot
operation supports tag-based access control via resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide.
Deletes the specified domain recordset and all of its domain records.
The delete domain
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Deletes a specific domain entry.
The delete domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Deletes a specific Amazon Lightsail virtual private server, or instance.
The delete instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Deletes a specific snapshot of a virtual private server (or instance).
The delete instance snapshot
operation supports tag-based access control via resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide.
Deletes a specific SSH key pair.
The delete key pair
operation supports tag-based access control via resource tags applied to the resource identified by keyPairName. For more information, see the Lightsail Dev Guide.
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The delete load balancer tls certificate
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Deletes a database in Amazon Lightsail.
The delete relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The detach disk
operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide.
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
', 'DownloadDefaultKeyPair' => 'Downloads the default SSH key pair from the user\'s account.
', 'ExportSnapshot' => 'Exports a Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack
operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot
operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots
or get disk snapshots
operations to get a list of snapshots that you can export to Amazon EC2.
Returns the names of all active (not deleted) resources.
', 'GetBlueprints' => 'Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
', 'GetBundles' => 'Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
', 'GetCloudFormationStackRecords' => 'Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
', 'GetDisk' => 'Returns information about a specific block storage disk.
', 'GetDiskSnapshot' => 'Returns information about a specific block storage disk snapshot.
', 'GetDiskSnapshots' => 'Returns information about all block storage disk snapshots in your AWS account and region.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
', 'GetDisks' => 'Returns information about all block storage disks in your AWS account and region.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
', 'GetDomain' => 'Returns information about a specific domain recordset.
', 'GetDomains' => 'Returns a list of all domains in the user\'s account.
', 'GetExportSnapshotRecords' => 'Returns the export snapshot record created as a result of the export snapshot
operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack
operation.
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
', 'GetInstanceAccessDetails' => 'Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
The get instance access details
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
', 'GetInstancePortStates' => 'Returns the port states for a specific virtual private server, or instance.
', 'GetInstanceSnapshot' => 'Returns information about a specific instance snapshot.
', 'GetInstanceSnapshots' => 'Returns all instance snapshots for the user\'s account.
', 'GetInstanceState' => 'Returns the state of a specific instance. Works on one instance at a time.
', 'GetInstances' => 'Returns information about all Amazon Lightsail virtual private servers, or instances.
', 'GetKeyPair' => 'Returns information about a specific key pair.
', 'GetKeyPairs' => 'Returns information about all key pairs in the user\'s account.
', 'GetLoadBalancer' => 'Returns information about the specified Lightsail load balancer.
', 'GetLoadBalancerMetricData' => 'Returns information about health metrics for your Lightsail load balancer.
', 'GetLoadBalancerTlsCertificates' => 'Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
', 'GetLoadBalancers' => 'Returns information about all load balancers in an account.
If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
', 'GetOperation' => 'Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
', 'GetOperations' => 'Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations
use the maximum (last) statusChangedAt
value from the previous request.
Gets operations for a specific resource (e.g., an instance or a static IP).
', 'GetRegions' => 'Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones
parameter to also return the Availability Zones in a region.
Returns information about a specific database in Amazon Lightsail.
', 'GetRelationalDatabaseBlueprints' => 'Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
', 'GetRelationalDatabaseBundles' => 'Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
', 'GetRelationalDatabaseEvents' => 'Returns a list of events for a specific database in Amazon Lightsail.
', 'GetRelationalDatabaseLogEvents' => 'Returns a list of log events for a database in Amazon Lightsail.
', 'GetRelationalDatabaseLogStreams' => 'Returns a list of available log streams for a specific database in Amazon Lightsail.
', 'GetRelationalDatabaseMasterUserPassword' => 'Returns the current, previous, or pending versions of the master user password for a Lightsail database.
The asdf
operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.
Returns the data points of the specified metric for a database in Amazon Lightsail.
', 'GetRelationalDatabaseParameters' => 'Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
', 'GetRelationalDatabaseSnapshot' => 'Returns information about a specific database snapshot in Amazon Lightsail.
', 'GetRelationalDatabaseSnapshots' => 'Returns information about all of your database snapshots in Amazon Lightsail.
', 'GetRelationalDatabases' => 'Returns information about all of your databases in Amazon Lightsail.
', 'GetStaticIp' => 'Returns information about a specific static IP.
', 'GetStaticIps' => 'Returns information about all static IPs in the user\'s account.
', 'ImportKeyPair' => 'Imports a public SSH key from a specific key pair.
', 'IsVpcPeered' => 'Returns a Boolean value indicating whether your Lightsail VPC is peered.
', 'OpenInstancePublicPorts' => 'Adds public ports to an Amazon Lightsail instance.
The open instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Tries to peer the Lightsail VPC with the user\'s default VPC.
', 'PutInstancePublicPorts' => 'Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
The put instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
The reboot instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Restarts a specific database in Amazon Lightsail.
The reboot relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Deletes a specific static IP from your account.
', 'StartInstance' => 'Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
The start instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database
operation.
The start relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Stops a specific Amazon Lightsail instance that is currently running.
The stop instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Stops a specific database that is currently running in Amazon Lightsail.
The stop relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.
The tag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide.
Attempts to unpeer the Lightsail VPC from the user\'s default VPC.
', 'UntagResource' => 'Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The untag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide.
Updates a domain recordset after it is created.
The update domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Updates the specified attribute for a load balancer. You can only update one attribute at a time.
The update load balancer attribute
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database\'s predefined maintenance window.
The update relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don\'t cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: dynamic
or pending-reboot
. Parameters marked with a dynamic
apply type are applied immediately. Parameters marked with a pending-reboot
apply type are applied only after the database is rebooted using the reboot relational database
operation.
The update relational database parameters
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
', 'refs' => [], ], 'AccessDirection' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessDirection' => 'The access direction (inbound
or outbound
).
Lightsail throws this exception when an account is still in the setup in progress state.
', 'refs' => [], ], 'AllocateStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachedDiskMap' => [ 'base' => NULL, 'refs' => [ 'CreateInstancesFromSnapshotRequest$attachedDiskMapping' => 'An object containing information about one or more disk mappings.
', ], ], 'AvailabilityZone' => [ 'base' => 'Describes an Availability Zone.
', 'refs' => [ 'AvailabilityZoneList$member' => NULL, ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'Region$availabilityZones' => 'The Availability Zones. Follows the format us-east-2a
(case-sensitive).
The Availability Zones for databases. Follows the format us-east-2a
(case-sensitive).
A base64-encoded public key of the ssh-rsa
type.
A base64-encoded RSA private key.
', 'DownloadDefaultKeyPairResult$publicKeyBase64' => 'A base64-encoded public key of the ssh-rsa
type.
A base64-encoded RSA private key.
', 'ImportKeyPairRequest$publicKeyBase64' => 'A base64-encoded public key of the ssh-rsa
type.
The RSA fingerprint of the key pair.
', ], ], 'Blueprint' => [ 'base' => 'Describes a blueprint (a virtual private server image).
', 'refs' => [ 'BlueprintList$member' => NULL, ], ], 'BlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintsResult$blueprints' => 'An array of key-value pairs that contains information about the available blueprints.
', ], ], 'BlueprintType' => [ 'base' => NULL, 'refs' => [ 'Blueprint$type' => 'The type of the blueprint (e.g., os
or app
).
Describes a bundle, which is a set of specs describing your virtual private server (or instance).
', 'refs' => [ 'BundleList$member' => NULL, ], ], 'BundleList' => [ 'base' => NULL, 'refs' => [ 'GetBundlesResult$bundles' => 'An array of key-value pairs that contains information about the available bundles.
', ], ], 'CloseInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CloseInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'CloudFormationStackRecord' => [ 'base' => 'Describes a CloudFormation stack record created as a result of the create cloud formation stack
operation.
A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.
', 'refs' => [ 'CloudFormationStackRecordList$member' => NULL, ], ], 'CloudFormationStackRecordList' => [ 'base' => NULL, 'refs' => [ 'GetCloudFormationStackRecordsResult$cloudFormationStackRecords' => 'A list of objects describing the CloudFormation stack records.
', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'base' => 'Describes the source of a CloudFormation stack record (i.e., the export snapshot record).
', 'refs' => [ 'CloudFormationStackRecordSourceInfoList$member' => NULL, ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$sourceInfo' => 'A list of objects describing the source of the CloudFormation stack record.
', ], ], 'CloudFormationStackRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecordSourceInfo$resourceType' => 'The Lightsail resource type (e.g., ExportSnapshotRecord
).
Describes the destination of a record.
', 'refs' => [ 'CloudFormationStackRecord$destinationInfo' => 'A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
', 'ExportSnapshotRecord$destinationInfo' => 'A list of objects describing the destination of the export snapshot record.
', ], ], 'DetachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'Disk' => [ 'base' => 'Describes a system disk or an block storage disk.
', 'refs' => [ 'DiskList$member' => NULL, 'GetDiskResult$disk' => 'An object containing information about the disk.
', ], ], 'DiskInfo' => [ 'base' => 'Describes a disk.
', 'refs' => [ 'DiskInfoList$member' => NULL, ], ], 'DiskInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshotInfo$fromDiskInfo' => 'A list of objects describing the disks that were attached to the source instance.
', ], ], 'DiskList' => [ 'base' => NULL, 'refs' => [ 'GetDisksResult$disks' => 'An array of objects containing information about all block storage disks.
', 'InstanceHardware$disks' => 'The disks attached to the instance.
', 'InstanceSnapshot$fromAttachedDisks' => 'An array of disk objects containing information about all block storage disks.
', ], ], 'DiskMap' => [ 'base' => 'Describes a block storage disk mapping.
', 'refs' => [ 'DiskMapList$member' => NULL, ], ], 'DiskMapList' => [ 'base' => NULL, 'refs' => [ 'AttachedDiskMap$value' => NULL, ], ], 'DiskSnapshot' => [ 'base' => 'Describes a block storage disk snapshot.
', 'refs' => [ 'DiskSnapshotList$member' => NULL, 'GetDiskSnapshotResult$diskSnapshot' => 'An object containing information about the disk snapshot.
', ], ], 'DiskSnapshotInfo' => [ 'base' => 'Describes a disk snapshot.
', 'refs' => [ 'ExportSnapshotRecordSourceInfo$diskSnapshotInfo' => 'A list of objects describing a disk snapshot.
', ], ], 'DiskSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetDiskSnapshotsResult$diskSnapshots' => 'An array of objects containing information about all block storage disk snapshots.
', ], ], 'DiskSnapshotState' => [ 'base' => NULL, 'refs' => [ 'DiskSnapshot$state' => 'The status of the disk snapshot operation.
', ], ], 'DiskState' => [ 'base' => NULL, 'refs' => [ 'Disk$state' => 'Describes the status of the disk.
', ], ], 'Domain' => [ 'base' => 'Describes a domain where you are storing recordsets in Lightsail.
', 'refs' => [ 'DomainList$member' => NULL, 'GetDomainResult$domain' => 'An array of key-value pairs containing information about your get domain request.
', ], ], 'DomainEntry' => [ 'base' => 'Describes a domain recordset entry.
', 'refs' => [ 'CreateDomainEntryRequest$domainEntry' => 'An array of key-value pairs containing information about the domain entry request.
', 'DeleteDomainEntryRequest$domainEntry' => 'An array of key-value pairs containing information about your domain entries.
', 'DomainEntryList$member' => NULL, 'UpdateDomainEntryRequest$domainEntry' => 'An array of key-value pairs containing information about the domain entry.
', ], ], 'DomainEntryList' => [ 'base' => NULL, 'refs' => [ 'Domain$domainEntries' => 'An array of key-value pairs containing information about the domain entries.
', ], ], 'DomainEntryOptions' => [ 'base' => NULL, 'refs' => [ 'DomainEntry$options' => '(Deprecated) The options for the domain entry.
In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
The type of domain entry (e.g., SOA
or NS
).
An array of key-value pairs containing information about each of the domain entries in the user\'s account.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainEntryRequest$domainName' => 'The domain name (e.g., example.com
) for which you want to create the domain entry.
The domain name to manage (e.g., example.com
).
You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.
The domain name with which your certificate is associated (e.g., example.com
).
If you specify certificateDomainName
, then certificateName
is required (and vice-versa).
The domain name (e.g., example.com
) for your SSL/TLS certificate.
The name of the domain entry to delete.
', 'DeleteDomainRequest$domainName' => 'The specific domain name to delete.
', 'DomainEntry$name' => 'The name of the domain.
', 'DomainNameList$member' => NULL, 'GetDomainRequest$domainName' => 'The domain name for which your want to return information about.
', 'LoadBalancerTlsCertificate$domainName' => 'The domain name for your SSL/TLS certificate.
', 'LoadBalancerTlsCertificateDomainValidationOption$domainName' => 'The fully qualified domain name in the certificate request.
', 'LoadBalancerTlsCertificateDomainValidationRecord$domainName' => 'The domain name against which your SSL/TLS certificate was validated.
', 'UpdateDomainEntryRequest$domainName' => 'The name of the domain recordset to update.
', ], ], 'DomainNameList' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$certificateAlternativeNames' => 'The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com
, example.com
, m.example.com
, blog.example.com
).
An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com
).
Describes an export snapshot record.
', 'refs' => [ 'ExportSnapshotRecordList$member' => NULL, ], ], 'ExportSnapshotRecordList' => [ 'base' => NULL, 'refs' => [ 'GetExportSnapshotRecordsResult$exportSnapshotRecords' => 'A list of objects describing the export snapshot records.
', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'base' => 'Describes the source of an export snapshot record.
', 'refs' => [ 'ExportSnapshotRecord$sourceInfo' => 'A list of objects describing the source of the export snapshot record.
', ], ], 'ExportSnapshotRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'ExportSnapshotRecordSourceInfo$resourceType' => 'The Lightsail resource type (e.g., InstanceSnapshot
or DiskSnapshot
).
Describes an instance (a virtual private server).
', 'refs' => [ 'GetInstanceResult$instance' => 'An array of key-value pairs containing information about the specified instance.
', 'InstanceList$member' => NULL, ], ], 'InstanceAccessDetails' => [ 'base' => 'The parameters for gaining temporary access to one of your Amazon Lightsail instances.
', 'refs' => [ 'GetInstanceAccessDetailsResult$accessDetails' => 'An array of key-value pairs containing information about a get instance access request.
', ], ], 'InstanceAccessProtocol' => [ 'base' => NULL, 'refs' => [ 'GetInstanceAccessDetailsRequest$protocol' => 'The protocol to use to connect to your instance. Defaults to ssh
.
The protocol for these Amazon Lightsail instance access details.
', ], ], 'InstanceEntry' => [ 'base' => 'Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack
operation.
An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.
', ], ], 'InstanceHardware' => [ 'base' => 'Describes the hardware for the instance.
', 'refs' => [ 'Instance$hardware' => 'The size of the vCPU and the amount of RAM for the instance.
', ], ], 'InstanceHealthReason' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthSummary$instanceHealthReason' => 'More information about the instance health. If the instanceHealth
is healthy
, then an instanceHealthReason
value is not provided.
If instanceHealth
is initial
, the instanceHealthReason
value can be one of the following:
Lb.RegistrationInProgress
- The target instance is in the process of being registered with the load balancer.
Lb.InitialHealthChecking
- The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
If instanceHealth
is unhealthy
, the instanceHealthReason
value can be one of the following:
Instance.ResponseCodeMismatch
- The health checks did not return an expected HTTP code.
Instance.Timeout
- The health check requests timed out.
Instance.FailedHealthChecks
- The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
Lb.InternalError
- The health checks failed due to an internal error.
If instanceHealth
is unused
, the instanceHealthReason
value can be one of the following:
Instance.NotRegistered
- The target instance is not registered with the target group.
Instance.NotInUse
- The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
Instance.IpUnusable
- The target IP address is reserved for use by a Lightsail load balancer.
Instance.InvalidState
- The target is in the stopped or terminated state.
If instanceHealth
is draining
, the instanceHealthReason
value can be one of the following:
Instance.DeregistrationInProgress
- The target instance is in the process of being deregistered and the deregistration delay period has not expired.
Describes the overall instance health. Valid values are below.
', ], ], 'InstanceHealthSummary' => [ 'base' => 'Describes information about the health of the instance.
', 'refs' => [ 'InstanceHealthSummaryList$member' => NULL, ], ], 'InstanceHealthSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$instanceHealthSummary' => 'An array of InstanceHealthSummary objects describing the health of the load balancer.
', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'GetInstancesResult$instances' => 'An array of key-value pairs containing information about your instances.
', ], ], 'InstanceMetricName' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$metricName' => 'The metric name to get data about.
', 'GetInstanceMetricDataResult$metricName' => 'The metric name to return data for.
', ], ], 'InstanceNetworking' => [ 'base' => 'Describes monthly data transfer rates and port information for an instance.
', 'refs' => [ 'Instance$networking' => 'Information about the public ports and monthly data transfer rates for the instance.
', ], ], 'InstancePlatform' => [ 'base' => NULL, 'refs' => [ 'Blueprint$platform' => 'The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
', 'InstancePlatformList$member' => NULL, ], ], 'InstancePlatformList' => [ 'base' => NULL, 'refs' => [ 'Bundle$supportedPlatforms' => 'The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS
bundle on a blueprint that supports the WINDOWS
platform. LINUX_UNIX
blueprints require a LINUX_UNIX
bundle.
Describes information about the instance ports.
', 'refs' => [ 'InstancePortInfoList$member' => NULL, ], ], 'InstancePortInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceNetworking$ports' => 'An array of key-value pairs containing information about the ports on the instance.
', ], ], 'InstancePortState' => [ 'base' => 'Describes the port state.
', 'refs' => [ 'InstancePortStateList$member' => NULL, ], ], 'InstancePortStateList' => [ 'base' => NULL, 'refs' => [ 'GetInstancePortStatesResult$portStates' => 'Information about the port states resulting from your request.
', ], ], 'InstanceSnapshot' => [ 'base' => 'Describes the snapshot of the virtual private server, or instance.
', 'refs' => [ 'GetInstanceSnapshotResult$instanceSnapshot' => 'An array of key-value pairs containing information about the results of your get instance snapshot request.
', 'InstanceSnapshotList$member' => NULL, ], ], 'InstanceSnapshotInfo' => [ 'base' => 'Describes an instance snapshot.
', 'refs' => [ 'ExportSnapshotRecordSourceInfo$instanceSnapshotInfo' => 'A list of objects describing an instance snapshot.
', ], ], 'InstanceSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceSnapshotsResult$instanceSnapshots' => 'An array of key-value pairs containing information about the results of your get instance snapshots request.
', ], ], 'InstanceSnapshotState' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshot$state' => 'The state the snapshot is in.
', ], ], 'InstanceState' => [ 'base' => 'Describes the virtual private server (or instance) status.
', 'refs' => [ 'GetInstanceStateResult$state' => 'The state of the instance.
', 'Instance$state' => 'The status code and the state (e.g., running
) for the instance.
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
The private IP address of the instance.
', 'Instance$publicIpAddress' => 'The public IP address of the instance.
', 'InstanceAccessDetails$ipAddress' => 'The public IP address of the Amazon Lightsail instance.
', 'StaticIp$ipAddress' => 'The static IP address.
', ], ], 'IpV6Address' => [ 'base' => NULL, 'refs' => [ 'Instance$ipv6Address' => 'The IPv6 address of the instance.
', ], ], 'IsVpcPeeredRequest' => [ 'base' => NULL, 'refs' => [], ], 'IsVpcPeeredResult' => [ 'base' => NULL, 'refs' => [], ], 'IsoDate' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$createdAt' => 'The date when the CloudFormation stack record was created.
', 'CreateRelationalDatabaseFromSnapshotRequest$restoreTime' => 'The date and time to restore your database from.
Constraints:
Must be before the latest restorable time for the database.
Cannot be specified if the use latest restorable time
parameter is true
.
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the restore time.
The date when the disk was created.
', 'DiskSnapshot$createdAt' => 'The date when the disk snapshot was created.
', 'Domain$createdAt' => 'The date when the domain recordset was created.
', 'ExportSnapshotRecord$createdAt' => 'The date when the export snapshot record was created.
', 'ExportSnapshotRecordSourceInfo$createdAt' => 'The date when the source instance or disk snapshot was created.
', 'GetRelationalDatabaseLogEventsRequest$startTime' => 'The start of the time interval from which to get log events.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the start time.
The end of the time interval from which to get log events.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the end time.
The timestamp when the specified version of the master user password was created.
', 'GetRelationalDatabaseMetricDataRequest$startTime' => 'The start of the time interval from which to get metric data.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the start time.
The end of the time interval from which to get metric data.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the end time.
The timestamp when the instance was created (e.g., 1479734909.17
).
For SSH access, the date on which the temporary keys expire.
', 'InstanceSnapshot$createdAt' => 'The timestamp when the snapshot was created (e.g., 1479907467.024
).
The timestamp when the key pair was created (e.g., 1479816991.349
).
The date when your load balancer was created.
', 'LoadBalancerTlsCertificate$createdAt' => 'The time when you created your SSL/TLS certificate.
', 'LoadBalancerTlsCertificate$issuedAt' => 'The time when the SSL/TLS certificate was issued.
', 'LoadBalancerTlsCertificate$notAfter' => 'The timestamp when the SSL/TLS certificate expires.
', 'LoadBalancerTlsCertificate$notBefore' => 'The timestamp when the SSL/TLS certificate is first valid.
', 'LoadBalancerTlsCertificate$revokedAt' => 'The timestamp when the SSL/TLS certificate was revoked.
', 'LogEvent$createdAt' => 'The timestamp when the database log event was created.
', 'Operation$createdAt' => 'The timestamp when the operation was initialized (e.g., 1479816991.349
).
The timestamp when the status was changed (e.g., 1479816991.349
).
The effective date of the pending database maintenance action.
', 'RelationalDatabase$createdAt' => 'The timestamp when the database was created. Formatted in Unix time.
', 'RelationalDatabase$latestRestorableTime' => 'The latest point in time to which the database can be restored. Formatted in Unix time.
', 'RelationalDatabaseEvent$createdAt' => 'The timestamp when the database event was created.
', 'RelationalDatabaseSnapshot$createdAt' => 'The timestamp when the database snapshot was created.
', 'StaticIp$createdAt' => 'The timestamp when the static IP was created (e.g., 1479735304.222
).
Describes the SSH key pair.
', 'refs' => [ 'CreateKeyPairResult$keyPair' => 'An array of key-value pairs containing information about the new key pair you just created.
', 'GetKeyPairResult$keyPair' => 'An array of key-value pairs containing information about the key pair.
', 'KeyPairList$member' => NULL, ], ], 'KeyPairList' => [ 'base' => NULL, 'refs' => [ 'GetKeyPairsResult$keyPairs' => 'An array of key-value pairs containing information about the key pairs.
', ], ], 'LoadBalancer' => [ 'base' => 'Describes the Lightsail load balancer.
', 'refs' => [ 'GetLoadBalancerResult$loadBalancer' => 'An object containing information about your load balancer.
', 'LoadBalancerList$member' => NULL, ], ], 'LoadBalancerAttributeName' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerConfigurationOptions$key' => NULL, 'UpdateLoadBalancerAttributeRequest$attributeName' => 'The name of the attribute you want to update. Valid values are below.
', ], ], 'LoadBalancerConfigurationOptions' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$configurationOptions' => 'A string to string map of the configuration options for your load balancer. Valid values are listed below.
', ], ], 'LoadBalancerList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancersResult$loadBalancers' => 'An array of LoadBalancer objects describing your load balancers.
', ], ], 'LoadBalancerMetricName' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerMetricDataRequest$metricName' => 'The metric about which you want to return information. Valid values are listed below, along with the most useful statistics
to include in your request.
ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
Statistics
: The most useful statistic is Sum
.
HealthyHostCount
- The number of target instances that are considered healthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
UnhealthyHostCount
- The number of target instances that are considered unhealthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.
Statistics
: The most useful statistic is Average
.
RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.
Statistics
: The most useful statistic is Sum
.
RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics
to include in your request.
ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
Statistics
: The most useful statistic is Sum
.
HealthyHostCount
- The number of target instances that are considered healthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
UnhealthyHostCount
- The number of target instances that are considered unhealthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.
Statistics
: The most useful statistic is Average
.
RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.
Statistics
: The most useful statistic is Sum
.
RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
The protocol you have enabled for your load balancer. Valid values are below.
You can\'t just have HTTP_HTTPS
, but you can have just HTTP
.
The status of your load balancer. Valid values are below.
', ], ], 'LoadBalancerTlsCertificate' => [ 'base' => 'Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
', 'refs' => [ 'LoadBalancerTlsCertificateList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOption$validationStatus' => 'The status of the domain validation. Valid values are listed below.
', 'LoadBalancerTlsCertificateDomainValidationRecord$validationStatus' => 'The validation status. Valid values are listed below.
', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'base' => 'Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.
', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOptionList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$domainValidationOptions' => 'Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail\'s managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.
', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'base' => 'Describes the validation record of each domain name in the SSL/TLS certificate.
', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationRecordList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$domainValidationRecords' => 'An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$failureReason' => 'The reason for the SSL/TLS certificate validation failure.
', ], ], 'LoadBalancerTlsCertificateList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerTlsCertificatesResult$tlsCertificates' => 'An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$renewalStatus' => 'The status of Lightsail\'s managed renewal of the certificate. Valid values are listed below.
', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'base' => 'Contains information about the status of Lightsail\'s managed renewal for the certificate.
', 'refs' => [ 'LoadBalancerTlsCertificate$renewalSummary' => 'An object containing information about the status of Lightsail\'s managed renewal for the certificate.
', ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$revocationReason' => 'The reason the certificate was revoked. Valid values are below.
', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$status' => 'The status of the SSL/TLS certificate. Valid values are below.
', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'base' => 'Provides a summary of SSL/TLS certificate metadata.
', 'refs' => [ 'LoadBalancerTlsCertificateSummaryList$member' => NULL, ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$tlsCertificateSummaries' => 'An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true
, the certificate is attached to the load balancer.
Describes a database log event.
', 'refs' => [ 'LogEventList$member' => NULL, ], ], 'LogEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseLogEventsResult$resourceLogEvents' => 'An object describing the result of your get relational database log events request.
', ], ], 'MetricDatapoint' => [ 'base' => 'Describes the metric data point.
', 'refs' => [ 'MetricDatapointList$member' => NULL, ], ], 'MetricDatapointList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataResult$metricData' => 'An array of key-value pairs containing information about the results of your get instance metric data request.
', 'GetLoadBalancerMetricDataResult$metricData' => 'An array of metric datapoint objects.
', 'GetRelationalDatabaseMetricDataResult$metricData' => 'An object describing the result of your get relational database metric data request.
', ], ], 'MetricPeriod' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$period' => 'The granularity, in seconds, of the returned data points.
', 'GetLoadBalancerMetricDataRequest$period' => 'The granularity, in seconds, of the returned data points.
', 'GetRelationalDatabaseMetricDataRequest$period' => 'The granularity, in seconds, of the returned data points.
', ], ], 'MetricStatistic' => [ 'base' => NULL, 'refs' => [ 'MetricStatisticList$member' => NULL, ], ], 'MetricStatisticList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$statistics' => 'The instance statistics.
', 'GetLoadBalancerMetricDataRequest$statistics' => 'An array of statistics that you want to request metrics for. Valid values are listed below.
SampleCount
- The count (number) of data points used for the statistical calculation.
Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.
Sum
- All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.
Minimum
- The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.
Maximum
- The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
The array of statistics for your metric data request.
', ], ], 'MetricUnit' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$unit' => 'The unit. The list of valid values is below.
', 'GetLoadBalancerMetricDataRequest$unit' => 'The unit for the time period request. Valid values are listed below.
', 'GetRelationalDatabaseMetricDataRequest$unit' => 'The unit for the metric data request.
', 'MetricDatapoint$unit' => 'The unit.
', ], ], 'MonthlyTransfer' => [ 'base' => 'Describes the monthly data transfer in and out of your virtual private server (or instance).
', 'refs' => [ 'InstanceNetworking$monthlyTransfer' => 'The amount of data in GB allocated for monthly data transfers.
', ], ], 'NetworkProtocol' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$protocol' => 'The protocol being used. Can be one of the following.
tcp
- Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.
all
- All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
udp
- With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
The protocol being used. Can be one of the following.
tcp
- Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.
all
- All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
udp
- With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
The protocol.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AttachDiskRequest$diskPath' => 'The disk path to expose to the instance (e.g., /dev/xvdf
).
The name of the Availability Zone. The format is us-east-2a
(case-sensitive).
The state of the Availability Zone.
', 'Blueprint$blueprintId' => 'The ID for the virtual private server image (e.g., app_wordpress_4_4
or app_lamp_7_0
).
The group name of the blueprint (e.g., amazon-linux
).
The bundle ID (e.g., micro_1_0
).
The Amazon Resource Name (ARN) of the CloudFormation stack record.
', 'CloudFormationStackRecordSourceInfo$name' => 'The name of the record.
', 'CloudFormationStackRecordSourceInfo$arn' => 'The Amazon Resource Name (ARN) of the export snapshot record.
', 'CreateDiskFromSnapshotRequest$availabilityZone' => 'The Availability Zone where you want to create the disk (e.g., us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
', 'CreateDiskRequest$availabilityZone' => 'The Availability Zone where you want to create the disk (e.g., us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
', 'CreateInstancesFromSnapshotRequest$bundleId' => 'The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0
).
The ID for a virtual private server image (e.g., app_wordpress_4_4
or app_lamp_7_0
). Use the get blueprints operation to return a list of available images (or blueprints).
The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0
).
The ID of the resource created at the destination.
', 'DestinationInfo$service' => 'The destination service of the record.
', 'Disk$arn' => 'The Amazon Resource Name (ARN) of the disk.
', 'DiskInfo$path' => 'The disk path.
', 'DiskMap$originalDiskPath' => 'The original disk path exposed to the instance (for example, /dev/sdh
).
The Amazon Resource Name (ARN) of the disk snapshot.
', 'DiskSnapshot$fromDiskArn' => 'The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.
', 'Domain$arn' => 'The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE
).
The ID of the domain recordset entry.
', 'ExportSnapshotRecord$arn' => 'The Amazon Resource Name (ARN) of the export snapshot record.
', 'ExportSnapshotRecordSourceInfo$name' => 'The name of the source instance or disk snapshot.
', 'ExportSnapshotRecordSourceInfo$arn' => 'The Amazon Resource Name (ARN) of the source instance or disk snapshot.
', 'ExportSnapshotRecordSourceInfo$fromResourceName' => 'The name of the snapshot\'s source instance or disk.
', 'ExportSnapshotRecordSourceInfo$fromResourceArn' => 'The Amazon Resource Name (ARN) of the snapshot\'s source instance or disk.
', 'GetOperationRequest$operationId' => 'A GUID used to identify the operation.
', 'Instance$arn' => 'The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE
).
The blueprint ID (e.g., os_amlinux_2016_03
).
The friendly name of the blueprint (e.g., Amazon Linux
).
The bundle for the instance (e.g., micro_1_0
).
The user name for connecting to the instance (e.g., ec2-user
).
The instance type (e.g., t2.micro
) to use for the new Amazon EC2 instance.
The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE
).
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE
).
The bundle ID from which the source instance was created (e.g., micro_1_0
).
The blueprint ID from which the source instance (e.g., os_debian_8_3
).
The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE
).
The Amazon Resource Name (ARN) of the load balancer.
', 'LoadBalancer$dnsName' => 'The DNS name of your Lightsail load balancer.
', 'LoadBalancer$healthCheckPath' => 'The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.
', 'LoadBalancerTlsCertificate$arn' => 'The Amazon Resource Name (ARN) of the SSL/TLS certificate.
', 'LoadBalancerTlsCertificate$issuer' => 'The issuer of the certificate.
', 'LoadBalancerTlsCertificate$keyAlgorithm' => 'The algorithm that was used to generate the key pair (the public and private key).
', 'LoadBalancerTlsCertificate$serial' => 'The serial number of the certificate.
', 'LoadBalancerTlsCertificate$signatureAlgorithm' => 'The algorithm that was used to sign the certificate.
', 'LoadBalancerTlsCertificate$subject' => 'The name of the entity that is associated with the public key contained in the certificate.
', 'LoadBalancerTlsCertificateDomainValidationRecord$name' => 'A fully qualified domain name in the certificate. For example, example.com
.
The type of validation record. For example, CNAME
for domain validation.
The value for that type.
', 'Operation$id' => 'The ID of the operation.
', 'PendingMaintenanceAction$action' => 'The type of pending database maintenance action.
', 'PendingMaintenanceAction$description' => 'Additional detail about the pending database maintenance action.
', 'RelationalDatabase$arn' => 'The Amazon Resource Name (ARN) of the database.
', 'RelationalDatabase$relationalDatabaseBlueprintId' => 'The blueprint ID for the database. A blueprint describes the major engine version of a database.
', 'RelationalDatabase$relationalDatabaseBundleId' => 'The bundle ID for the database. A bundle describes the performance specifications for your database.
', 'RelationalDatabase$state' => 'Describes the current state of the database.
', 'RelationalDatabase$engine' => 'The database software (for example, MySQL
).
The database engine version (for example, 5.7.23
).
The master user name of the database.
', 'RelationalDatabase$parameterApplyStatus' => 'The status of parameter updates for the database.
', 'RelationalDatabase$preferredBackupWindow' => 'The daily time range during which automated backups are created for the database (for example, 16:00-16:30
).
The weekly time range during which system maintenance can occur on the database.
In the format ddd:hh24:mi-ddd:hh24:mi
. For example, Tue:17:00-Tue:17:30
.
Specifies the DNS address of the database.
', 'RelationalDatabaseSnapshot$arn' => 'The Amazon Resource Name (ARN) of the database snapshot.
', 'RelationalDatabaseSnapshot$engine' => 'The software of the database snapshot (for example, MySQL
)
The database engine version for the database snapshot (for example, 5.7.23
).
The state of the database snapshot.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseName' => 'The name of the source database from which the database snapshot was created.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseArn' => 'The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
', 'StaticIp$arn' => 'The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE
).
Lightsail throws this exception when it cannot find a resource.
', 'refs' => [], ], 'OpenInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'OpenInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'Operation' => [ 'base' => 'Describes the API operation.
', 'refs' => [ 'CloseInstancePublicPortsResult$operation' => 'An array of key-value pairs that contains information about the operation.
', 'CreateDomainEntryResult$operation' => 'An array of key-value pairs containing information about the operation.
', 'CreateDomainResult$operation' => 'An array of key-value pairs containing information about the domain resource you created.
', 'CreateKeyPairResult$operation' => 'An array of key-value pairs containing information about the results of your create key pair request.
', 'DeleteDomainEntryResult$operation' => 'An array of key-value pairs containing information about the results of your delete domain entry request.
', 'DeleteDomainResult$operation' => 'An array of key-value pairs containing information about the results of your delete domain request.
', 'DeleteKeyPairResult$operation' => 'An array of key-value pairs containing information about the results of your delete key pair request.
', 'GetOperationResult$operation' => 'An array of key-value pairs containing information about the results of your get operation request.
', 'ImportKeyPairResult$operation' => 'An array of key-value pairs containing information about the request operation.
', 'OpenInstancePublicPortsResult$operation' => 'An array of key-value pairs containing information about the request operation.
', 'OperationList$member' => NULL, 'PeerVpcResult$operation' => 'An array of key-value pairs containing information about the request operation.
', 'PutInstancePublicPortsResult$operation' => 'Describes metadata about the operation you just executed.
', 'UnpeerVpcResult$operation' => 'An array of key-value pairs containing information about the request operation.
', ], ], 'OperationFailureException' => [ 'base' => 'Lightsail throws this exception when an operation fails to execute.
', 'refs' => [], ], 'OperationList' => [ 'base' => NULL, 'refs' => [ 'AllocateStaticIpResult$operations' => 'An array of key-value pairs containing information about the static IP address you allocated.
', 'AttachDiskResult$operations' => 'An object describing the API operations.
', 'AttachInstancesToLoadBalancerResult$operations' => 'An object representing the API operations.
', 'AttachLoadBalancerTlsCertificateResult$operations' => 'An object representing the API operations.
These SSL/TLS certificates are only usable by Lightsail load balancers. You can\'t get the certificate and use it for another purpose.
', 'AttachStaticIpResult$operations' => 'An array of key-value pairs containing information about your API operations.
', 'CopySnapshotResult$operations' => 'A list of objects describing the API operation.
', 'CreateCloudFormationStackResult$operations' => 'A list of objects describing the API operation.
', 'CreateDiskFromSnapshotResult$operations' => 'An object describing the API operations.
', 'CreateDiskResult$operations' => 'An object describing the API operations.
', 'CreateDiskSnapshotResult$operations' => 'An object describing the API operations.
', 'CreateInstanceSnapshotResult$operations' => 'An array of key-value pairs containing information about the results of your create instances snapshot request.
', 'CreateInstancesFromSnapshotResult$operations' => 'An array of key-value pairs containing information about the results of your create instances from snapshot request.
', 'CreateInstancesResult$operations' => 'An array of key-value pairs containing information about the results of your create instances request.
', 'CreateLoadBalancerResult$operations' => 'An object containing information about the API operations.
', 'CreateLoadBalancerTlsCertificateResult$operations' => 'An object containing information about the API operations.
', 'CreateRelationalDatabaseFromSnapshotResult$operations' => 'An object describing the result of your create relational database from snapshot request.
', 'CreateRelationalDatabaseResult$operations' => 'An object describing the result of your create relational database request.
', 'CreateRelationalDatabaseSnapshotResult$operations' => 'An object describing the result of your create relational database snapshot request.
', 'DeleteDiskResult$operations' => 'An object describing the API operations.
', 'DeleteDiskSnapshotResult$operations' => 'An object describing the API operations.
', 'DeleteInstanceResult$operations' => 'An array of key-value pairs containing information about the results of your delete instance request.
', 'DeleteInstanceSnapshotResult$operations' => 'An array of key-value pairs containing information about the results of your delete instance snapshot request.
', 'DeleteLoadBalancerResult$operations' => 'An object describing the API operations.
', 'DeleteLoadBalancerTlsCertificateResult$operations' => 'An object describing the API operations.
', 'DeleteRelationalDatabaseResult$operations' => 'An object describing the result of your delete relational database request.
', 'DeleteRelationalDatabaseSnapshotResult$operations' => 'An object describing the result of your delete relational database snapshot request.
', 'DetachDiskResult$operations' => 'An object describing the API operations.
', 'DetachInstancesFromLoadBalancerResult$operations' => 'An object describing the API operations.
', 'DetachStaticIpResult$operations' => 'An array of key-value pairs containing information about the results of your detach static IP request.
', 'ExportSnapshotResult$operations' => 'A list of objects describing the API operation.
', 'GetOperationsForResourceResult$operations' => 'An array of key-value pairs containing information about the results of your get operations for resource request.
', 'GetOperationsResult$operations' => 'An array of key-value pairs containing information about the results of your get operations request.
', 'RebootInstanceResult$operations' => 'An array of key-value pairs containing information about the request operations.
', 'RebootRelationalDatabaseResult$operations' => 'An object describing the result of your reboot relational database request.
', 'ReleaseStaticIpResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'StartInstanceResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'StartRelationalDatabaseResult$operations' => 'An object describing the result of your start relational database request.
', 'StopInstanceResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'StopRelationalDatabaseResult$operations' => 'An object describing the result of your stop relational database request.
', 'TagResourceResult$operations' => 'A list of objects describing the API operation.
', 'UntagResourceResult$operations' => 'A list of objects describing the API operation.
', 'UpdateDomainEntryResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'UpdateLoadBalancerAttributeResult$operations' => 'An object describing the API operations.
', 'UpdateRelationalDatabaseParametersResult$operations' => 'An object describing the result of your update relational database parameters request.
', 'UpdateRelationalDatabaseResult$operations' => 'An object describing the result of your update relational database request.
', ], ], 'OperationStatus' => [ 'base' => NULL, 'refs' => [ 'Operation$status' => 'The status of the operation.
', ], ], 'OperationType' => [ 'base' => NULL, 'refs' => [ 'Operation$operationType' => 'The type of operation.
', ], ], 'PasswordData' => [ 'base' => 'The password data for the Windows Server-based instance, including the ciphertext and the key pair name.
', 'refs' => [ 'InstanceAccessDetails$passwordData' => 'For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password
is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
Describes a pending database maintenance action.
', 'refs' => [ 'PendingMaintenanceActionList$member' => NULL, ], ], 'PendingMaintenanceActionList' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabase$pendingMaintenanceActions' => 'Describes the pending maintenance actions for the database.
', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'base' => 'Describes a pending database value modification.
', 'refs' => [ 'RelationalDatabase$pendingModifiedValues' => 'Describes pending database value modifications.
', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$instancePort' => 'The instance port where you\'re creating your load balancer.
', 'InstancePortInfo$fromPort' => 'The first port in the range.
', 'InstancePortInfo$toPort' => 'The last port in the range.
', 'InstancePortState$fromPort' => 'The first port in the range.
', 'InstancePortState$toPort' => 'The last port in the range.
', 'PortInfo$fromPort' => 'The first port in the range.
', 'PortInfo$toPort' => 'The last port in the range.
', 'PortList$member' => NULL, ], ], 'PortAccessType' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessType' => 'The type of access (Public
or Private
).
Describes information about the ports on your virtual private server (or instance).
', 'refs' => [ 'CloseInstancePublicPortsRequest$portInfo' => 'Information about the public port you are trying to close.
', 'OpenInstancePublicPortsRequest$portInfo' => 'An array of key-value pairs containing information about the port mappings.
', 'PortInfoList$member' => NULL, ], ], 'PortInfoList' => [ 'base' => NULL, 'refs' => [ 'PutInstancePublicPortsRequest$portInfos' => 'Specifies information about the public port(s).
', ], ], 'PortInfoSourceType' => [ 'base' => NULL, 'refs' => [ 'InstanceEntry$portInfoSource' => 'The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
DEFAULT — Use the default firewall settings from the image.
INSTANCE — Use the firewall settings from the source Lightsail instance.
NONE — Default to Amazon EC2.
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
', ], ], 'PortState' => [ 'base' => NULL, 'refs' => [ 'InstancePortState$state' => 'Specifies whether the instance port is open
or closed
.
The current state of the CloudFormation stack record.
', 'ExportSnapshotRecord$state' => 'The state of the export snapshot record.
', ], ], 'Region' => [ 'base' => 'Describes the AWS Region.
', 'refs' => [ 'RegionList$member' => NULL, ], ], 'RegionList' => [ 'base' => NULL, 'refs' => [ 'GetRegionsResult$regions' => 'An array of key-value pairs containing information about your get regions request.
', ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'CopySnapshotRequest$sourceRegion' => 'The AWS Region where the source snapshot is located.
', 'Region$name' => 'The region name (e.g., us-east-2
).
The AWS Region name.
', ], ], 'RelationalDatabase' => [ 'base' => 'Describes a database.
', 'refs' => [ 'GetRelationalDatabaseResult$relationalDatabase' => 'An object describing the specified database.
', 'RelationalDatabaseList$member' => NULL, ], ], 'RelationalDatabaseBlueprint' => [ 'base' => 'Describes a database image, or blueprint. A blueprint describes the major engine version of a database.
', 'refs' => [ 'RelationalDatabaseBlueprintList$member' => NULL, ], ], 'RelationalDatabaseBlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBlueprintsResult$blueprints' => 'An object describing the result of your get relational database blueprints request.
', ], ], 'RelationalDatabaseBundle' => [ 'base' => 'Describes a database bundle. A bundle describes the performance specifications of the database.
', 'refs' => [ 'RelationalDatabaseBundleList$member' => NULL, ], ], 'RelationalDatabaseBundleList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBundlesResult$bundles' => 'An object describing the result of your get relational database bundles request.
', ], ], 'RelationalDatabaseEndpoint' => [ 'base' => 'Describes an endpoint for a database.
', 'refs' => [ 'RelationalDatabase$masterEndpoint' => 'The master endpoint for the database.
', ], ], 'RelationalDatabaseEngine' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabaseBlueprint$engine' => 'The database software of the database blueprint (for example, MySQL
).
Describes an event for a database.
', 'refs' => [ 'RelationalDatabaseEventList$member' => NULL, ], ], 'RelationalDatabaseEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseEventsResult$relationalDatabaseEvents' => 'An object describing the result of your get relational database events request.
', ], ], 'RelationalDatabaseHardware' => [ 'base' => 'Describes the hardware of a database.
', 'refs' => [ 'RelationalDatabase$hardware' => 'Describes the hardware of the database.
', ], ], 'RelationalDatabaseList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabasesResult$relationalDatabases' => 'An object describing the result of your get relational databases request.
', ], ], 'RelationalDatabaseMetricName' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMetricDataRequest$metricName' => 'The name of the metric data to return.
', 'GetRelationalDatabaseMetricDataResult$metricName' => 'The name of the metric.
', ], ], 'RelationalDatabaseParameter' => [ 'base' => 'Describes the parameters of a database.
', 'refs' => [ 'RelationalDatabaseParameterList$member' => NULL, ], ], 'RelationalDatabaseParameterList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseParametersResult$parameters' => 'An object describing the result of your get relational database parameters request.
', 'UpdateRelationalDatabaseParametersRequest$parameters' => 'The database parameters to update.
', ], ], 'RelationalDatabasePasswordVersion' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMasterUserPasswordRequest$passwordVersion' => 'The password version to return.
Specifying CURRENT
or PREVIOUS
returns the current or previous passwords respectively. Specifying PENDING
returns the newest version of the password that will rotate to CURRENT
. After the PENDING
password rotates to CURRENT
, the PENDING
password is no longer available.
Default: CURRENT
Describes a database snapshot.
', 'refs' => [ 'GetRelationalDatabaseSnapshotResult$relationalDatabaseSnapshot' => 'An object describing the specified database snapshot.
', 'RelationalDatabaseSnapshotList$member' => NULL, ], ], 'RelationalDatabaseSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseSnapshotsResult$relationalDatabaseSnapshots' => 'An object describing the result of your get relational database snapshots request.
', ], ], 'ReleaseStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'ResourceLocation' => [ 'base' => 'Describes the resource location.
', 'refs' => [ 'CloudFormationStackRecord$location' => 'A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
', 'Disk$location' => 'The AWS Region and Availability Zone where the disk is located.
', 'DiskSnapshot$location' => 'The AWS Region and Availability Zone where the disk snapshot was created.
', 'Domain$location' => 'The AWS Region and Availability Zones where the domain recordset was created.
', 'ExportSnapshotRecord$location' => 'The AWS Region and Availability Zone where the export snapshot record is located.
', 'Instance$location' => 'The region name and Availability Zone where the instance is located.
', 'InstanceSnapshot$location' => 'The region name and Availability Zone where you created the snapshot.
', 'KeyPair$location' => 'The region name and Availability Zone where the key pair was created.
', 'LoadBalancer$location' => 'The AWS Region where your load balancer was created (e.g., us-east-2a
). Lightsail automatically creates your load balancer across Availability Zones.
The AWS Region and Availability Zone where you created your certificate.
', 'Operation$location' => 'The region and Availability Zone.
', 'RelationalDatabase$location' => 'The Region name and Availability Zone where the database is located.
', 'RelationalDatabaseSnapshot$location' => 'The Region name and Availability Zone where the database snapshot is located.
', 'StaticIp$location' => 'The region and Availability Zone where the static IP was created.
', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'AllocateStaticIpRequest$staticIpName' => 'The name of the static IP address.
', 'AttachDiskRequest$diskName' => 'The unique Lightsail disk name (e.g., my-disk
).
The name of the Lightsail instance where you want to utilize the storage disk.
', 'AttachInstancesToLoadBalancerRequest$loadBalancerName' => 'The name of the load balancer.
', 'AttachLoadBalancerTlsCertificateRequest$loadBalancerName' => 'The name of the load balancer to which you want to associate the SSL/TLS certificate.
', 'AttachLoadBalancerTlsCertificateRequest$certificateName' => 'The name of your SSL/TLS certificate.
', 'AttachStaticIpRequest$staticIpName' => 'The name of the static IP.
', 'AttachStaticIpRequest$instanceName' => 'The instance name to which you want to attach the static IP address.
', 'AttachedDiskMap$key' => NULL, 'Blueprint$name' => 'The friendly name of the blueprint (e.g., Amazon Linux
).
The name of the instance on which you\'re attempting to close the public ports.
', 'CloudFormationStackRecord$name' => 'The name of the CloudFormation stack record. It starts with CloudFormationStackRecord
followed by a GUID.
The name of the source instance or disk snapshot to be copied.
', 'CopySnapshotRequest$targetSnapshotName' => 'The name of the new instance or disk snapshot to be created as a copy.
', 'CreateDiskFromSnapshotRequest$diskName' => 'The unique Lightsail disk name (e.g., my-disk
).
The name of the disk snapshot (e.g., my-snapshot
) from which to create the new storage disk.
The unique Lightsail disk name (e.g., my-disk
).
The unique name of the source disk (e.g., my-source-disk
).
The name of the destination disk snapshot (e.g., my-disk-snapshot
) based on the source disk.
The name for your new snapshot.
', 'CreateInstanceSnapshotRequest$instanceName' => 'The Lightsail instance on which to base your snapshot.
', 'CreateInstancesFromSnapshotRequest$instanceSnapshotName' => 'The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
', 'CreateInstancesFromSnapshotRequest$keyPairName' => 'The name for your key pair.
', 'CreateInstancesRequest$customImageName' => '(Deprecated) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
The name of your key pair.
', 'CreateKeyPairRequest$keyPairName' => 'The name for your new key pair.
', 'CreateLoadBalancerRequest$loadBalancerName' => 'The name of your load balancer.
', 'CreateLoadBalancerRequest$certificateName' => 'The name of the SSL/TLS certificate.
If you specify certificateName
, then certificateDomainName
is required (and vice-versa).
The load balancer name where you want to create the SSL/TLS certificate.
', 'CreateLoadBalancerTlsCertificateRequest$certificateName' => 'The SSL/TLS certificate name.
You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.
', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseName' => 'The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database snapshot from which to create your new database.
', 'CreateRelationalDatabaseFromSnapshotRequest$sourceRelationalDatabaseName' => 'The name of the source database.
', 'CreateRelationalDatabaseRequest$relationalDatabaseName' => 'The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database on which to base your new snapshot.
', 'CreateRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => 'The name for your new database snapshot.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The unique name of the disk you want to delete (e.g., my-disk
).
The name of the disk snapshot you want to delete (e.g., my-disk-snapshot
).
The name of the instance to delete.
', 'DeleteInstanceSnapshotRequest$instanceSnapshotName' => 'The name of the snapshot to delete.
', 'DeleteKeyPairRequest$keyPairName' => 'The name of the key pair to delete.
', 'DeleteLoadBalancerRequest$loadBalancerName' => 'The name of the load balancer you want to delete.
', 'DeleteLoadBalancerTlsCertificateRequest$loadBalancerName' => 'The load balancer name.
', 'DeleteLoadBalancerTlsCertificateRequest$certificateName' => 'The SSL/TLS certificate name.
', 'DeleteRelationalDatabaseRequest$relationalDatabaseName' => 'The name of the database that you are deleting.
', 'DeleteRelationalDatabaseRequest$finalRelationalDatabaseSnapshotName' => 'The name of the database snapshot created if skip final snapshot
is false
, which is the default value for that parameter.
Specifying this parameter and also specifying the skip final snapshot
parameter to true
results in an error.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database snapshot that you are deleting.
', 'DetachDiskRequest$diskName' => 'The unique name of the disk you want to detach from your instance (e.g., my-disk
).
The name of the Lightsail load balancer.
', 'DetachStaticIpRequest$staticIpName' => 'The name of the static IP to detach from the instance.
', 'Disk$name' => 'The unique name of the disk.
', 'Disk$attachedTo' => 'The resources to which the disk is attached.
', 'DiskMap$newDiskName' => 'The new disk name (e.g., my-new-disk
).
The name of the disk snapshot (e.g., my-disk-snapshot
).
The unique name of the source disk from which you are creating the disk snapshot.
', 'Domain$name' => 'The name of the domain.
', 'ExportSnapshotRecord$name' => 'The export snapshot record name.
', 'ExportSnapshotRequest$sourceSnapshotName' => 'The name of the instance or disk snapshot to be exported to Amazon EC2.
', 'GetDiskRequest$diskName' => 'The name of the disk (e.g., my-disk
).
The name of the disk snapshot (e.g., my-disk-snapshot
).
The name of the instance to access.
', 'GetInstanceMetricDataRequest$instanceName' => 'The name of the instance for which you want to get metrics data.
', 'GetInstancePortStatesRequest$instanceName' => 'The name of the instance.
', 'GetInstanceRequest$instanceName' => 'The name of the instance.
', 'GetInstanceSnapshotRequest$instanceSnapshotName' => 'The name of the snapshot for which you are requesting information.
', 'GetInstanceStateRequest$instanceName' => 'The name of the instance to get state information about.
', 'GetKeyPairRequest$keyPairName' => 'The name of the key pair for which you are requesting information.
', 'GetLoadBalancerMetricDataRequest$loadBalancerName' => 'The name of the load balancer.
', 'GetLoadBalancerRequest$loadBalancerName' => 'The name of the load balancer.
', 'GetLoadBalancerTlsCertificatesRequest$loadBalancerName' => 'The name of the load balancer you associated with your SSL/TLS certificate.
', 'GetOperationsForResourceRequest$resourceName' => 'The name of the resource for which you are requesting information.
', 'GetRelationalDatabaseEventsRequest$relationalDatabaseName' => 'The name of the database from which to get events.
', 'GetRelationalDatabaseLogEventsRequest$relationalDatabaseName' => 'The name of your database for which to get log events.
', 'GetRelationalDatabaseLogStreamsRequest$relationalDatabaseName' => 'The name of your database for which to get log streams.
', 'GetRelationalDatabaseMasterUserPasswordRequest$relationalDatabaseName' => 'The name of your database for which to get the master user password.
', 'GetRelationalDatabaseMetricDataRequest$relationalDatabaseName' => 'The name of your database from which to get metric data.
', 'GetRelationalDatabaseParametersRequest$relationalDatabaseName' => 'The name of your database for which to get parameters.
', 'GetRelationalDatabaseRequest$relationalDatabaseName' => 'The name of the database that you are looking up.
', 'GetRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => 'The name of the database snapshot for which to get information.
', 'GetStaticIpRequest$staticIpName' => 'The name of the static IP in Lightsail.
', 'ImportKeyPairRequest$keyPairName' => 'The name of the key pair for which you want to import the public key.
', 'Instance$name' => 'The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1
).
The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair
).
The name of this Amazon Lightsail instance.
', 'InstanceEntry$sourceName' => 'The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.
Use the get export snapshot records
operation to get a list of export snapshot records that you can use to create a CloudFormation stack.
The name of the Lightsail instance for which you are requesting health check data.
', 'InstanceSnapshot$name' => 'The name of the snapshot.
', 'InstanceSnapshot$fromInstanceName' => 'The instance from which the snapshot was created.
', 'KeyPair$name' => 'The friendly name of the SSH key pair.
', 'LoadBalancer$name' => 'The name of the load balancer (e.g., my-load-balancer
).
The name of the SSL/TLS certificate (e.g., my-certificate
).
The load balancer name where your SSL/TLS certificate is attached.
', 'LoadBalancerTlsCertificateSummary$name' => 'The name of the SSL/TLS certificate.
', 'OpenInstancePublicPortsRequest$instanceName' => 'The name of the instance for which you want to open the public ports.
', 'Operation$resourceName' => 'The resource name.
', 'PasswordData$keyPairName' => 'The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair
).
If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext
. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.
The Lightsail instance name of the public port(s) you are setting.
', 'RebootInstanceRequest$instanceName' => 'The name of the instance to reboot.
', 'RebootRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to reboot.
', 'RelationalDatabase$name' => 'The unique name of the database resource in Lightsail.
', 'RelationalDatabaseEvent$resource' => 'The database that the database event relates to.
', 'RelationalDatabaseSnapshot$name' => 'The name of the database snapshot.
', 'ReleaseStaticIpRequest$staticIpName' => 'The name of the static IP to delete.
', 'ResourceNameList$member' => NULL, 'StartInstanceRequest$instanceName' => 'The name of the instance (a virtual private server) to start.
', 'StartRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to start.
', 'StaticIp$name' => 'The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE
).
The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1
).
The name of the instance (a virtual private server) to stop.
', 'StopRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to stop.
', 'StopRelationalDatabaseRequest$relationalDatabaseSnapshotName' => 'The name of your new database snapshot to be created before stopping your database.
', 'TagResourceRequest$resourceName' => 'The name of the resource to which you are adding tags.
', 'UntagResourceRequest$resourceName' => 'The name of the resource from which you are removing a tag.
', 'UpdateLoadBalancerAttributeRequest$loadBalancerName' => 'The name of the load balancer that you want to modify (e.g., my-load-balancer
.
The name of your database for which to update parameters.
', 'UpdateRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to update.
', ], ], 'ResourceNameList' => [ 'base' => NULL, 'refs' => [ 'AttachInstancesToLoadBalancerRequest$instanceNames' => 'An array of strings representing the instance name(s) you want to attach to your load balancer.
An instance must be running
before you can attach it to your load balancer.
There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).
', 'DetachInstancesFromLoadBalancerRequest$instanceNames' => 'An array of strings containing the names of the instances you want to detach from the load balancer.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$resourceType' => 'The Lightsail resource type (e.g., CloudFormationStackRecord
).
The Lightsail resource type (e.g., Disk
).
The Lightsail resource type (e.g., DiskSnapshot
).
The resource type.
', 'ExportSnapshotRecord$resourceType' => 'The Lightsail resource type (e.g., ExportSnapshotRecord
).
The type of resource (usually Instance
).
The type of resource (usually InstanceSnapshot
).
The resource type (usually KeyPair
).
The resource type (e.g., LoadBalancer
.
The resource type (e.g., LoadBalancerTlsCertificate
).
Instance
- A Lightsail instance (a virtual private server)
StaticIp
- A static IP address
KeyPair
- The key pair used to connect to a Lightsail instance
InstanceSnapshot
- A Lightsail instance snapshot
Domain
- A DNS zone
PeeredVpc
- A peered VPC
LoadBalancer
- A Lightsail load balancer
LoadBalancerTlsCertificate
- An SSL/TLS certificate associated with a Lightsail load balancer
Disk
- A Lightsail block storage disk
DiskSnapshot
- A block storage disk snapshot
The resource type.
', 'RelationalDatabase$resourceType' => 'The Lightsail resource type for the database (for example, RelationalDatabase
).
The Lightsail resource type.
', 'StaticIp$resourceType' => 'The resource type (usually StaticIp
).
The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain 8 to 41 characters.
', 'GetRelationalDatabaseMasterUserPasswordResult$masterUserPassword' => 'The master user password for the password version
specified.
The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain 8 to 41 characters.
', ], ], 'ServiceException' => [ 'base' => 'A general service exception.
', 'refs' => [], ], 'StartInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StaticIp' => [ 'base' => 'Describes the static IP.
', 'refs' => [ 'GetStaticIpResult$staticIp' => 'An array of key-value pairs containing information about the requested static IP.
', 'StaticIpList$member' => NULL, ], ], 'StaticIpList' => [ 'base' => NULL, 'refs' => [ 'GetStaticIpsResult$staticIps' => 'An array of key-value pairs containing information about your get static IPs request.
', ], ], 'StopInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateInstancesFromSnapshotRequest$instanceNames' => 'The names for your new instances.
', 'CreateInstancesRequest$instanceNames' => 'The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
The list of active names returned by the get active names request.
', 'GetRelationalDatabaseLogStreamsResult$logStreams' => 'An object describing the result of your get relational database log streams request.
', 'LoadBalancerTlsCertificate$subjectAlternativeNames' => 'One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com
, www.example.com
, or m.example.com
.
The category that the database event belongs to.
', ], ], 'StringMax256' => [ 'base' => NULL, 'refs' => [ 'UpdateLoadBalancerAttributeRequest$attributeValue' => 'The value that you want to specify for the attribute name.
', ], ], 'Tag' => [ 'base' => 'Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag keys to delete from the specified resource.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateDiskFromSnapshotRequest$tags' => 'The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'DiskSnapshot$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'Domain$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'Instance$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'InstanceSnapshot$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'KeyPair$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'LoadBalancer$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'LoadBalancerTlsCertificate$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'RelationalDatabase$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'RelationalDatabaseSnapshot$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'TagResourceRequest$tags' => 'The tag key and optional value.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
', ], ], 'UnauthenticatedException' => [ 'base' => 'Lightsail throws this exception when the user has not been authenticated.
', 'refs' => [], ], 'UnpeerVpcRequest' => [ 'base' => NULL, 'refs' => [], ], 'UnpeerVpcResult' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'Blueprint$isActive' => 'A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
', 'Bundle$isActive' => 'A Boolean value indicating whether the bundle is active.
', 'CreateRelationalDatabaseFromSnapshotRequest$publiclyAccessible' => 'Specifies the accessibility options for your new database. A value of true
specifies a database that is available to resources outside of your Lightsail account. A value of false
specifies a database that is available only to your Lightsail resources in the same region as your database.
Specifies whether your database is restored from the latest backup time. A value of true
restores from the latest backup time.
Default: false
Constraints: Cannot be specified if the restore time
parameter is provided.
Specifies the accessibility options for your new database. A value of true
specifies a database that is available to resources outside of your Lightsail account. A value of false
specifies a database that is available only to your Lightsail resources in the same region as your database.
When true
, forces the deletion of an SSL/TLS certificate.
There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force
parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.
Determines whether a final database snapshot is created before your database is deleted. If true
is specified, no database snapshot is created. If false
is specified, a database snapshot is created before your database is deleted.
You must specify the final relational database snapshot name
parameter if the skip final snapshot
parameter is false
.
Default: false
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
', 'Disk$isAttached' => 'A Boolean value indicating whether the disk is attached.
', 'DiskInfo$isSystemDisk' => 'A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
', 'DomainEntry$isAlias' => 'When true
, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
A Boolean value indicating whether to include inactive results in your request.
', 'GetBundlesRequest$includeInactive' => 'A Boolean value that indicates whether to include inactive bundle results in your request.
', 'GetRegionsRequest$includeAvailabilityZones' => 'A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a
.
>A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a
).
Parameter to specify if the log should start from head or tail. If true
is specified, the log event starts from the head of the log. If false
is specified, the log event starts from the tail of the log.
Default: false
A Boolean value indicating whether this instance has a static IP assigned to it.
', 'IsVpcPeeredResult$isPeered' => 'Returns true
if the Lightsail VPC is peered; otherwise, false
.
When true
, the SSL/TLS certificate is attached to the Lightsail load balancer.
When true
, the SSL/TLS certificate is attached to the Lightsail load balancer.
A Boolean value indicating whether the operation is terminal.
', 'PendingModifiedRelationalDatabaseValues$backupRetentionEnabled' => 'A Boolean value indicating whether automated backup retention is enabled.
', 'RelationalDatabase$backupRetentionEnabled' => 'A Boolean value indicating whether automated backup retention is enabled for the database.
', 'RelationalDatabase$publiclyAccessible' => 'A Boolean value indicating whether the database is publicly accessible.
', 'RelationalDatabaseBlueprint$isEngineDefault' => 'A Boolean value indicating whether the engine version is the default for the database blueprint.
', 'RelationalDatabaseBundle$isEncrypted' => 'A Boolean value indicating whether the database bundle is encrypted.
', 'RelationalDatabaseBundle$isActive' => 'A Boolean value indicating whether the database bundle is active.
', 'RelationalDatabaseParameter$isModifiable' => 'A Boolean value indicating whether the parameter can be modified.
', 'StaticIp$isAttached' => 'A Boolean value indicating whether the static IP is attached.
', 'StopInstanceRequest$force' => 'When set to True
, forces a Lightsail instance that is stuck in a stopping
state to stop.
Only use the force
parameter if your instance is stuck in the stopping
state. In any other state, your instance should stop normally without adding this parameter to your API request.
When true
, the master user password is changed to a new strong password generated by Lightsail.
Use the get relational database master user password
operation to get the new password.
When true
, enables automated backup retention for your database.
Updates are applied during the next maintenance window because this can result in an outage.
', 'UpdateRelationalDatabaseRequest$disableBackupRetention' => 'When true
, disables automated backup retention for your database.
Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot
operation.
Updates are applied during the next maintenance window because this can result in an outage.
', 'UpdateRelationalDatabaseRequest$publiclyAccessible' => 'Specifies the accessibility options for your database. A value of true
specifies a database that is available to resources outside of your Lightsail account. A value of false
specifies a database that is available only to your Lightsail resources in the same region as your database.
When true
, applies changes immediately. When false
, applies changes during the preferred maintenance window. Some changes may cause an outage.
Default: false
The average.
', 'MetricDatapoint$maximum' => 'The maximum.
', 'MetricDatapoint$minimum' => 'The minimum.
', 'MetricDatapoint$sampleCount' => 'The sample count.
', 'MetricDatapoint$sum' => 'The sum.
', ], ], 'float' => [ 'base' => NULL, 'refs' => [ 'Bundle$price' => 'The price in US dollars (e.g., 5.0
).
The amount of RAM in GB (e.g., 2.0
).
The amount of RAM in GB on the instance (e.g., 1.0
).
The cost of the database bundle in US currency.
', 'RelationalDatabaseBundle$ramSizeInGb' => 'The amount of RAM in GB (for example, 2.0
) for the database bundle.
The amount of RAM in GB for the database.
', ], ], 'integer' => [ 'base' => NULL, 'refs' => [ 'Blueprint$minPower' => 'The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0
indicates that the blueprint runs on all instance sizes.
The number of vCPUs included in the bundle (e.g., 2
).
The size of the SSD (e.g., 30
).
A numeric value that represents the power of the bundle (e.g., 500
). You can use the bundle\'s power value in conjunction with a blueprint\'s minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.
The data transfer rate per month in GB (e.g., 2000
).
The size of the disk in GB (e.g., 32
).
The size of the disk in GB (e.g., 32
).
The size of the disk in GB.
', 'Disk$iops' => 'The input/output operations per second (IOPS) of the disk.
', 'Disk$gbInUse' => '(Deprecated) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
The size of the disk in GB (e.g., 32
).
The size of the disk in GB.
', 'DiskSnapshotInfo$sizeInGb' => 'The size of the disk in GB (e.g., 32
).
The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.
Default: 60
The minimum is 1 and the maximum is 14 days (20160 minutes).
', 'InstanceHardware$cpuCount' => 'The number of vCPUs the instance has.
', 'InstanceSnapshot$sizeInGb' => 'The size in GB of the SSD.
', 'InstanceState$code' => 'The status code for the instance.
', 'LoadBalancer$instancePort' => 'The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it\'s port 80. For HTTPS traffic, it\'s port 443.
', 'MonthlyTransfer$gbPerMonthAllocated' => 'The amount allocated per month (in GB).
', 'RelationalDatabaseBundle$diskSizeInGb' => 'The size of the disk for the database bundle.
', 'RelationalDatabaseBundle$transferPerMonthInGb' => 'The data transfer rate per month in GB for the database bundle.
', 'RelationalDatabaseBundle$cpuCount' => 'The number of virtual CPUs (vCPUs) for the database bundle.
', 'RelationalDatabaseEndpoint$port' => 'Specifies the port that the database is listening on.
', 'RelationalDatabaseHardware$cpuCount' => 'The number of vCPUs for the database.
', 'RelationalDatabaseHardware$diskSizeInGb' => 'The size of the disk for the database.
', 'RelationalDatabaseSnapshot$sizeInGb' => 'The size of the disk in GB (for example, 32
) for the database snapshot.
The description of the blueprint.
', 'Blueprint$version' => 'The version number of the operating system, application, or stack (e.g., 2016.03.0
).
The version code.
', 'Blueprint$productUrl' => 'The product URL to learn more about the image or blueprint.
', 'Blueprint$licenseUrl' => 'The end-user license agreement URL for the image or blueprint.
', 'Bundle$instanceType' => 'The Amazon EC2 instance type (e.g., t2.micro
).
A friendly name for the bundle (e.g., Micro
).
The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones
parameter to your request.
You can create a launch script that configures a server with additional user data. For example, apt-get -y update
.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum
, Debian and Ubuntu use apt-get
, and FreeBSD uses pkg
. For a complete list, see the Dev Guide.
The Availability Zone in which to create your instance. Use the following format: us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones
parameter to your request.
A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update
.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum
, Debian and Ubuntu use apt-get
, and FreeBSD uses pkg
. For a complete list, see the Dev Guide.
The path you provided to perform the load balancer health check. If you didn\'t specify a health check path, Lightsail uses the root path of your website (e.g., "/"
).
You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
', 'CreateRelationalDatabaseFromSnapshotRequest$availabilityZone' => 'The Availability Zone in which to create your new database. Use the us-east-2a
case-sensitive format.
You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include relational database Availability Zones
parameter to your request.
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the get relational database bundles
operation.
When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.
', 'CreateRelationalDatabaseRequest$availabilityZone' => 'The Availability Zone in which to create your new database. Use the us-east-2a
case-sensitive format.
You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include relational database Availability Zones
parameter to your request.
The blueprint ID for your new database. A blueprint describes the major engine version of a database.
You can get a list of database blueprints IDs by using the get relational database blueprints
operation.
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the get relational database bundles
operation.
The name of the master database created when the Lightsail database resource is created.
Constraints:
Must contain from 1 to 64 alphanumeric characters.
Cannot be a word reserved by the specified database engine
The master user name for your new database.
Constraints:
Master user name is required.
Must contain from 1 to 16 alphanumeric characters.
The first character must be a letter.
Cannot be a reserved word for the database engine you choose.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.
The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.
Constraints:
Must be in the hh24:mi-hh24:mi
format.
Example: 16:00-16:30
Specified in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur on your new database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi
format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Universal Coordinated Time (UTC).
Example: Tue:17:00-Tue:17:30
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'Disk$path' => 'The disk path.
', 'Disk$attachmentState' => '(Deprecated) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached
instead.
The disk name.
', 'DiskSnapshot$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'DiskSnapshot$progress' => 'The progress of the disk snapshot operation.
', 'Domain$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'DomainEntry$target' => 'The target AWS name server (e.g., ns-111.awsdns-22.com.
).
For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com
. Be sure to also set isAlias
to true
when setting up an A record for a load balancer.
A token used for paginating results from your get active names request.
', 'GetActiveNamesResult$nextPageToken' => 'A token used for advancing to the next page of results from your get active names request.
', 'GetBlueprintsRequest$pageToken' => 'A token used for advancing to the next page of results from your get blueprints request.
', 'GetBlueprintsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get blueprints request.
', 'GetBundlesRequest$pageToken' => 'A token used for advancing to the next page of results from your get bundles request.
', 'GetBundlesResult$nextPageToken' => 'A token used for advancing to the next page of results from your get active names request.
', 'GetCloudFormationStackRecordsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get cloud formation stack records
request.
A token used for advancing to the next page of results of your get relational database bundles request.
', 'GetDiskSnapshotsRequest$pageToken' => 'A token used for advancing to the next page of results from your GetDiskSnapshots request.
', 'GetDiskSnapshotsResult$nextPageToken' => 'A token used for advancing to the next page of results from your GetDiskSnapshots request.
', 'GetDisksRequest$pageToken' => 'A token used for advancing to the next page of results from your GetDisks request.
', 'GetDisksResult$nextPageToken' => 'A token used for advancing to the next page of results from your GetDisks request.
', 'GetDomainsRequest$pageToken' => 'A token used for advancing to the next page of results from your get domains request.
', 'GetDomainsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get active names request.
', 'GetExportSnapshotRecordsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get export snapshot records
request.
A token used for advancing to the next page of results of your get relational database bundles request.
', 'GetInstanceSnapshotsRequest$pageToken' => 'A token used for advancing to the next page of results from your get instance snapshots request.
', 'GetInstanceSnapshotsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get instance snapshots request.
', 'GetInstancesRequest$pageToken' => 'A token used for advancing to the next page of results from your get instances request.
', 'GetInstancesResult$nextPageToken' => 'A token used for advancing to the next page of results from your get instances request.
', 'GetKeyPairsRequest$pageToken' => 'A token used for advancing to the next page of results from your get key pairs request.
', 'GetKeyPairsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get key pairs request.
', 'GetLoadBalancersRequest$pageToken' => 'A token used for paginating the results from your GetLoadBalancers request.
', 'GetLoadBalancersResult$nextPageToken' => 'A token used for advancing to the next page of results from your GetLoadBalancers request.
', 'GetOperationsForResourceRequest$pageToken' => 'A token used for advancing to the next page of results from your get operations for resource request.
', 'GetOperationsForResourceResult$nextPageCount' => '(Deprecated) Returns the number of pages of results that remain.
In releases prior to June 12, 2017, this parameter returned null
by the API. It is now deprecated, and the API returns the next page token
parameter instead.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'GetOperationsRequest$pageToken' => 'A token used for advancing to the next page of results from your get operations request.
', 'GetOperationsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get operations request.
', 'GetRelationalDatabaseBlueprintsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database blueprints
request.
A token used for advancing to the next page of results of your get relational database blueprints request.
', 'GetRelationalDatabaseBundlesRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database bundles
request.
A token used for advancing to the next page of results of your get relational database bundles request.
', 'GetRelationalDatabaseEventsRequest$pageToken' => 'A token used for advancing to a specific page of results from for get relational database events request.
', 'GetRelationalDatabaseEventsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get relational database events request.
', 'GetRelationalDatabaseLogEventsRequest$logStreamName' => 'The name of the log stream.
Use the get relational database log streams
operation to get a list of available log streams.
A token used for advancing to a specific page of results for your get relational database log events
request.
A token used for advancing to the previous page of results from your get relational database log events request.
', 'GetRelationalDatabaseLogEventsResult$nextForwardToken' => 'A token used for advancing to the next page of results from your get relational database log events request.
', 'GetRelationalDatabaseParametersRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database parameters
request.
A token used for advancing to the next page of results from your get static IPs request.
', 'GetRelationalDatabaseSnapshotsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database snapshots
request.
A token used for advancing to the next page of results from your get relational database snapshots request.
', 'GetRelationalDatabasesRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database
request.
A token used for advancing to the next page of results from your get relational databases request.
', 'GetStaticIpsRequest$pageToken' => 'A token used for advancing to the next page of results from your get static IPs request.
', 'GetStaticIpsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get static IPs request.
', 'Instance$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'InstanceAccessDetails$certKey' => 'For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub
.
For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you create an instance using any key pair other than the default (LightsailDefaultKeyPair
), password
will always be an empty string.
If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey
).
The user name to use when logging in to the Amazon Lightsail instance.
', 'InstanceEntry$userData' => 'A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update
.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum
, Debian and Ubuntu use apt-get
, and FreeBSD uses pkg
.
The Availability Zone for the new Amazon EC2 instance.
', 'InstancePortInfo$accessFrom' => 'The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)
).
The common name.
', 'InstanceSnapshot$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'InstanceSnapshot$progress' => 'The progress of the snapshot.
', 'InstanceSnapshot$fromBlueprintId' => 'The blueprint ID from which you created the snapshot (e.g., os_debian_8_3
). A blueprint is a virtual private server (or instance) image used to create instances quickly.
The bundle ID from which you created the snapshot (e.g., micro_1_0
).
The state of the instance (e.g., running
or pending
).
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'LoadBalancer$supportCode' => 'The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.
', 'LoadBalancerConfigurationOptions$value' => NULL, 'LoadBalancerTlsCertificate$supportCode' => 'The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.
', 'LogEvent$message' => 'The message of the database log event.
', 'NotFoundException$code' => NULL, 'NotFoundException$docs' => NULL, 'NotFoundException$message' => NULL, 'NotFoundException$tip' => NULL, 'Operation$operationDetails' => 'Details about the operation (e.g., Debian-1GB-Ohio-1
).
The error code.
', 'Operation$errorDetails' => 'The error details.
', 'OperationFailureException$code' => NULL, 'OperationFailureException$docs' => NULL, 'OperationFailureException$message' => NULL, 'OperationFailureException$tip' => NULL, 'PasswordData$ciphertext' => 'The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you use the default key pair (LightsailDefaultKeyPair
), the decrypted password will be available in the password field.
If you are using a custom key pair, you need to use your own means of decryption.
If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
The password for the master user of the database.
', 'PendingModifiedRelationalDatabaseValues$engineVersion' => 'The database engine version.
', 'Region$continentCode' => 'The continent code (e.g., NA
, meaning North America).
The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada
).
The display name (e.g., Ohio
).
The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'RelationalDatabase$masterDatabaseName' => 'The name of the master database created when the Lightsail database resource is created.
', 'RelationalDatabase$secondaryAvailabilityZone' => 'Describes the secondary Availability Zone of a high availability database.
The secondary database is used for failover support of a high availability database.
', 'RelationalDatabaseBlueprint$blueprintId' => 'The ID for the database blueprint.
', 'RelationalDatabaseBlueprint$engineVersion' => 'The database engine version for the database blueprint (for example, 5.7.23
).
The description of the database engine for the database blueprint.
', 'RelationalDatabaseBlueprint$engineVersionDescription' => 'The description of the database engine version for the database blueprint.
', 'RelationalDatabaseBundle$bundleId' => 'The ID for the database bundle.
', 'RelationalDatabaseBundle$name' => 'The name for the database bundle.
', 'RelationalDatabaseEvent$message' => 'The message of the database event.
', 'RelationalDatabaseParameter$allowedValues' => 'Specifies the valid range of values for the parameter.
', 'RelationalDatabaseParameter$applyMethod' => 'Indicates when parameter updates are applied.
Can be immediate
or pending-reboot
.
Specifies the engine-specific parameter type.
', 'RelationalDatabaseParameter$dataType' => 'Specifies the valid data type for the parameter.
', 'RelationalDatabaseParameter$description' => 'Provides a description of the parameter.
', 'RelationalDatabaseParameter$parameterName' => 'Specifies the name of the parameter.
', 'RelationalDatabaseParameter$parameterValue' => 'Specifies the value of the parameter.
', 'RelationalDatabaseSnapshot$supportCode' => 'The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBundleId' => 'The bundle ID of the database from which the database snapshot was created.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBlueprintId' => 'The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
', 'ResourceLocation$availabilityZone' => 'The Availability Zone. Follows the format us-east-2a
(case-sensitive).
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'StringList$member' => NULL, 'UnauthenticatedException$code' => NULL, 'UnauthenticatedException$docs' => NULL, 'UnauthenticatedException$message' => NULL, 'UnauthenticatedException$tip' => NULL, 'UpdateRelationalDatabaseRequest$preferredBackupWindow' => 'The daily time range during which automated backups are created for your database if automated backups are enabled.
Constraints:
Must be in the hh24:mi-hh24:mi
format.
Example: 16:00-16:30
Specified in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur on your database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi
format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Universal Coordinated Time (UTC).
Example: Tue:17:00-Tue:17:30
The start time of the time period.
', 'GetInstanceMetricDataRequest$endTime' => 'The end time of the time period.
', 'GetLoadBalancerMetricDataRequest$startTime' => 'The start time of the period.
', 'GetLoadBalancerMetricDataRequest$endTime' => 'The end time of the period.
', 'MetricDatapoint$timestamp' => 'The timestamp (e.g., 1479816991.349
).
Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
', 'operations' => [ 'AllocateStaticIp' => 'Allocates a static IP address.
', 'AttachDisk' => 'Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk
operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide.
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate
operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The attach load balancer tls certificate
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Attaches a static IP address to a specific Amazon Lightsail instance.
', 'CloseInstancePublicPorts' => 'Closes the public ports on a specific Amazon Lightsail instance.
The close instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.
', 'CreateCloudFormationStack' => 'Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records
operation to get a list of the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack
operation again with the same export snapshot record.
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance\'s system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name
parameter when issuing the snapshot command, and a snapshot of the defined instance\'s system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a domain resource for the specified domain (e.g., example.com).
The create domain
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
The create domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.
The create instances
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
The create instances from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide.
Creates an SSH key pair.
The create key pair
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute
operation.
The create load balancer
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The create load balancer tls certificate
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Creates a new database in Amazon Lightsail.
The create relational database
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot
operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Deletes the specified block storage disk. The disk must be in the available
state (not attached to a Lightsail instance).
The disk may remain in the deleting
state for several minutes.
The delete disk
operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide.
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot
operation supports tag-based access control via resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide.
Deletes the specified domain recordset and all of its domain records.
The delete domain
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Deletes a specific domain entry.
The delete domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Deletes a specific Amazon Lightsail virtual private server, or instance.
The delete instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Deletes a specific snapshot of a virtual private server (or instance).
The delete instance snapshot
operation supports tag-based access control via resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide.
Deletes a specific SSH key pair.
The delete key pair
operation supports tag-based access control via resource tags applied to the resource identified by keyPairName. For more information, see the Lightsail Dev Guide.
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The delete load balancer tls certificate
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Deletes a database in Amazon Lightsail.
The delete relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The detach disk
operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide.
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
', 'DownloadDefaultKeyPair' => 'Downloads the default SSH key pair from the user\'s account.
', 'ExportSnapshot' => 'Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack
operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot
operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots
or get disk snapshots
operations to get a list of snapshots that you can export to Amazon EC2.
Returns the names of all active (not deleted) resources.
', 'GetBlueprints' => 'Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
', 'GetBundles' => 'Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
', 'GetCloudFormationStackRecords' => 'Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
', 'GetDisk' => 'Returns information about a specific block storage disk.
', 'GetDiskSnapshot' => 'Returns information about a specific block storage disk snapshot.
', 'GetDiskSnapshots' => 'Returns information about all block storage disk snapshots in your AWS account and region.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
', 'GetDisks' => 'Returns information about all block storage disks in your AWS account and region.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
', 'GetDomain' => 'Returns information about a specific domain recordset.
', 'GetDomains' => 'Returns a list of all domains in the user\'s account.
', 'GetExportSnapshotRecords' => 'Returns the export snapshot record created as a result of the export snapshot
operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack
operation.
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
', 'GetInstanceAccessDetails' => 'Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
The get instance access details
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
', 'GetInstancePortStates' => 'Returns the port states for a specific virtual private server, or instance.
', 'GetInstanceSnapshot' => 'Returns information about a specific instance snapshot.
', 'GetInstanceSnapshots' => 'Returns all instance snapshots for the user\'s account.
', 'GetInstanceState' => 'Returns the state of a specific instance. Works on one instance at a time.
', 'GetInstances' => 'Returns information about all Amazon Lightsail virtual private servers, or instances.
', 'GetKeyPair' => 'Returns information about a specific key pair.
', 'GetKeyPairs' => 'Returns information about all key pairs in the user\'s account.
', 'GetLoadBalancer' => 'Returns information about the specified Lightsail load balancer.
', 'GetLoadBalancerMetricData' => 'Returns information about health metrics for your Lightsail load balancer.
', 'GetLoadBalancerTlsCertificates' => 'Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
', 'GetLoadBalancers' => 'Returns information about all load balancers in an account.
If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
', 'GetOperation' => 'Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
', 'GetOperations' => 'Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations
use the maximum (last) statusChangedAt
value from the previous request.
Gets operations for a specific resource (e.g., an instance or a static IP).
', 'GetRegions' => 'Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones
parameter to also return the Availability Zones in a region.
Returns information about a specific database in Amazon Lightsail.
', 'GetRelationalDatabaseBlueprints' => 'Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
', 'GetRelationalDatabaseBundles' => 'Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
', 'GetRelationalDatabaseEvents' => 'Returns a list of events for a specific database in Amazon Lightsail.
', 'GetRelationalDatabaseLogEvents' => 'Returns a list of log events for a database in Amazon Lightsail.
', 'GetRelationalDatabaseLogStreams' => 'Returns a list of available log streams for a specific database in Amazon Lightsail.
', 'GetRelationalDatabaseMasterUserPassword' => 'Returns the current, previous, or pending versions of the master user password for a Lightsail database.
The asdf
operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.
Returns the data points of the specified metric for a database in Amazon Lightsail.
', 'GetRelationalDatabaseParameters' => 'Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
', 'GetRelationalDatabaseSnapshot' => 'Returns information about a specific database snapshot in Amazon Lightsail.
', 'GetRelationalDatabaseSnapshots' => 'Returns information about all of your database snapshots in Amazon Lightsail.
', 'GetRelationalDatabases' => 'Returns information about all of your databases in Amazon Lightsail.
', 'GetStaticIp' => 'Returns information about a specific static IP.
', 'GetStaticIps' => 'Returns information about all static IPs in the user\'s account.
', 'ImportKeyPair' => 'Imports a public SSH key from a specific key pair.
', 'IsVpcPeered' => 'Returns a Boolean value indicating whether your Lightsail VPC is peered.
', 'OpenInstancePublicPorts' => 'Adds public ports to an Amazon Lightsail instance.
The open instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Tries to peer the Lightsail VPC with the user\'s default VPC.
', 'PutInstancePublicPorts' => 'Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
The put instance public ports
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Restarts a specific instance.
The reboot instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Restarts a specific database in Amazon Lightsail.
The reboot relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Deletes a specific static IP from your account.
', 'StartInstance' => 'Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance
operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The start instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database
operation.
The start relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The stop instance
operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
Stops a specific database that is currently running in Amazon Lightsail.
The stop relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.
The tag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide.
Attempts to unpeer the Lightsail VPC from the user\'s default VPC.
', 'UntagResource' => 'Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The untag resource
operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide.
Updates a domain recordset after it is created.
The update domain entry
operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide.
Updates the specified attribute for a load balancer. You can only update one attribute at a time.
The update load balancer attribute
operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide.
Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database\'s predefined maintenance window.
The update relational database
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don\'t cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: dynamic
or pending-reboot
. Parameters marked with a dynamic
apply type are applied immediately. Parameters marked with a pending-reboot
apply type are applied only after the database is rebooted using the reboot relational database
operation.
The update relational database parameters
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
', 'refs' => [], ], 'AccessDirection' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessDirection' => 'The access direction (inbound
or outbound
).
Lightsail throws this exception when an account is still in the setup in progress state.
', 'refs' => [], ], 'AllocateStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachedDiskMap' => [ 'base' => NULL, 'refs' => [ 'CreateInstancesFromSnapshotRequest$attachedDiskMapping' => 'An object containing information about one or more disk mappings.
', ], ], 'AvailabilityZone' => [ 'base' => 'Describes an Availability Zone.
', 'refs' => [ 'AvailabilityZoneList$member' => NULL, ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'Region$availabilityZones' => 'The Availability Zones. Follows the format us-east-2a
(case-sensitive).
The Availability Zones for databases. Follows the format us-east-2a
(case-sensitive).
A base64-encoded public key of the ssh-rsa
type.
A base64-encoded RSA private key.
', 'DownloadDefaultKeyPairResult$publicKeyBase64' => 'A base64-encoded public key of the ssh-rsa
type.
A base64-encoded RSA private key.
', 'ImportKeyPairRequest$publicKeyBase64' => 'A base64-encoded public key of the ssh-rsa
type.
The RSA fingerprint of the key pair.
', ], ], 'Blueprint' => [ 'base' => 'Describes a blueprint (a virtual private server image).
', 'refs' => [ 'BlueprintList$member' => NULL, ], ], 'BlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintsResult$blueprints' => 'An array of key-value pairs that contains information about the available blueprints.
', ], ], 'BlueprintType' => [ 'base' => NULL, 'refs' => [ 'Blueprint$type' => 'The type of the blueprint (e.g., os
or app
).
Describes a bundle, which is a set of specs describing your virtual private server (or instance).
', 'refs' => [ 'BundleList$member' => NULL, ], ], 'BundleList' => [ 'base' => NULL, 'refs' => [ 'GetBundlesResult$bundles' => 'An array of key-value pairs that contains information about the available bundles.
', ], ], 'CloseInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CloseInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'CloudFormationStackRecord' => [ 'base' => 'Describes a CloudFormation stack record created as a result of the create cloud formation stack
operation.
A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.
', 'refs' => [ 'CloudFormationStackRecordList$member' => NULL, ], ], 'CloudFormationStackRecordList' => [ 'base' => NULL, 'refs' => [ 'GetCloudFormationStackRecordsResult$cloudFormationStackRecords' => 'A list of objects describing the CloudFormation stack records.
', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'base' => 'Describes the source of a CloudFormation stack record (i.e., the export snapshot record).
', 'refs' => [ 'CloudFormationStackRecordSourceInfoList$member' => NULL, ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$sourceInfo' => 'A list of objects describing the source of the CloudFormation stack record.
', ], ], 'CloudFormationStackRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecordSourceInfo$resourceType' => 'The Lightsail resource type (e.g., ExportSnapshotRecord
).
Describes the destination of a record.
', 'refs' => [ 'CloudFormationStackRecord$destinationInfo' => 'A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
', 'ExportSnapshotRecord$destinationInfo' => 'A list of objects describing the destination of the export snapshot record.
', ], ], 'DetachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'Disk' => [ 'base' => 'Describes a system disk or an block storage disk.
', 'refs' => [ 'DiskList$member' => NULL, 'GetDiskResult$disk' => 'An object containing information about the disk.
', ], ], 'DiskInfo' => [ 'base' => 'Describes a disk.
', 'refs' => [ 'DiskInfoList$member' => NULL, ], ], 'DiskInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshotInfo$fromDiskInfo' => 'A list of objects describing the disks that were attached to the source instance.
', ], ], 'DiskList' => [ 'base' => NULL, 'refs' => [ 'GetDisksResult$disks' => 'An array of objects containing information about all block storage disks.
', 'InstanceHardware$disks' => 'The disks attached to the instance.
', 'InstanceSnapshot$fromAttachedDisks' => 'An array of disk objects containing information about all block storage disks.
', ], ], 'DiskMap' => [ 'base' => 'Describes a block storage disk mapping.
', 'refs' => [ 'DiskMapList$member' => NULL, ], ], 'DiskMapList' => [ 'base' => NULL, 'refs' => [ 'AttachedDiskMap$value' => NULL, ], ], 'DiskSnapshot' => [ 'base' => 'Describes a block storage disk snapshot.
', 'refs' => [ 'DiskSnapshotList$member' => NULL, 'GetDiskSnapshotResult$diskSnapshot' => 'An object containing information about the disk snapshot.
', ], ], 'DiskSnapshotInfo' => [ 'base' => 'Describes a disk snapshot.
', 'refs' => [ 'ExportSnapshotRecordSourceInfo$diskSnapshotInfo' => 'A list of objects describing a disk snapshot.
', ], ], 'DiskSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetDiskSnapshotsResult$diskSnapshots' => 'An array of objects containing information about all block storage disk snapshots.
', ], ], 'DiskSnapshotState' => [ 'base' => NULL, 'refs' => [ 'DiskSnapshot$state' => 'The status of the disk snapshot operation.
', ], ], 'DiskState' => [ 'base' => NULL, 'refs' => [ 'Disk$state' => 'Describes the status of the disk.
', ], ], 'Domain' => [ 'base' => 'Describes a domain where you are storing recordsets in Lightsail.
', 'refs' => [ 'DomainList$member' => NULL, 'GetDomainResult$domain' => 'An array of key-value pairs containing information about your get domain request.
', ], ], 'DomainEntry' => [ 'base' => 'Describes a domain recordset entry.
', 'refs' => [ 'CreateDomainEntryRequest$domainEntry' => 'An array of key-value pairs containing information about the domain entry request.
', 'DeleteDomainEntryRequest$domainEntry' => 'An array of key-value pairs containing information about your domain entries.
', 'DomainEntryList$member' => NULL, 'UpdateDomainEntryRequest$domainEntry' => 'An array of key-value pairs containing information about the domain entry.
', ], ], 'DomainEntryList' => [ 'base' => NULL, 'refs' => [ 'Domain$domainEntries' => 'An array of key-value pairs containing information about the domain entries.
', ], ], 'DomainEntryOptions' => [ 'base' => NULL, 'refs' => [ 'DomainEntry$options' => '(Deprecated) The options for the domain entry.
In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
The type of domain entry (e.g., SOA
or NS
).
An array of key-value pairs containing information about each of the domain entries in the user\'s account.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainEntryRequest$domainName' => 'The domain name (e.g., example.com
) for which you want to create the domain entry.
The domain name to manage (e.g., example.com
).
You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.
The domain name with which your certificate is associated (e.g., example.com
).
If you specify certificateDomainName
, then certificateName
is required (and vice-versa).
The domain name (e.g., example.com
) for your SSL/TLS certificate.
The name of the domain entry to delete.
', 'DeleteDomainRequest$domainName' => 'The specific domain name to delete.
', 'DomainEntry$name' => 'The name of the domain.
', 'DomainNameList$member' => NULL, 'GetDomainRequest$domainName' => 'The domain name for which your want to return information about.
', 'LoadBalancerTlsCertificate$domainName' => 'The domain name for your SSL/TLS certificate.
', 'LoadBalancerTlsCertificateDomainValidationOption$domainName' => 'The fully qualified domain name in the certificate request.
', 'LoadBalancerTlsCertificateDomainValidationRecord$domainName' => 'The domain name against which your SSL/TLS certificate was validated.
', 'UpdateDomainEntryRequest$domainName' => 'The name of the domain recordset to update.
', ], ], 'DomainNameList' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$certificateAlternativeNames' => 'The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com
, example.com
, m.example.com
, blog.example.com
).
An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com
).
Describes an export snapshot record.
', 'refs' => [ 'ExportSnapshotRecordList$member' => NULL, ], ], 'ExportSnapshotRecordList' => [ 'base' => NULL, 'refs' => [ 'GetExportSnapshotRecordsResult$exportSnapshotRecords' => 'A list of objects describing the export snapshot records.
', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'base' => 'Describes the source of an export snapshot record.
', 'refs' => [ 'ExportSnapshotRecord$sourceInfo' => 'A list of objects describing the source of the export snapshot record.
', ], ], 'ExportSnapshotRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'ExportSnapshotRecordSourceInfo$resourceType' => 'The Lightsail resource type (e.g., InstanceSnapshot
or DiskSnapshot
).
Describes an instance (a virtual private server).
', 'refs' => [ 'GetInstanceResult$instance' => 'An array of key-value pairs containing information about the specified instance.
', 'InstanceList$member' => NULL, ], ], 'InstanceAccessDetails' => [ 'base' => 'The parameters for gaining temporary access to one of your Amazon Lightsail instances.
', 'refs' => [ 'GetInstanceAccessDetailsResult$accessDetails' => 'An array of key-value pairs containing information about a get instance access request.
', ], ], 'InstanceAccessProtocol' => [ 'base' => NULL, 'refs' => [ 'GetInstanceAccessDetailsRequest$protocol' => 'The protocol to use to connect to your instance. Defaults to ssh
.
The protocol for these Amazon Lightsail instance access details.
', ], ], 'InstanceEntry' => [ 'base' => 'Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack
operation.
An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.
', ], ], 'InstanceHardware' => [ 'base' => 'Describes the hardware for the instance.
', 'refs' => [ 'Instance$hardware' => 'The size of the vCPU and the amount of RAM for the instance.
', ], ], 'InstanceHealthReason' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthSummary$instanceHealthReason' => 'More information about the instance health. If the instanceHealth
is healthy
, then an instanceHealthReason
value is not provided.
If instanceHealth
is initial
, the instanceHealthReason
value can be one of the following:
Lb.RegistrationInProgress
- The target instance is in the process of being registered with the load balancer.
Lb.InitialHealthChecking
- The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
If instanceHealth
is unhealthy
, the instanceHealthReason
value can be one of the following:
Instance.ResponseCodeMismatch
- The health checks did not return an expected HTTP code.
Instance.Timeout
- The health check requests timed out.
Instance.FailedHealthChecks
- The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
Lb.InternalError
- The health checks failed due to an internal error.
If instanceHealth
is unused
, the instanceHealthReason
value can be one of the following:
Instance.NotRegistered
- The target instance is not registered with the target group.
Instance.NotInUse
- The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
Instance.IpUnusable
- The target IP address is reserved for use by a Lightsail load balancer.
Instance.InvalidState
- The target is in the stopped or terminated state.
If instanceHealth
is draining
, the instanceHealthReason
value can be one of the following:
Instance.DeregistrationInProgress
- The target instance is in the process of being deregistered and the deregistration delay period has not expired.
Describes the overall instance health. Valid values are below.
', ], ], 'InstanceHealthSummary' => [ 'base' => 'Describes information about the health of the instance.
', 'refs' => [ 'InstanceHealthSummaryList$member' => NULL, ], ], 'InstanceHealthSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$instanceHealthSummary' => 'An array of InstanceHealthSummary objects describing the health of the load balancer.
', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'GetInstancesResult$instances' => 'An array of key-value pairs containing information about your instances.
', ], ], 'InstanceMetricName' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$metricName' => 'The metric name to get data about.
', 'GetInstanceMetricDataResult$metricName' => 'The metric name to return data for.
', ], ], 'InstanceNetworking' => [ 'base' => 'Describes monthly data transfer rates and port information for an instance.
', 'refs' => [ 'Instance$networking' => 'Information about the public ports and monthly data transfer rates for the instance.
', ], ], 'InstancePlatform' => [ 'base' => NULL, 'refs' => [ 'Blueprint$platform' => 'The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
', 'InstancePlatformList$member' => NULL, ], ], 'InstancePlatformList' => [ 'base' => NULL, 'refs' => [ 'Bundle$supportedPlatforms' => 'The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS
bundle on a blueprint that supports the WINDOWS
platform. LINUX_UNIX
blueprints require a LINUX_UNIX
bundle.
Describes information about the instance ports.
', 'refs' => [ 'InstancePortInfoList$member' => NULL, ], ], 'InstancePortInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceNetworking$ports' => 'An array of key-value pairs containing information about the ports on the instance.
', ], ], 'InstancePortState' => [ 'base' => 'Describes the port state.
', 'refs' => [ 'InstancePortStateList$member' => NULL, ], ], 'InstancePortStateList' => [ 'base' => NULL, 'refs' => [ 'GetInstancePortStatesResult$portStates' => 'Information about the port states resulting from your request.
', ], ], 'InstanceSnapshot' => [ 'base' => 'Describes the snapshot of the virtual private server, or instance.
', 'refs' => [ 'GetInstanceSnapshotResult$instanceSnapshot' => 'An array of key-value pairs containing information about the results of your get instance snapshot request.
', 'InstanceSnapshotList$member' => NULL, ], ], 'InstanceSnapshotInfo' => [ 'base' => 'Describes an instance snapshot.
', 'refs' => [ 'ExportSnapshotRecordSourceInfo$instanceSnapshotInfo' => 'A list of objects describing an instance snapshot.
', ], ], 'InstanceSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceSnapshotsResult$instanceSnapshots' => 'An array of key-value pairs containing information about the results of your get instance snapshots request.
', ], ], 'InstanceSnapshotState' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshot$state' => 'The state the snapshot is in.
', ], ], 'InstanceState' => [ 'base' => 'Describes the virtual private server (or instance) status.
', 'refs' => [ 'GetInstanceStateResult$state' => 'The state of the instance.
', 'Instance$state' => 'The status code and the state (e.g., running
) for the instance.
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
The private IP address of the instance.
', 'Instance$publicIpAddress' => 'The public IP address of the instance.
', 'InstanceAccessDetails$ipAddress' => 'The public IP address of the Amazon Lightsail instance.
', 'StaticIp$ipAddress' => 'The static IP address.
', ], ], 'IpV6Address' => [ 'base' => NULL, 'refs' => [ 'Instance$ipv6Address' => 'The IPv6 address of the instance.
', ], ], 'IsVpcPeeredRequest' => [ 'base' => NULL, 'refs' => [], ], 'IsVpcPeeredResult' => [ 'base' => NULL, 'refs' => [], ], 'IsoDate' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$createdAt' => 'The date when the CloudFormation stack record was created.
', 'CreateRelationalDatabaseFromSnapshotRequest$restoreTime' => 'The date and time to restore your database from.
Constraints:
Must be before the latest restorable time for the database.
Cannot be specified if the use latest restorable time
parameter is true
.
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the restore time.
The date when the disk was created.
', 'DiskSnapshot$createdAt' => 'The date when the disk snapshot was created.
', 'Domain$createdAt' => 'The date when the domain recordset was created.
', 'ExportSnapshotRecord$createdAt' => 'The date when the export snapshot record was created.
', 'ExportSnapshotRecordSourceInfo$createdAt' => 'The date when the source instance or disk snapshot was created.
', 'GetRelationalDatabaseLogEventsRequest$startTime' => 'The start of the time interval from which to get log events.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the start time.
The end of the time interval from which to get log events.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the end time.
The timestamp when the specified version of the master user password was created.
', 'GetRelationalDatabaseMetricDataRequest$startTime' => 'The start of the time interval from which to get metric data.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the start time.
The end of the time interval from which to get metric data.
Constraints:
Specified in Universal Coordinated Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000
as the end time.
The timestamp when the instance was created (e.g., 1479734909.17
).
For SSH access, the date on which the temporary keys expire.
', 'InstanceSnapshot$createdAt' => 'The timestamp when the snapshot was created (e.g., 1479907467.024
).
The timestamp when the key pair was created (e.g., 1479816991.349
).
The date when your load balancer was created.
', 'LoadBalancerTlsCertificate$createdAt' => 'The time when you created your SSL/TLS certificate.
', 'LoadBalancerTlsCertificate$issuedAt' => 'The time when the SSL/TLS certificate was issued.
', 'LoadBalancerTlsCertificate$notAfter' => 'The timestamp when the SSL/TLS certificate expires.
', 'LoadBalancerTlsCertificate$notBefore' => 'The timestamp when the SSL/TLS certificate is first valid.
', 'LoadBalancerTlsCertificate$revokedAt' => 'The timestamp when the SSL/TLS certificate was revoked.
', 'LogEvent$createdAt' => 'The timestamp when the database log event was created.
', 'Operation$createdAt' => 'The timestamp when the operation was initialized (e.g., 1479816991.349
).
The timestamp when the status was changed (e.g., 1479816991.349
).
The effective date of the pending database maintenance action.
', 'RelationalDatabase$createdAt' => 'The timestamp when the database was created. Formatted in Unix time.
', 'RelationalDatabase$latestRestorableTime' => 'The latest point in time to which the database can be restored. Formatted in Unix time.
', 'RelationalDatabaseEvent$createdAt' => 'The timestamp when the database event was created.
', 'RelationalDatabaseSnapshot$createdAt' => 'The timestamp when the database snapshot was created.
', 'StaticIp$createdAt' => 'The timestamp when the static IP was created (e.g., 1479735304.222
).
Describes the SSH key pair.
', 'refs' => [ 'CreateKeyPairResult$keyPair' => 'An array of key-value pairs containing information about the new key pair you just created.
', 'GetKeyPairResult$keyPair' => 'An array of key-value pairs containing information about the key pair.
', 'KeyPairList$member' => NULL, ], ], 'KeyPairList' => [ 'base' => NULL, 'refs' => [ 'GetKeyPairsResult$keyPairs' => 'An array of key-value pairs containing information about the key pairs.
', ], ], 'LoadBalancer' => [ 'base' => 'Describes the Lightsail load balancer.
', 'refs' => [ 'GetLoadBalancerResult$loadBalancer' => 'An object containing information about your load balancer.
', 'LoadBalancerList$member' => NULL, ], ], 'LoadBalancerAttributeName' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerConfigurationOptions$key' => NULL, 'UpdateLoadBalancerAttributeRequest$attributeName' => 'The name of the attribute you want to update. Valid values are below.
', ], ], 'LoadBalancerConfigurationOptions' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$configurationOptions' => 'A string to string map of the configuration options for your load balancer. Valid values are listed below.
', ], ], 'LoadBalancerList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancersResult$loadBalancers' => 'An array of LoadBalancer objects describing your load balancers.
', ], ], 'LoadBalancerMetricName' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerMetricDataRequest$metricName' => 'The metric about which you want to return information. Valid values are listed below, along with the most useful statistics
to include in your request.
ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
Statistics
: The most useful statistic is Sum
.
HealthyHostCount
- The number of target instances that are considered healthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
UnhealthyHostCount
- The number of target instances that are considered unhealthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.
Statistics
: The most useful statistic is Average
.
RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.
Statistics
: The most useful statistic is Sum
.
RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics
to include in your request.
ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
Statistics
: The most useful statistic is Sum
.
HealthyHostCount
- The number of target instances that are considered healthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
UnhealthyHostCount
- The number of target instances that are considered unhealthy.
Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
.
HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.
Statistics
: The most useful statistic is Average
.
RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.
Statistics
: The most useful statistic is Sum
.
RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.
Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
The protocol you have enabled for your load balancer. Valid values are below.
You can\'t just have HTTP_HTTPS
, but you can have just HTTP
.
The status of your load balancer. Valid values are below.
', ], ], 'LoadBalancerTlsCertificate' => [ 'base' => 'Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
', 'refs' => [ 'LoadBalancerTlsCertificateList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOption$validationStatus' => 'The status of the domain validation. Valid values are listed below.
', 'LoadBalancerTlsCertificateDomainValidationRecord$validationStatus' => 'The validation status. Valid values are listed below.
', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'base' => 'Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.
', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOptionList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$domainValidationOptions' => 'Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail\'s managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.
', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'base' => 'Describes the validation record of each domain name in the SSL/TLS certificate.
', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationRecordList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$domainValidationRecords' => 'An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$failureReason' => 'The reason for the SSL/TLS certificate validation failure.
', ], ], 'LoadBalancerTlsCertificateList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerTlsCertificatesResult$tlsCertificates' => 'An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$renewalStatus' => 'The status of Lightsail\'s managed renewal of the certificate. Valid values are listed below.
', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'base' => 'Contains information about the status of Lightsail\'s managed renewal for the certificate.
', 'refs' => [ 'LoadBalancerTlsCertificate$renewalSummary' => 'An object containing information about the status of Lightsail\'s managed renewal for the certificate.
', ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$revocationReason' => 'The reason the certificate was revoked. Valid values are below.
', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$status' => 'The status of the SSL/TLS certificate. Valid values are below.
', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'base' => 'Provides a summary of SSL/TLS certificate metadata.
', 'refs' => [ 'LoadBalancerTlsCertificateSummaryList$member' => NULL, ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$tlsCertificateSummaries' => 'An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true
, the certificate is attached to the load balancer.
Describes a database log event.
', 'refs' => [ 'LogEventList$member' => NULL, ], ], 'LogEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseLogEventsResult$resourceLogEvents' => 'An object describing the result of your get relational database log events request.
', ], ], 'MetricDatapoint' => [ 'base' => 'Describes the metric data point.
', 'refs' => [ 'MetricDatapointList$member' => NULL, ], ], 'MetricDatapointList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataResult$metricData' => 'An array of key-value pairs containing information about the results of your get instance metric data request.
', 'GetLoadBalancerMetricDataResult$metricData' => 'An array of metric datapoint objects.
', 'GetRelationalDatabaseMetricDataResult$metricData' => 'An object describing the result of your get relational database metric data request.
', ], ], 'MetricPeriod' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$period' => 'The granularity, in seconds, of the returned data points.
', 'GetLoadBalancerMetricDataRequest$period' => 'The granularity, in seconds, of the returned data points.
', 'GetRelationalDatabaseMetricDataRequest$period' => 'The granularity, in seconds, of the returned data points.
', ], ], 'MetricStatistic' => [ 'base' => NULL, 'refs' => [ 'MetricStatisticList$member' => NULL, ], ], 'MetricStatisticList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$statistics' => 'The instance statistics.
', 'GetLoadBalancerMetricDataRequest$statistics' => 'An array of statistics that you want to request metrics for. Valid values are listed below.
SampleCount
- The count (number) of data points used for the statistical calculation.
Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.
Sum
- All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.
Minimum
- The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.
Maximum
- The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
The array of statistics for your metric data request.
', ], ], 'MetricUnit' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$unit' => 'The unit. The list of valid values is below.
', 'GetLoadBalancerMetricDataRequest$unit' => 'The unit for the time period request. Valid values are listed below.
', 'GetRelationalDatabaseMetricDataRequest$unit' => 'The unit for the metric data request.
', 'MetricDatapoint$unit' => 'The unit.
', ], ], 'MonthlyTransfer' => [ 'base' => 'Describes the monthly data transfer in and out of your virtual private server (or instance).
', 'refs' => [ 'InstanceNetworking$monthlyTransfer' => 'The amount of data in GB allocated for monthly data transfers.
', ], ], 'NetworkProtocol' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$protocol' => 'The protocol being used. Can be one of the following.
tcp
- Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.
all
- All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
udp
- With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
The protocol being used. Can be one of the following.
tcp
- Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.
all
- All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
udp
- With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
The protocol.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AttachDiskRequest$diskPath' => 'The disk path to expose to the instance (e.g., /dev/xvdf
).
The name of the Availability Zone. The format is us-east-2a
(case-sensitive).
The state of the Availability Zone.
', 'Blueprint$blueprintId' => 'The ID for the virtual private server image (e.g., app_wordpress_4_4
or app_lamp_7_0
).
The group name of the blueprint (e.g., amazon-linux
).
The bundle ID (e.g., micro_1_0
).
The Amazon Resource Name (ARN) of the CloudFormation stack record.
', 'CloudFormationStackRecordSourceInfo$name' => 'The name of the record.
', 'CloudFormationStackRecordSourceInfo$arn' => 'The Amazon Resource Name (ARN) of the export snapshot record.
', 'CreateDiskFromSnapshotRequest$availabilityZone' => 'The Availability Zone where you want to create the disk (e.g., us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
', 'CreateDiskRequest$availabilityZone' => 'The Availability Zone where you want to create the disk (e.g., us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
', 'CreateInstancesFromSnapshotRequest$bundleId' => 'The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0
).
The ID for a virtual private server image (e.g., app_wordpress_4_4
or app_lamp_7_0
). Use the get blueprints operation to return a list of available images (or blueprints).
The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0
).
The ID of the resource created at the destination.
', 'DestinationInfo$service' => 'The destination service of the record.
', 'Disk$arn' => 'The Amazon Resource Name (ARN) of the disk.
', 'DiskInfo$path' => 'The disk path.
', 'DiskMap$originalDiskPath' => 'The original disk path exposed to the instance (for example, /dev/sdh
).
The Amazon Resource Name (ARN) of the disk snapshot.
', 'DiskSnapshot$fromDiskArn' => 'The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
', 'DiskSnapshot$fromInstanceArn' => 'The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
', 'Domain$arn' => 'The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE
).
The ID of the domain recordset entry.
', 'ExportSnapshotRecord$arn' => 'The Amazon Resource Name (ARN) of the export snapshot record.
', 'ExportSnapshotRecordSourceInfo$name' => 'The name of the source instance or disk snapshot.
', 'ExportSnapshotRecordSourceInfo$arn' => 'The Amazon Resource Name (ARN) of the source instance or disk snapshot.
', 'ExportSnapshotRecordSourceInfo$fromResourceName' => 'The name of the snapshot\'s source instance or disk.
', 'ExportSnapshotRecordSourceInfo$fromResourceArn' => 'The Amazon Resource Name (ARN) of the snapshot\'s source instance or disk.
', 'GetOperationRequest$operationId' => 'A GUID used to identify the operation.
', 'Instance$arn' => 'The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE
).
The blueprint ID (e.g., os_amlinux_2016_03
).
The friendly name of the blueprint (e.g., Amazon Linux
).
The bundle for the instance (e.g., micro_1_0
).
The user name for connecting to the instance (e.g., ec2-user
).
The instance type (e.g., t2.micro
) to use for the new Amazon EC2 instance.
The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE
).
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE
).
The bundle ID from which the source instance was created (e.g., micro_1_0
).
The blueprint ID from which the source instance (e.g., os_debian_8_3
).
The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE
).
The Amazon Resource Name (ARN) of the load balancer.
', 'LoadBalancer$dnsName' => 'The DNS name of your Lightsail load balancer.
', 'LoadBalancer$healthCheckPath' => 'The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.
', 'LoadBalancerTlsCertificate$arn' => 'The Amazon Resource Name (ARN) of the SSL/TLS certificate.
', 'LoadBalancerTlsCertificate$issuer' => 'The issuer of the certificate.
', 'LoadBalancerTlsCertificate$keyAlgorithm' => 'The algorithm that was used to generate the key pair (the public and private key).
', 'LoadBalancerTlsCertificate$serial' => 'The serial number of the certificate.
', 'LoadBalancerTlsCertificate$signatureAlgorithm' => 'The algorithm that was used to sign the certificate.
', 'LoadBalancerTlsCertificate$subject' => 'The name of the entity that is associated with the public key contained in the certificate.
', 'LoadBalancerTlsCertificateDomainValidationRecord$name' => 'A fully qualified domain name in the certificate. For example, example.com
.
The type of validation record. For example, CNAME
for domain validation.
The value for that type.
', 'Operation$id' => 'The ID of the operation.
', 'PendingMaintenanceAction$action' => 'The type of pending database maintenance action.
', 'PendingMaintenanceAction$description' => 'Additional detail about the pending database maintenance action.
', 'RelationalDatabase$arn' => 'The Amazon Resource Name (ARN) of the database.
', 'RelationalDatabase$relationalDatabaseBlueprintId' => 'The blueprint ID for the database. A blueprint describes the major engine version of a database.
', 'RelationalDatabase$relationalDatabaseBundleId' => 'The bundle ID for the database. A bundle describes the performance specifications for your database.
', 'RelationalDatabase$state' => 'Describes the current state of the database.
', 'RelationalDatabase$engine' => 'The database software (for example, MySQL
).
The database engine version (for example, 5.7.23
).
The master user name of the database.
', 'RelationalDatabase$parameterApplyStatus' => 'The status of parameter updates for the database.
', 'RelationalDatabase$preferredBackupWindow' => 'The daily time range during which automated backups are created for the database (for example, 16:00-16:30
).
The weekly time range during which system maintenance can occur on the database.
In the format ddd:hh24:mi-ddd:hh24:mi
. For example, Tue:17:00-Tue:17:30
.
Specifies the DNS address of the database.
', 'RelationalDatabaseSnapshot$arn' => 'The Amazon Resource Name (ARN) of the database snapshot.
', 'RelationalDatabaseSnapshot$engine' => 'The software of the database snapshot (for example, MySQL
)
The database engine version for the database snapshot (for example, 5.7.23
).
The state of the database snapshot.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseName' => 'The name of the source database from which the database snapshot was created.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseArn' => 'The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
', 'StaticIp$arn' => 'The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE
).
Lightsail throws this exception when it cannot find a resource.
', 'refs' => [], ], 'OpenInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'OpenInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'Operation' => [ 'base' => 'Describes the API operation.
', 'refs' => [ 'CloseInstancePublicPortsResult$operation' => 'An array of key-value pairs that contains information about the operation.
', 'CreateDomainEntryResult$operation' => 'An array of key-value pairs containing information about the operation.
', 'CreateDomainResult$operation' => 'An array of key-value pairs containing information about the domain resource you created.
', 'CreateKeyPairResult$operation' => 'An array of key-value pairs containing information about the results of your create key pair request.
', 'DeleteDomainEntryResult$operation' => 'An array of key-value pairs containing information about the results of your delete domain entry request.
', 'DeleteDomainResult$operation' => 'An array of key-value pairs containing information about the results of your delete domain request.
', 'DeleteKeyPairResult$operation' => 'An array of key-value pairs containing information about the results of your delete key pair request.
', 'GetOperationResult$operation' => 'An array of key-value pairs containing information about the results of your get operation request.
', 'ImportKeyPairResult$operation' => 'An array of key-value pairs containing information about the request operation.
', 'OpenInstancePublicPortsResult$operation' => 'An array of key-value pairs containing information about the request operation.
', 'OperationList$member' => NULL, 'PeerVpcResult$operation' => 'An array of key-value pairs containing information about the request operation.
', 'PutInstancePublicPortsResult$operation' => 'Describes metadata about the operation you just executed.
', 'UnpeerVpcResult$operation' => 'An array of key-value pairs containing information about the request operation.
', ], ], 'OperationFailureException' => [ 'base' => 'Lightsail throws this exception when an operation fails to execute.
', 'refs' => [], ], 'OperationList' => [ 'base' => NULL, 'refs' => [ 'AllocateStaticIpResult$operations' => 'An array of key-value pairs containing information about the static IP address you allocated.
', 'AttachDiskResult$operations' => 'An object describing the API operations.
', 'AttachInstancesToLoadBalancerResult$operations' => 'An object representing the API operations.
', 'AttachLoadBalancerTlsCertificateResult$operations' => 'An object representing the API operations.
These SSL/TLS certificates are only usable by Lightsail load balancers. You can\'t get the certificate and use it for another purpose.
', 'AttachStaticIpResult$operations' => 'An array of key-value pairs containing information about your API operations.
', 'CopySnapshotResult$operations' => 'A list of objects describing the API operation.
', 'CreateCloudFormationStackResult$operations' => 'A list of objects describing the API operation.
', 'CreateDiskFromSnapshotResult$operations' => 'An object describing the API operations.
', 'CreateDiskResult$operations' => 'An object describing the API operations.
', 'CreateDiskSnapshotResult$operations' => 'An object describing the API operations.
', 'CreateInstanceSnapshotResult$operations' => 'An array of key-value pairs containing information about the results of your create instances snapshot request.
', 'CreateInstancesFromSnapshotResult$operations' => 'An array of key-value pairs containing information about the results of your create instances from snapshot request.
', 'CreateInstancesResult$operations' => 'An array of key-value pairs containing information about the results of your create instances request.
', 'CreateLoadBalancerResult$operations' => 'An object containing information about the API operations.
', 'CreateLoadBalancerTlsCertificateResult$operations' => 'An object containing information about the API operations.
', 'CreateRelationalDatabaseFromSnapshotResult$operations' => 'An object describing the result of your create relational database from snapshot request.
', 'CreateRelationalDatabaseResult$operations' => 'An object describing the result of your create relational database request.
', 'CreateRelationalDatabaseSnapshotResult$operations' => 'An object describing the result of your create relational database snapshot request.
', 'DeleteDiskResult$operations' => 'An object describing the API operations.
', 'DeleteDiskSnapshotResult$operations' => 'An object describing the API operations.
', 'DeleteInstanceResult$operations' => 'An array of key-value pairs containing information about the results of your delete instance request.
', 'DeleteInstanceSnapshotResult$operations' => 'An array of key-value pairs containing information about the results of your delete instance snapshot request.
', 'DeleteLoadBalancerResult$operations' => 'An object describing the API operations.
', 'DeleteLoadBalancerTlsCertificateResult$operations' => 'An object describing the API operations.
', 'DeleteRelationalDatabaseResult$operations' => 'An object describing the result of your delete relational database request.
', 'DeleteRelationalDatabaseSnapshotResult$operations' => 'An object describing the result of your delete relational database snapshot request.
', 'DetachDiskResult$operations' => 'An object describing the API operations.
', 'DetachInstancesFromLoadBalancerResult$operations' => 'An object describing the API operations.
', 'DetachStaticIpResult$operations' => 'An array of key-value pairs containing information about the results of your detach static IP request.
', 'ExportSnapshotResult$operations' => 'A list of objects describing the API operation.
', 'GetOperationsForResourceResult$operations' => 'An array of key-value pairs containing information about the results of your get operations for resource request.
', 'GetOperationsResult$operations' => 'An array of key-value pairs containing information about the results of your get operations request.
', 'RebootInstanceResult$operations' => 'An array of key-value pairs containing information about the request operations.
', 'RebootRelationalDatabaseResult$operations' => 'An object describing the result of your reboot relational database request.
', 'ReleaseStaticIpResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'StartInstanceResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'StartRelationalDatabaseResult$operations' => 'An object describing the result of your start relational database request.
', 'StopInstanceResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'StopRelationalDatabaseResult$operations' => 'An object describing the result of your stop relational database request.
', 'TagResourceResult$operations' => 'A list of objects describing the API operation.
', 'UntagResourceResult$operations' => 'A list of objects describing the API operation.
', 'UpdateDomainEntryResult$operations' => 'An array of key-value pairs containing information about the request operation.
', 'UpdateLoadBalancerAttributeResult$operations' => 'An object describing the API operations.
', 'UpdateRelationalDatabaseParametersResult$operations' => 'An object describing the result of your update relational database parameters request.
', 'UpdateRelationalDatabaseResult$operations' => 'An object describing the result of your update relational database request.
', ], ], 'OperationStatus' => [ 'base' => NULL, 'refs' => [ 'Operation$status' => 'The status of the operation.
', ], ], 'OperationType' => [ 'base' => NULL, 'refs' => [ 'Operation$operationType' => 'The type of operation.
', ], ], 'PasswordData' => [ 'base' => 'The password data for the Windows Server-based instance, including the ciphertext and the key pair name.
', 'refs' => [ 'InstanceAccessDetails$passwordData' => 'For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password
is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
Describes a pending database maintenance action.
', 'refs' => [ 'PendingMaintenanceActionList$member' => NULL, ], ], 'PendingMaintenanceActionList' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabase$pendingMaintenanceActions' => 'Describes the pending maintenance actions for the database.
', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'base' => 'Describes a pending database value modification.
', 'refs' => [ 'RelationalDatabase$pendingModifiedValues' => 'Describes pending database value modifications.
', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$instancePort' => 'The instance port where you\'re creating your load balancer.
', 'InstancePortInfo$fromPort' => 'The first port in the range.
', 'InstancePortInfo$toPort' => 'The last port in the range.
', 'InstancePortState$fromPort' => 'The first port in the range.
', 'InstancePortState$toPort' => 'The last port in the range.
', 'PortInfo$fromPort' => 'The first port in the range.
', 'PortInfo$toPort' => 'The last port in the range.
', 'PortList$member' => NULL, ], ], 'PortAccessType' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessType' => 'The type of access (Public
or Private
).
Describes information about the ports on your virtual private server (or instance).
', 'refs' => [ 'CloseInstancePublicPortsRequest$portInfo' => 'Information about the public port you are trying to close.
', 'OpenInstancePublicPortsRequest$portInfo' => 'An array of key-value pairs containing information about the port mappings.
', 'PortInfoList$member' => NULL, ], ], 'PortInfoList' => [ 'base' => NULL, 'refs' => [ 'PutInstancePublicPortsRequest$portInfos' => 'Specifies information about the public port(s).
', ], ], 'PortInfoSourceType' => [ 'base' => NULL, 'refs' => [ 'InstanceEntry$portInfoSource' => 'The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
DEFAULT — Use the default firewall settings from the image.
INSTANCE — Use the firewall settings from the source Lightsail instance.
NONE — Default to Amazon EC2.
CLOSED — All ports closed.
An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
', ], ], 'PortState' => [ 'base' => NULL, 'refs' => [ 'InstancePortState$state' => 'Specifies whether the instance port is open
or closed
.
The current state of the CloudFormation stack record.
', 'ExportSnapshotRecord$state' => 'The state of the export snapshot record.
', ], ], 'Region' => [ 'base' => 'Describes the AWS Region.
', 'refs' => [ 'RegionList$member' => NULL, ], ], 'RegionList' => [ 'base' => NULL, 'refs' => [ 'GetRegionsResult$regions' => 'An array of key-value pairs containing information about your get regions request.
', ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'CopySnapshotRequest$sourceRegion' => 'The AWS Region where the source snapshot is located.
', 'Region$name' => 'The region name (e.g., us-east-2
).
The AWS Region name.
', ], ], 'RelationalDatabase' => [ 'base' => 'Describes a database.
', 'refs' => [ 'GetRelationalDatabaseResult$relationalDatabase' => 'An object describing the specified database.
', 'RelationalDatabaseList$member' => NULL, ], ], 'RelationalDatabaseBlueprint' => [ 'base' => 'Describes a database image, or blueprint. A blueprint describes the major engine version of a database.
', 'refs' => [ 'RelationalDatabaseBlueprintList$member' => NULL, ], ], 'RelationalDatabaseBlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBlueprintsResult$blueprints' => 'An object describing the result of your get relational database blueprints request.
', ], ], 'RelationalDatabaseBundle' => [ 'base' => 'Describes a database bundle. A bundle describes the performance specifications of the database.
', 'refs' => [ 'RelationalDatabaseBundleList$member' => NULL, ], ], 'RelationalDatabaseBundleList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBundlesResult$bundles' => 'An object describing the result of your get relational database bundles request.
', ], ], 'RelationalDatabaseEndpoint' => [ 'base' => 'Describes an endpoint for a database.
', 'refs' => [ 'RelationalDatabase$masterEndpoint' => 'The master endpoint for the database.
', ], ], 'RelationalDatabaseEngine' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabaseBlueprint$engine' => 'The database software of the database blueprint (for example, MySQL
).
Describes an event for a database.
', 'refs' => [ 'RelationalDatabaseEventList$member' => NULL, ], ], 'RelationalDatabaseEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseEventsResult$relationalDatabaseEvents' => 'An object describing the result of your get relational database events request.
', ], ], 'RelationalDatabaseHardware' => [ 'base' => 'Describes the hardware of a database.
', 'refs' => [ 'RelationalDatabase$hardware' => 'Describes the hardware of the database.
', ], ], 'RelationalDatabaseList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabasesResult$relationalDatabases' => 'An object describing the result of your get relational databases request.
', ], ], 'RelationalDatabaseMetricName' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMetricDataRequest$metricName' => 'The name of the metric data to return.
', 'GetRelationalDatabaseMetricDataResult$metricName' => 'The name of the metric.
', ], ], 'RelationalDatabaseParameter' => [ 'base' => 'Describes the parameters of a database.
', 'refs' => [ 'RelationalDatabaseParameterList$member' => NULL, ], ], 'RelationalDatabaseParameterList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseParametersResult$parameters' => 'An object describing the result of your get relational database parameters request.
', 'UpdateRelationalDatabaseParametersRequest$parameters' => 'The database parameters to update.
', ], ], 'RelationalDatabasePasswordVersion' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMasterUserPasswordRequest$passwordVersion' => 'The password version to return.
Specifying CURRENT
or PREVIOUS
returns the current or previous passwords respectively. Specifying PENDING
returns the newest version of the password that will rotate to CURRENT
. After the PENDING
password rotates to CURRENT
, the PENDING
password is no longer available.
Default: CURRENT
Describes a database snapshot.
', 'refs' => [ 'GetRelationalDatabaseSnapshotResult$relationalDatabaseSnapshot' => 'An object describing the specified database snapshot.
', 'RelationalDatabaseSnapshotList$member' => NULL, ], ], 'RelationalDatabaseSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseSnapshotsResult$relationalDatabaseSnapshots' => 'An object describing the result of your get relational database snapshots request.
', ], ], 'ReleaseStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'ResourceLocation' => [ 'base' => 'Describes the resource location.
', 'refs' => [ 'CloudFormationStackRecord$location' => 'A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
', 'Disk$location' => 'The AWS Region and Availability Zone where the disk is located.
', 'DiskSnapshot$location' => 'The AWS Region and Availability Zone where the disk snapshot was created.
', 'Domain$location' => 'The AWS Region and Availability Zones where the domain recordset was created.
', 'ExportSnapshotRecord$location' => 'The AWS Region and Availability Zone where the export snapshot record is located.
', 'Instance$location' => 'The region name and Availability Zone where the instance is located.
', 'InstanceSnapshot$location' => 'The region name and Availability Zone where you created the snapshot.
', 'KeyPair$location' => 'The region name and Availability Zone where the key pair was created.
', 'LoadBalancer$location' => 'The AWS Region where your load balancer was created (e.g., us-east-2a
). Lightsail automatically creates your load balancer across Availability Zones.
The AWS Region and Availability Zone where you created your certificate.
', 'Operation$location' => 'The region and Availability Zone.
', 'RelationalDatabase$location' => 'The Region name and Availability Zone where the database is located.
', 'RelationalDatabaseSnapshot$location' => 'The Region name and Availability Zone where the database snapshot is located.
', 'StaticIp$location' => 'The region and Availability Zone where the static IP was created.
', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'AllocateStaticIpRequest$staticIpName' => 'The name of the static IP address.
', 'AttachDiskRequest$diskName' => 'The unique Lightsail disk name (e.g., my-disk
).
The name of the Lightsail instance where you want to utilize the storage disk.
', 'AttachInstancesToLoadBalancerRequest$loadBalancerName' => 'The name of the load balancer.
', 'AttachLoadBalancerTlsCertificateRequest$loadBalancerName' => 'The name of the load balancer to which you want to associate the SSL/TLS certificate.
', 'AttachLoadBalancerTlsCertificateRequest$certificateName' => 'The name of your SSL/TLS certificate.
', 'AttachStaticIpRequest$staticIpName' => 'The name of the static IP.
', 'AttachStaticIpRequest$instanceName' => 'The instance name to which you want to attach the static IP address.
', 'AttachedDiskMap$key' => NULL, 'Blueprint$name' => 'The friendly name of the blueprint (e.g., Amazon Linux
).
The name of the instance on which you\'re attempting to close the public ports.
', 'CloudFormationStackRecord$name' => 'The name of the CloudFormation stack record. It starts with CloudFormationStackRecord
followed by a GUID.
The name of the source instance or disk snapshot to be copied.
', 'CopySnapshotRequest$targetSnapshotName' => 'The name of the new instance or disk snapshot to be created as a copy.
', 'CreateDiskFromSnapshotRequest$diskName' => 'The unique Lightsail disk name (e.g., my-disk
).
The name of the disk snapshot (e.g., my-snapshot
) from which to create the new storage disk.
The unique Lightsail disk name (e.g., my-disk
).
The unique name of the source disk (e.g., Disk-Virginia-1
).
This parameter cannot be defined together with the instance name
parameter. The disk name
and instance name
parameters are mutually exclusive.
The name of the destination disk snapshot (e.g., my-disk-snapshot
) based on the source disk.
The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1
). When this is defined, a snapshot of the instance\'s system volume is created.
This parameter cannot be defined together with the disk name
parameter. The instance name
and disk name
parameters are mutually exclusive.
The name for your new snapshot.
', 'CreateInstanceSnapshotRequest$instanceName' => 'The Lightsail instance on which to base your snapshot.
', 'CreateInstancesFromSnapshotRequest$instanceSnapshotName' => 'The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
', 'CreateInstancesFromSnapshotRequest$keyPairName' => 'The name for your key pair.
', 'CreateInstancesRequest$customImageName' => '(Deprecated) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
The name of your key pair.
', 'CreateKeyPairRequest$keyPairName' => 'The name for your new key pair.
', 'CreateLoadBalancerRequest$loadBalancerName' => 'The name of your load balancer.
', 'CreateLoadBalancerRequest$certificateName' => 'The name of the SSL/TLS certificate.
If you specify certificateName
, then certificateDomainName
is required (and vice-versa).
The load balancer name where you want to create the SSL/TLS certificate.
', 'CreateLoadBalancerTlsCertificateRequest$certificateName' => 'The SSL/TLS certificate name.
You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.
', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseName' => 'The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database snapshot from which to create your new database.
', 'CreateRelationalDatabaseFromSnapshotRequest$sourceRelationalDatabaseName' => 'The name of the source database.
', 'CreateRelationalDatabaseRequest$relationalDatabaseName' => 'The name to use for your new database.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database on which to base your new snapshot.
', 'CreateRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => 'The name for your new database snapshot.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The unique name of the disk you want to delete (e.g., my-disk
).
The name of the disk snapshot you want to delete (e.g., my-disk-snapshot
).
The name of the instance to delete.
', 'DeleteInstanceSnapshotRequest$instanceSnapshotName' => 'The name of the snapshot to delete.
', 'DeleteKeyPairRequest$keyPairName' => 'The name of the key pair to delete.
', 'DeleteLoadBalancerRequest$loadBalancerName' => 'The name of the load balancer you want to delete.
', 'DeleteLoadBalancerTlsCertificateRequest$loadBalancerName' => 'The load balancer name.
', 'DeleteLoadBalancerTlsCertificateRequest$certificateName' => 'The SSL/TLS certificate name.
', 'DeleteRelationalDatabaseRequest$relationalDatabaseName' => 'The name of the database that you are deleting.
', 'DeleteRelationalDatabaseRequest$finalRelationalDatabaseSnapshotName' => 'The name of the database snapshot created if skip final snapshot
is false
, which is the default value for that parameter.
Specifying this parameter and also specifying the skip final snapshot
parameter to true
results in an error.
Constraints:
Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.
The name of the database snapshot that you are deleting.
', 'DetachDiskRequest$diskName' => 'The unique name of the disk you want to detach from your instance (e.g., my-disk
).
The name of the Lightsail load balancer.
', 'DetachStaticIpRequest$staticIpName' => 'The name of the static IP to detach from the instance.
', 'Disk$name' => 'The unique name of the disk.
', 'Disk$attachedTo' => 'The resources to which the disk is attached.
', 'DiskMap$newDiskName' => 'The new disk name (e.g., my-new-disk
).
The name of the disk snapshot (e.g., my-disk-snapshot
).
The unique name of the source disk from which the disk snapshot was created.
', 'DiskSnapshot$fromInstanceName' => 'The unique name of the source instance from which the disk (system volume) snapshot was created.
', 'Domain$name' => 'The name of the domain.
', 'ExportSnapshotRecord$name' => 'The export snapshot record name.
', 'ExportSnapshotRequest$sourceSnapshotName' => 'The name of the instance or disk snapshot to be exported to Amazon EC2.
', 'GetDiskRequest$diskName' => 'The name of the disk (e.g., my-disk
).
The name of the disk snapshot (e.g., my-disk-snapshot
).
The name of the instance to access.
', 'GetInstanceMetricDataRequest$instanceName' => 'The name of the instance for which you want to get metrics data.
', 'GetInstancePortStatesRequest$instanceName' => 'The name of the instance.
', 'GetInstanceRequest$instanceName' => 'The name of the instance.
', 'GetInstanceSnapshotRequest$instanceSnapshotName' => 'The name of the snapshot for which you are requesting information.
', 'GetInstanceStateRequest$instanceName' => 'The name of the instance to get state information about.
', 'GetKeyPairRequest$keyPairName' => 'The name of the key pair for which you are requesting information.
', 'GetLoadBalancerMetricDataRequest$loadBalancerName' => 'The name of the load balancer.
', 'GetLoadBalancerRequest$loadBalancerName' => 'The name of the load balancer.
', 'GetLoadBalancerTlsCertificatesRequest$loadBalancerName' => 'The name of the load balancer you associated with your SSL/TLS certificate.
', 'GetOperationsForResourceRequest$resourceName' => 'The name of the resource for which you are requesting information.
', 'GetRelationalDatabaseEventsRequest$relationalDatabaseName' => 'The name of the database from which to get events.
', 'GetRelationalDatabaseLogEventsRequest$relationalDatabaseName' => 'The name of your database for which to get log events.
', 'GetRelationalDatabaseLogStreamsRequest$relationalDatabaseName' => 'The name of your database for which to get log streams.
', 'GetRelationalDatabaseMasterUserPasswordRequest$relationalDatabaseName' => 'The name of your database for which to get the master user password.
', 'GetRelationalDatabaseMetricDataRequest$relationalDatabaseName' => 'The name of your database from which to get metric data.
', 'GetRelationalDatabaseParametersRequest$relationalDatabaseName' => 'The name of your database for which to get parameters.
', 'GetRelationalDatabaseRequest$relationalDatabaseName' => 'The name of the database that you are looking up.
', 'GetRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => 'The name of the database snapshot for which to get information.
', 'GetStaticIpRequest$staticIpName' => 'The name of the static IP in Lightsail.
', 'ImportKeyPairRequest$keyPairName' => 'The name of the key pair for which you want to import the public key.
', 'Instance$name' => 'The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1
).
The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair
).
The name of this Amazon Lightsail instance.
', 'InstanceEntry$sourceName' => 'The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.
Use the get export snapshot records
operation to get a list of export snapshot records that you can use to create a CloudFormation stack.
The name of the Lightsail instance for which you are requesting health check data.
', 'InstanceSnapshot$name' => 'The name of the snapshot.
', 'InstanceSnapshot$fromInstanceName' => 'The instance from which the snapshot was created.
', 'KeyPair$name' => 'The friendly name of the SSH key pair.
', 'LoadBalancer$name' => 'The name of the load balancer (e.g., my-load-balancer
).
The name of the SSL/TLS certificate (e.g., my-certificate
).
The load balancer name where your SSL/TLS certificate is attached.
', 'LoadBalancerTlsCertificateSummary$name' => 'The name of the SSL/TLS certificate.
', 'OpenInstancePublicPortsRequest$instanceName' => 'The name of the instance for which you want to open the public ports.
', 'Operation$resourceName' => 'The resource name.
', 'PasswordData$keyPairName' => 'The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair
).
If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext
. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.
The Lightsail instance name of the public port(s) you are setting.
', 'RebootInstanceRequest$instanceName' => 'The name of the instance to reboot.
', 'RebootRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to reboot.
', 'RelationalDatabase$name' => 'The unique name of the database resource in Lightsail.
', 'RelationalDatabaseEvent$resource' => 'The database that the database event relates to.
', 'RelationalDatabaseSnapshot$name' => 'The name of the database snapshot.
', 'ReleaseStaticIpRequest$staticIpName' => 'The name of the static IP to delete.
', 'ResourceNameList$member' => NULL, 'StartInstanceRequest$instanceName' => 'The name of the instance (a virtual private server) to start.
', 'StartRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to start.
', 'StaticIp$name' => 'The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE
).
The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1
).
The name of the instance (a virtual private server) to stop.
', 'StopRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to stop.
', 'StopRelationalDatabaseRequest$relationalDatabaseSnapshotName' => 'The name of your new database snapshot to be created before stopping your database.
', 'TagResourceRequest$resourceName' => 'The name of the resource to which you are adding tags.
', 'UntagResourceRequest$resourceName' => 'The name of the resource from which you are removing a tag.
', 'UpdateLoadBalancerAttributeRequest$loadBalancerName' => 'The name of the load balancer that you want to modify (e.g., my-load-balancer
.
The name of your database for which to update parameters.
', 'UpdateRelationalDatabaseRequest$relationalDatabaseName' => 'The name of your database to update.
', ], ], 'ResourceNameList' => [ 'base' => NULL, 'refs' => [ 'AttachInstancesToLoadBalancerRequest$instanceNames' => 'An array of strings representing the instance name(s) you want to attach to your load balancer.
An instance must be running
before you can attach it to your load balancer.
There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).
', 'DetachInstancesFromLoadBalancerRequest$instanceNames' => 'An array of strings containing the names of the instances you want to detach from the load balancer.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$resourceType' => 'The Lightsail resource type (e.g., CloudFormationStackRecord
).
The Lightsail resource type (e.g., Disk
).
The Lightsail resource type (e.g., DiskSnapshot
).
The resource type.
', 'ExportSnapshotRecord$resourceType' => 'The Lightsail resource type (e.g., ExportSnapshotRecord
).
The type of resource (usually Instance
).
The type of resource (usually InstanceSnapshot
).
The resource type (usually KeyPair
).
The resource type (e.g., LoadBalancer
.
The resource type (e.g., LoadBalancerTlsCertificate
).
Instance
- A Lightsail instance (a virtual private server)
StaticIp
- A static IP address
KeyPair
- The key pair used to connect to a Lightsail instance
InstanceSnapshot
- A Lightsail instance snapshot
Domain
- A DNS zone
PeeredVpc
- A peered VPC
LoadBalancer
- A Lightsail load balancer
LoadBalancerTlsCertificate
- An SSL/TLS certificate associated with a Lightsail load balancer
Disk
- A Lightsail block storage disk
DiskSnapshot
- A block storage disk snapshot
The resource type.
', 'RelationalDatabase$resourceType' => 'The Lightsail resource type for the database (for example, RelationalDatabase
).
The Lightsail resource type.
', 'StaticIp$resourceType' => 'The resource type (usually StaticIp
).
The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain 8 to 41 characters.
', 'GetRelationalDatabaseMasterUserPasswordResult$masterUserPassword' => 'The master user password for the password version
specified.
The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain 8 to 41 characters.
', ], ], 'ServiceException' => [ 'base' => 'A general service exception.
', 'refs' => [], ], 'StartInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StaticIp' => [ 'base' => 'Describes the static IP.
', 'refs' => [ 'GetStaticIpResult$staticIp' => 'An array of key-value pairs containing information about the requested static IP.
', 'StaticIpList$member' => NULL, ], ], 'StaticIpList' => [ 'base' => NULL, 'refs' => [ 'GetStaticIpsResult$staticIps' => 'An array of key-value pairs containing information about your get static IPs request.
', ], ], 'StopInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateInstancesFromSnapshotRequest$instanceNames' => 'The names for your new instances.
', 'CreateInstancesRequest$instanceNames' => 'The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
The list of active names returned by the get active names request.
', 'GetRelationalDatabaseLogStreamsResult$logStreams' => 'An object describing the result of your get relational database log streams request.
', 'LoadBalancerTlsCertificate$subjectAlternativeNames' => 'One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com
, www.example.com
, or m.example.com
.
The category that the database event belongs to.
', ], ], 'StringMax256' => [ 'base' => NULL, 'refs' => [ 'UpdateLoadBalancerAttributeRequest$attributeValue' => 'The value that you want to specify for the attribute name.
', ], ], 'Tag' => [ 'base' => 'Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag keys to delete from the specified resource.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateDiskFromSnapshotRequest$tags' => 'The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'DiskSnapshot$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'Domain$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'Instance$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'InstanceSnapshot$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'KeyPair$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'LoadBalancer$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'LoadBalancerTlsCertificate$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'RelationalDatabase$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'RelationalDatabaseSnapshot$tags' => 'The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
', 'TagResourceRequest$tags' => 'The tag key and optional value.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
', ], ], 'UnauthenticatedException' => [ 'base' => 'Lightsail throws this exception when the user has not been authenticated.
', 'refs' => [], ], 'UnpeerVpcRequest' => [ 'base' => NULL, 'refs' => [], ], 'UnpeerVpcResult' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'Blueprint$isActive' => 'A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
', 'Bundle$isActive' => 'A Boolean value indicating whether the bundle is active.
', 'CreateRelationalDatabaseFromSnapshotRequest$publiclyAccessible' => 'Specifies the accessibility options for your new database. A value of true
specifies a database that is available to resources outside of your Lightsail account. A value of false
specifies a database that is available only to your Lightsail resources in the same region as your database.
Specifies whether your database is restored from the latest backup time. A value of true
restores from the latest backup time.
Default: false
Constraints: Cannot be specified if the restore time
parameter is provided.
Specifies the accessibility options for your new database. A value of true
specifies a database that is available to resources outside of your Lightsail account. A value of false
specifies a database that is available only to your Lightsail resources in the same region as your database.
When true
, forces the deletion of an SSL/TLS certificate.
There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force
parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.
Determines whether a final database snapshot is created before your database is deleted. If true
is specified, no database snapshot is created. If false
is specified, a database snapshot is created before your database is deleted.
You must specify the final relational database snapshot name
parameter if the skip final snapshot
parameter is false
.
Default: false
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
', 'Disk$isAttached' => 'A Boolean value indicating whether the disk is attached.
', 'DiskInfo$isSystemDisk' => 'A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
', 'DomainEntry$isAlias' => 'When true
, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
A Boolean value indicating whether to include inactive results in your request.
', 'GetBundlesRequest$includeInactive' => 'A Boolean value that indicates whether to include inactive bundle results in your request.
', 'GetRegionsRequest$includeAvailabilityZones' => 'A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a
.
>A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a
).
Parameter to specify if the log should start from head or tail. If true
is specified, the log event starts from the head of the log. If false
is specified, the log event starts from the tail of the log.
Default: false
A Boolean value indicating whether this instance has a static IP assigned to it.
', 'IsVpcPeeredResult$isPeered' => 'Returns true
if the Lightsail VPC is peered; otherwise, false
.
When true
, the SSL/TLS certificate is attached to the Lightsail load balancer.
When true
, the SSL/TLS certificate is attached to the Lightsail load balancer.
A Boolean value indicating whether the operation is terminal.
', 'PendingModifiedRelationalDatabaseValues$backupRetentionEnabled' => 'A Boolean value indicating whether automated backup retention is enabled.
', 'RelationalDatabase$backupRetentionEnabled' => 'A Boolean value indicating whether automated backup retention is enabled for the database.
', 'RelationalDatabase$publiclyAccessible' => 'A Boolean value indicating whether the database is publicly accessible.
', 'RelationalDatabaseBlueprint$isEngineDefault' => 'A Boolean value indicating whether the engine version is the default for the database blueprint.
', 'RelationalDatabaseBundle$isEncrypted' => 'A Boolean value indicating whether the database bundle is encrypted.
', 'RelationalDatabaseBundle$isActive' => 'A Boolean value indicating whether the database bundle is active.
', 'RelationalDatabaseParameter$isModifiable' => 'A Boolean value indicating whether the parameter can be modified.
', 'StaticIp$isAttached' => 'A Boolean value indicating whether the static IP is attached.
', 'StopInstanceRequest$force' => 'When set to True
, forces a Lightsail instance that is stuck in a stopping
state to stop.
Only use the force
parameter if your instance is stuck in the stopping
state. In any other state, your instance should stop normally without adding this parameter to your API request.
When true
, the master user password is changed to a new strong password generated by Lightsail.
Use the get relational database master user password
operation to get the new password.
When true
, enables automated backup retention for your database.
Updates are applied during the next maintenance window because this can result in an outage.
', 'UpdateRelationalDatabaseRequest$disableBackupRetention' => 'When true
, disables automated backup retention for your database.
Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot
operation.
Updates are applied during the next maintenance window because this can result in an outage.
', 'UpdateRelationalDatabaseRequest$publiclyAccessible' => 'Specifies the accessibility options for your database. A value of true
specifies a database that is available to resources outside of your Lightsail account. A value of false
specifies a database that is available only to your Lightsail resources in the same region as your database.
When true
, applies changes immediately. When false
, applies changes during the preferred maintenance window. Some changes may cause an outage.
Default: false
The average.
', 'MetricDatapoint$maximum' => 'The maximum.
', 'MetricDatapoint$minimum' => 'The minimum.
', 'MetricDatapoint$sampleCount' => 'The sample count.
', 'MetricDatapoint$sum' => 'The sum.
', ], ], 'float' => [ 'base' => NULL, 'refs' => [ 'Bundle$price' => 'The price in US dollars (e.g., 5.0
).
The amount of RAM in GB (e.g., 2.0
).
The amount of RAM in GB on the instance (e.g., 1.0
).
The cost of the database bundle in US currency.
', 'RelationalDatabaseBundle$ramSizeInGb' => 'The amount of RAM in GB (for example, 2.0
) for the database bundle.
The amount of RAM in GB for the database.
', ], ], 'integer' => [ 'base' => NULL, 'refs' => [ 'Blueprint$minPower' => 'The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0
indicates that the blueprint runs on all instance sizes.
The number of vCPUs included in the bundle (e.g., 2
).
The size of the SSD (e.g., 30
).
A numeric value that represents the power of the bundle (e.g., 500
). You can use the bundle\'s power value in conjunction with a blueprint\'s minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.
The data transfer rate per month in GB (e.g., 2000
).
The size of the disk in GB (e.g., 32
).
The size of the disk in GB (e.g., 32
).
The size of the disk in GB.
', 'Disk$iops' => 'The input/output operations per second (IOPS) of the disk.
', 'Disk$gbInUse' => '(Deprecated) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
The size of the disk in GB (e.g., 32
).
The size of the disk in GB.
', 'DiskSnapshotInfo$sizeInGb' => 'The size of the disk in GB (e.g., 32
).
The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.
Default: 60
The minimum is 1 and the maximum is 14 days (20160 minutes).
', 'InstanceHardware$cpuCount' => 'The number of vCPUs the instance has.
', 'InstanceSnapshot$sizeInGb' => 'The size in GB of the SSD.
', 'InstanceState$code' => 'The status code for the instance.
', 'LoadBalancer$instancePort' => 'The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it\'s port 80. For HTTPS traffic, it\'s port 443.
', 'MonthlyTransfer$gbPerMonthAllocated' => 'The amount allocated per month (in GB).
', 'RelationalDatabaseBundle$diskSizeInGb' => 'The size of the disk for the database bundle.
', 'RelationalDatabaseBundle$transferPerMonthInGb' => 'The data transfer rate per month in GB for the database bundle.
', 'RelationalDatabaseBundle$cpuCount' => 'The number of virtual CPUs (vCPUs) for the database bundle.
', 'RelationalDatabaseEndpoint$port' => 'Specifies the port that the database is listening on.
', 'RelationalDatabaseHardware$cpuCount' => 'The number of vCPUs for the database.
', 'RelationalDatabaseHardware$diskSizeInGb' => 'The size of the disk for the database.
', 'RelationalDatabaseSnapshot$sizeInGb' => 'The size of the disk in GB (for example, 32
) for the database snapshot.
The description of the blueprint.
', 'Blueprint$version' => 'The version number of the operating system, application, or stack (e.g., 2016.03.0
).
The version code.
', 'Blueprint$productUrl' => 'The product URL to learn more about the image or blueprint.
', 'Blueprint$licenseUrl' => 'The end-user license agreement URL for the image or blueprint.
', 'Bundle$instanceType' => 'The Amazon EC2 instance type (e.g., t2.micro
).
A friendly name for the bundle (e.g., Micro
).
The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones
parameter to your request.
You can create a launch script that configures a server with additional user data. For example, apt-get -y update
.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum
, Debian and Ubuntu use apt-get
, and FreeBSD uses pkg
. For a complete list, see the Dev Guide.
The Availability Zone in which to create your instance. Use the following format: us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones
parameter to your request.
A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update
.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum
, Debian and Ubuntu use apt-get
, and FreeBSD uses pkg
. For a complete list, see the Dev Guide.
The path you provided to perform the load balancer health check. If you didn\'t specify a health check path, Lightsail uses the root path of your website (e.g., "/"
).
You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
', 'CreateRelationalDatabaseFromSnapshotRequest$availabilityZone' => 'The Availability Zone in which to create your new database. Use the us-east-2a
case-sensitive format.
You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include relational database Availability Zones
parameter to your request.
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the get relational database bundles
operation.
When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.
', 'CreateRelationalDatabaseRequest$availabilityZone' => 'The Availability Zone in which to create your new database. Use the us-east-2a
case-sensitive format.
You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include relational database Availability Zones
parameter to your request.
The blueprint ID for your new database. A blueprint describes the major engine version of a database.
You can get a list of database blueprints IDs by using the get relational database blueprints
operation.
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the get relational database bundles
operation.
The name of the master database created when the Lightsail database resource is created.
Constraints:
Must contain from 1 to 64 alphanumeric characters.
Cannot be a word reserved by the specified database engine
The master user name for your new database.
Constraints:
Master user name is required.
Must contain from 1 to 16 alphanumeric characters.
The first character must be a letter.
Cannot be a reserved word for the database engine you choose.
For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.
The daily time range during which automated backups are created for your new database if automated backups are enabled.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.
Constraints:
Must be in the hh24:mi-hh24:mi
format.
Example: 16:00-16:30
Specified in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur on your new database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi
format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Universal Coordinated Time (UTC).
Example: Tue:17:00-Tue:17:30
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'Disk$path' => 'The disk path.
', 'Disk$attachmentState' => '(Deprecated) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached
instead.
The disk name.
', 'DiskSnapshot$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'DiskSnapshot$progress' => 'The progress of the disk snapshot operation.
', 'Domain$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'DomainEntry$target' => 'The target AWS name server (e.g., ns-111.awsdns-22.com.
).
For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com
. Be sure to also set isAlias
to true
when setting up an A record for a load balancer.
A token used for paginating results from your get active names request.
', 'GetActiveNamesResult$nextPageToken' => 'A token used for advancing to the next page of results from your get active names request.
', 'GetBlueprintsRequest$pageToken' => 'A token used for advancing to the next page of results from your get blueprints request.
', 'GetBlueprintsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get blueprints request.
', 'GetBundlesRequest$pageToken' => 'A token used for advancing to the next page of results from your get bundles request.
', 'GetBundlesResult$nextPageToken' => 'A token used for advancing to the next page of results from your get active names request.
', 'GetCloudFormationStackRecordsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get cloud formation stack records
request.
A token used for advancing to the next page of results of your get relational database bundles request.
', 'GetDiskSnapshotsRequest$pageToken' => 'A token used for advancing to the next page of results from your GetDiskSnapshots request.
', 'GetDiskSnapshotsResult$nextPageToken' => 'A token used for advancing to the next page of results from your GetDiskSnapshots request.
', 'GetDisksRequest$pageToken' => 'A token used for advancing to the next page of results from your GetDisks request.
', 'GetDisksResult$nextPageToken' => 'A token used for advancing to the next page of results from your GetDisks request.
', 'GetDomainsRequest$pageToken' => 'A token used for advancing to the next page of results from your get domains request.
', 'GetDomainsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get active names request.
', 'GetExportSnapshotRecordsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get export snapshot records
request.
A token used for advancing to the next page of results of your get relational database bundles request.
', 'GetInstanceSnapshotsRequest$pageToken' => 'A token used for advancing to the next page of results from your get instance snapshots request.
', 'GetInstanceSnapshotsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get instance snapshots request.
', 'GetInstancesRequest$pageToken' => 'A token used for advancing to the next page of results from your get instances request.
', 'GetInstancesResult$nextPageToken' => 'A token used for advancing to the next page of results from your get instances request.
', 'GetKeyPairsRequest$pageToken' => 'A token used for advancing to the next page of results from your get key pairs request.
', 'GetKeyPairsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get key pairs request.
', 'GetLoadBalancersRequest$pageToken' => 'A token used for paginating the results from your GetLoadBalancers request.
', 'GetLoadBalancersResult$nextPageToken' => 'A token used for advancing to the next page of results from your GetLoadBalancers request.
', 'GetOperationsForResourceRequest$pageToken' => 'A token used for advancing to the next page of results from your get operations for resource request.
', 'GetOperationsForResourceResult$nextPageCount' => '(Deprecated) Returns the number of pages of results that remain.
In releases prior to June 12, 2017, this parameter returned null
by the API. It is now deprecated, and the API returns the next page token
parameter instead.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'GetOperationsRequest$pageToken' => 'A token used for advancing to the next page of results from your get operations request.
', 'GetOperationsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get operations request.
', 'GetRelationalDatabaseBlueprintsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database blueprints
request.
A token used for advancing to the next page of results of your get relational database blueprints request.
', 'GetRelationalDatabaseBundlesRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database bundles
request.
A token used for advancing to the next page of results of your get relational database bundles request.
', 'GetRelationalDatabaseEventsRequest$pageToken' => 'A token used for advancing to a specific page of results from for get relational database events request.
', 'GetRelationalDatabaseEventsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get relational database events request.
', 'GetRelationalDatabaseLogEventsRequest$logStreamName' => 'The name of the log stream.
Use the get relational database log streams
operation to get a list of available log streams.
A token used for advancing to a specific page of results for your get relational database log events
request.
A token used for advancing to the previous page of results from your get relational database log events request.
', 'GetRelationalDatabaseLogEventsResult$nextForwardToken' => 'A token used for advancing to the next page of results from your get relational database log events request.
', 'GetRelationalDatabaseParametersRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database parameters
request.
A token used for advancing to the next page of results from your get static IPs request.
', 'GetRelationalDatabaseSnapshotsRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database snapshots
request.
A token used for advancing to the next page of results from your get relational database snapshots request.
', 'GetRelationalDatabasesRequest$pageToken' => 'A token used for advancing to a specific page of results for your get relational database
request.
A token used for advancing to the next page of results from your get relational databases request.
', 'GetStaticIpsRequest$pageToken' => 'A token used for advancing to the next page of results from your get static IPs request.
', 'GetStaticIpsResult$nextPageToken' => 'A token used for advancing to the next page of results from your get static IPs request.
', 'Instance$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'InstanceAccessDetails$certKey' => 'For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub
.
For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you create an instance using any key pair other than the default (LightsailDefaultKeyPair
), password
will always be an empty string.
If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey
).
The user name to use when logging in to the Amazon Lightsail instance.
', 'InstanceEntry$userData' => 'A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update
.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum
, Debian and Ubuntu use apt-get
, and FreeBSD uses pkg
.
The Availability Zone for the new Amazon EC2 instance.
', 'InstancePortInfo$accessFrom' => 'The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)
).
The common name.
', 'InstanceSnapshot$supportCode' => 'The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'InstanceSnapshot$progress' => 'The progress of the snapshot.
', 'InstanceSnapshot$fromBlueprintId' => 'The blueprint ID from which you created the snapshot (e.g., os_debian_8_3
). A blueprint is a virtual private server (or instance) image used to create instances quickly.
The bundle ID from which you created the snapshot (e.g., micro_1_0
).
The state of the instance (e.g., running
or pending
).
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'LoadBalancer$supportCode' => 'The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.
', 'LoadBalancerConfigurationOptions$value' => NULL, 'LoadBalancerTlsCertificate$supportCode' => 'The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.
', 'LogEvent$message' => 'The message of the database log event.
', 'NotFoundException$code' => NULL, 'NotFoundException$docs' => NULL, 'NotFoundException$message' => NULL, 'NotFoundException$tip' => NULL, 'Operation$operationDetails' => 'Details about the operation (e.g., Debian-1GB-Ohio-1
).
The error code.
', 'Operation$errorDetails' => 'The error details.
', 'OperationFailureException$code' => NULL, 'OperationFailureException$docs' => NULL, 'OperationFailureException$message' => NULL, 'OperationFailureException$tip' => NULL, 'PasswordData$ciphertext' => 'The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you use the default key pair (LightsailDefaultKeyPair
), the decrypted password will be available in the password field.
If you are using a custom key pair, you need to use your own means of decryption.
If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
The password for the master user of the database.
', 'PendingModifiedRelationalDatabaseValues$engineVersion' => 'The database engine version.
', 'Region$continentCode' => 'The continent code (e.g., NA
, meaning North America).
The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada
).
The display name (e.g., Ohio
).
The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'RelationalDatabase$masterDatabaseName' => 'The name of the master database created when the Lightsail database resource is created.
', 'RelationalDatabase$secondaryAvailabilityZone' => 'Describes the secondary Availability Zone of a high availability database.
The secondary database is used for failover support of a high availability database.
', 'RelationalDatabaseBlueprint$blueprintId' => 'The ID for the database blueprint.
', 'RelationalDatabaseBlueprint$engineVersion' => 'The database engine version for the database blueprint (for example, 5.7.23
).
The description of the database engine for the database blueprint.
', 'RelationalDatabaseBlueprint$engineVersionDescription' => 'The description of the database engine version for the database blueprint.
', 'RelationalDatabaseBundle$bundleId' => 'The ID for the database bundle.
', 'RelationalDatabaseBundle$name' => 'The name for the database bundle.
', 'RelationalDatabaseEvent$message' => 'The message of the database event.
', 'RelationalDatabaseParameter$allowedValues' => 'Specifies the valid range of values for the parameter.
', 'RelationalDatabaseParameter$applyMethod' => 'Indicates when parameter updates are applied.
Can be immediate
or pending-reboot
.
Specifies the engine-specific parameter type.
', 'RelationalDatabaseParameter$dataType' => 'Specifies the valid data type for the parameter.
', 'RelationalDatabaseParameter$description' => 'Provides a description of the parameter.
', 'RelationalDatabaseParameter$parameterName' => 'Specifies the name of the parameter.
', 'RelationalDatabaseParameter$parameterValue' => 'Specifies the value of the parameter.
', 'RelationalDatabaseSnapshot$supportCode' => 'The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBundleId' => 'The bundle ID of the database from which the database snapshot was created.
', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBlueprintId' => 'The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
', 'ResourceLocation$availabilityZone' => 'The Availability Zone. Follows the format us-east-2a
(case-sensitive).
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
', 'StringList$member' => NULL, 'UnauthenticatedException$code' => NULL, 'UnauthenticatedException$docs' => NULL, 'UnauthenticatedException$message' => NULL, 'UnauthenticatedException$tip' => NULL, 'UpdateRelationalDatabaseRequest$preferredBackupWindow' => 'The daily time range during which automated backups are created for your database if automated backups are enabled.
Constraints:
Must be in the hh24:mi-hh24:mi
format.
Example: 16:00-16:30
Specified in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur on your database.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Constraints:
Must be in the ddd:hh24:mi-ddd:hh24:mi
format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Universal Coordinated Time (UTC).
Example: Tue:17:00-Tue:17:30
The start time of the time period.
', 'GetInstanceMetricDataRequest$endTime' => 'The end time of the time period.
', 'GetLoadBalancerMetricDataRequest$startTime' => 'The start time of the period.
', 'GetLoadBalancerMetricDataRequest$endTime' => 'The end time of the period.
', 'MetricDatapoint$timestamp' => 'The timestamp (e.g., 1479816991.349
).
This is the Amazon Rekognition API reference.
", "operations": { "CompareFaces": "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.
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.
Creates a collection in an AWS Region. You can add faces to the collection using the operation.
For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces
operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.
When you create a collection, it is associated with the latest version of the face model version.
Collection names are case-sensitive.
This operation requires permissions to perform the rekognition:CreateCollection
action.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input
) and a Kinesis data stream (Output
) stream. You also specify the face recognition criteria in Settings
. For example, the collection containing faces that you want to recognize. Use Name
to assign an identifier for the stream processor. You use Name
to manage the stream processor. For example, you can start processing the source video by calling with the Name
field.
After you have finished analyzing a streaming video, use to stop processing. You can delete the stream processor by calling .
", + "CreateCollection": "Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation.
For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces
operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.
When you create a collection, it is associated with the latest version of the face model version.
Collection names are case-sensitive.
This operation requires permissions to perform the rekognition:CreateCollection
action.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input
) and a Kinesis data stream (Output
) stream. You also specify the face recognition criteria in Settings
. For example, the collection containing faces that you want to recognize. Use Name
to assign an identifier for the stream processor. You use Name
to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name
field.
After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.
", "DeleteCollection": "Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.
This operation requires permissions to perform the rekognition:DeleteCollection
action.
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the rekognition:DeleteFaces
action.
Deletes the stream processor identified by Name
. You assign the value for Name
when you create the stream processor with . You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor
.
Deletes the stream processor identified by Name
. You assign the value for Name
when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor
.
Describes the specified collection. You can use DescribeCollection
to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.
For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
", - "DescribeStreamProcessor": "Provides information about a stream processor created by . You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
", + "DescribeStreamProcessor": "Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
", "DetectFaces": "Detects faces within an image that is provided as input.
DetectFaces
detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
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 to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectFaces
action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.
DetectLabels
does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.
You 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, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence
to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels
parameter to limit the number of labels returned.
If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.
DetectLabels
returns bounding boxes for instances of common object labels in an array of objects. An Instance
object contains a object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.
DetectLabels
also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectLabels
action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.
DetectLabels
does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.
You 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, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence
to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels
parameter to limit the number of labels returned.
If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.
DetectLabels
returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance
object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.
DetectLabels
also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectLabels
action.
Detects explicit or suggestive adult 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.
", - "DetectText": "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 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.
", + "DetectText": "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.
", "GetCelebrityInfo": "Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo
action.
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to which returns a job identifier (JobId
). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
GetCelebrityRecognition
returns detected celebrities and the time(s) they are detected in an array (Celebrities
) of objects. Each CelebrityRecognition
contains information about the celebrity in a object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID
in the SortBy
input parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetCelebrityRecognition
.
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . which returns a job identifier (JobId
). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration
. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels
, of objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME
for the SortBy
input parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the number of labels returned in a single call to GetContentModeration
. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration
and populate the NextToken
request parameter with the value of NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
", - "GetFaceDetection": "Gets face detection results for a Amazon Rekognition Video analysis started by .
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling which returns a job identifier (JobId
). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
GetFaceDetection
returns an array of detected faces (Faces
) sorted by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetFaceDetection
.
Gets the face search results for Amazon Rekognition Video face search started by . The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.
Face search in a video is an asynchronous operation. You start face search by calling to which returns a job identifier (JobId
). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceSearch
and pass the job identifier (JobId
) from the initial call to StartFaceSearch
.
For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
The search results are retured in an array, Persons
, of objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
Gets the label detection results of a Amazon Rekognition Video analysis started by .
The label detection operation is started by a call to which returns a job identifier (JobId
). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection
. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME
for the SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetLabelDetection
.
GetLabelDetection
doesn't return a hierarchical taxonomy, or bounding box information, for detected labels. GetLabelDetection
returns null
for the Parents
and Instances
attributes of the object which is returned in the Labels
array.
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
The person path tracking operation is started by a call to StartPersonTracking
which returns a job identifier (JobId
). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking
.
To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
GetPersonTracking
returns an array, Persons
, of tracked persons and the time(s) their paths were tracked in the video.
GetPersonTracking
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX
for the SortBy
input parameter.
Use the MaxResults
parameter to limit the number of items returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking
and populate the NextToken
request parameter with the token value returned from the previous call to GetPersonTracking
.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the and operations.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
To get the number of faces in a collection, call .
If you're using version 1.0 of the face detection model, IndexFaces
indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection
field.
To determine which version of the model you're using, call and supply the collection ID. You can also get the model version from the value of FaceModelVersion
in the response from IndexFaces
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageID
for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces
input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter
input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces
filters detected faces. You can also explicitly filter detected faces by specifying AUTO
for the value of QualityFilter
. If you do not want to filter detected faces, specify NONE
.
To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call .
Information about faces detected in an image, but not indexed, is returned in an array of objects, UnindexedFaces
. Faces aren't indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces
request parameter.
The face is too small compared to the image dimensions.
The face is too blurry.
The image is too dark.
The face has an extreme pose.
In response, the IndexFaces
operation returns an array of metadata for all detected faces, FaceRecords
. This includes:
The bounding box, BoundingBox
, of the detected face.
A confidence value, Confidence
, which indicates the confidence that the bounding box contains a face.
A face ID, faceId
, assigned by the service for each face that's detected and stored.
An image ID, ImageId
, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes
parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces
operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed 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 isn't supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces
action.
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId
). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
GetCelebrityRecognition
returns detected celebrities and the time(s) they are detected in an array (Celebrities
) of CelebrityRecognition objects. Each CelebrityRecognition
contains information about the celebrity in a CelebrityDetail object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID
in the SortBy
input parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetCelebrityRecognition
.
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration. which returns a job identifier (JobId
). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration
. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels
, of ContentModerationDetection objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME
for the SortBy
input parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the number of labels returned in a single call to GetContentModeration
. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration
and populate the NextToken
request parameter with the value of NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
", + "GetFaceDetection": "Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId
). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceDetection and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
GetFaceDetection
returns an array of detected faces (Faces
) sorted by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetFaceDetection
.
Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.
Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId
). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceSearch
and pass the job identifier (JobId
) from the initial call to StartFaceSearch
.
For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
The search results are retured in an array, Persons
, of PersonMatch objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId
). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection
. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetLabelDetection and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME
for the SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetLabelDetection
.
Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
The person path tracking operation is started by a call to StartPersonTracking
which returns a job identifier (JobId
). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking
.
To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetPersonTracking and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
GetPersonTracking
returns an array, Persons
, of tracked persons and the time(s) their paths were tracked in the video.
GetPersonTracking
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX
for the SortBy
input parameter.
Use the MaxResults
parameter to limit the number of items returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking
and populate the NextToken
request parameter with the token value returned from the previous call to GetPersonTracking
.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
To get the number of faces in a collection, call DescribeCollection.
If you're using version 1.0 of the face detection model, IndexFaces
indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection
field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion
in the response from IndexFaces
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageID
for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces
input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter
input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces
filters detected faces. You can also explicitly filter detected faces by specifying AUTO
for the value of QualityFilter
. If you do not want to filter detected faces, specify NONE
.
To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call DescribeCollection.
Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces
. Faces aren't indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces
request parameter.
The face is too small compared to the image dimensions.
The face is too blurry.
The image is too dark.
The face has an extreme pose.
In response, the IndexFaces
operation returns an array of metadata for all detected faces, FaceRecords
. This includes:
The bounding box, BoundingBox
, of the detected face.
A confidence value, Confidence
, which indicates the confidence that the bounding box contains a face.
A face ID, faceId
, assigned by the service for each face that's detected and stored.
An image ID, ImageId
, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes
parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces
operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed 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 isn't supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces
action.
Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces
action.
Gets a list of stream processors that you have created with .
", - "RecognizeCelebrities": "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 100 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 100 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 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.
Gets a list of stream processors that you have created with CreateStreamProcessor.
", + "RecognizeCelebrities": "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 100 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 100 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.
For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.
You can also search faces without indexing faces by using the SearchFacesByImage
operation.
The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence
value for each face match, indicating the confidence that the specific face matches the input face.
For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFaces
action.
For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.
To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation.
You can also call the DetectFaces
operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage
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.
The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity
indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFacesByImage
action.
Starts asynchronous recognition of celebrities in a stored video.
Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition
returns a job identifier (JobId
) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartCelebrityRecognition
.
For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
", - "StartContentModeration": "Starts asynchronous detection of explicit or suggestive adult content in a stored video.
Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration
returns a job identifier (JobId
) which you use to get the results of the analysis. When content moderation analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
", - "StartFaceDetection": "Starts asynchronous detection of faces in a stored video.
Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection
returns a job identifier (JobId
) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.
", - "StartFaceSearch": "Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch
returns a job identifier (JobId
) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartFaceSearch
. For more information, see procedure-person-search-videos.
Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
Starts the asynchronous tracking of a person's path in a stored video.
Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
Starts processing a stream processor. You create a stream processor by calling . To tell StartStreamProcessor
which stream processor to start, use the value of the Name
field specified in the call to CreateStreamProcessor
.
Stops a running stream processor that was created by .
" + "SearchFacesByImage": "For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.
To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation.
You can also call the DetectFaces
operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage
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.
The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity
indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFacesByImage
action.
Starts asynchronous recognition of celebrities in a stored video.
Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition
returns a job identifier (JobId
) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityRecognition and pass the job identifier (JobId
) from the initial call to StartCelebrityRecognition
.
For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
", + "StartContentModeration": "Starts asynchronous detection of explicit or suggestive adult content in a stored video.
Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration
returns a job identifier (JobId
) which you use to get the results of the analysis. When content moderation analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetContentModeration and pass the job identifier (JobId
) from the initial call to StartContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
", + "StartFaceDetection": "Starts asynchronous detection of faces in a stored video.
Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection
returns a job identifier (JobId
) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceDetection and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.
", + "StartFaceSearch": "Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch
returns a job identifier (JobId
) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceSearch and pass the job identifier (JobId
) from the initial call to StartFaceSearch
. For more information, see procedure-person-search-videos.
Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetLabelDetection and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
Starts the asynchronous tracking of a person's path in a stored video.
Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetPersonTracking and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor
which stream processor to start, use the value of the Name
field specified in the call to CreateStreamProcessor
.
Stops a running stream processor that was created by CreateStreamProcessor.
" }, "shapes": { "AccessDeniedException": { @@ -95,7 +95,7 @@ } }, "Celebrity": { - "base": "Provides information about a celebrity recognized by the operation.
", + "base": "Provides information about a celebrity recognized by the RecognizeCelebrities operation.
", "refs": { "CelebrityList$member": null } @@ -408,7 +408,7 @@ } }, "FaceDetail": { - "base": "Structure containing attributes of the face that the algorithm detected.
A FaceDetail
object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
.
is the only Amazon Rekognition Video stored video operation that can return a FaceDetail
object with all attributes. To specify which attributes to return, use the FaceAttributes
input parameter for . The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes
input parameter.
GetCelebrityRecognition
GetPersonTracking
GetFaceSearch
The Amazon Rekognition Image and operations can return all facial attributes. To specify which attributes to return, use the Attributes
input parameter for DetectFaces
. For IndexFaces
, use the DetectAttributes
input parameter.
Structure containing attributes of the face that the algorithm detected.
A FaceDetail
object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
.
GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a FaceDetail
object with all attributes. To specify which attributes to return, use the FaceAttributes
input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes
input parameter.
GetCelebrityRecognition
GetPersonTracking
GetFaceSearch
The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the Attributes
input parameter for DetectFaces
. For IndexFaces
, use the DetectAttributes
input parameter.
Face details for the recognized celebrity.
", "FaceDetailList$member": null, @@ -491,7 +491,7 @@ } }, "FaceSearchSettings": { - "base": "Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings
is a request parameter for .
Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings
is a request parameter for CreateStreamProcessor.
Face search settings to use on a streaming video.
" } @@ -531,7 +531,7 @@ } }, "Geometry": { - "base": "Information about where the text detected by is located on an image.
", + "base": "Information about where the text detected by DetectText is located on an image.
", "refs": { "TextDetection$Geometry": "The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
" } @@ -660,7 +660,7 @@ } }, "Instance": { - "base": "An instance of a label detected by .
", + "base": "An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).
", "refs": { "Instances$member": null } @@ -668,7 +668,7 @@ "Instances": { "base": null, "refs": { - "Label$Instances": "If Label
represents an object, Instances
contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances
is returned as null
by GetLabelDetection
.
If Label
represents an object, Instances
contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
Structure containing details about the detected label, including the name, and level of confidence.
The Amazon Rekognition Image operation operation returns a hierarchical taxonomy (Parents
) for detected labels and also bounding box information (Instances
) for detected labels. Amazon Rekognition Video doesn't return this information and returns null
for the Parents
and Instances
attributes.
Structure containing details about the detected label, including the name, detected instances, parent labels, and level of confidence.
", "refs": { "LabelDetection$Label": "
Details about the detected label.
", "Labels$member": null @@ -901,7 +901,7 @@ "CompareFacesResponse$TargetImageOrientationCorrection": "The value of TargetImageOrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
", "DetectFacesResponse$OrientationCorrection": "The value of OrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
", "DetectLabelsResponse$OrientationCorrection": "The value of OrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
", - "IndexFacesResponse$OrientationCorrection": "If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection
is always null and no orientation information is returned.
If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection
is null.
If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
Bounding box information is returned in the FaceRecords
array. You can get the version of the face detection model by calling .
If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection
is always null and no orientation information is returned.
If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection
is null.
If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
Bounding box information is returned in the FaceRecords
array. You can get the version of the face detection model by calling DescribeCollection.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces
and UnrecognizedFaces
represent face locations before the image orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection
is null. The CelebrityFaces
and UnrecognizedFaces
bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
The parent labels for a label. The response includes all ancestor labels.
Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents
is returned as null
by GetLabelDetection
.
The parent labels for a label. The response includes all ancestor labels.
" } }, "Percent": { @@ -956,7 +956,7 @@ "CompareFacesRequest$SimilarityThreshold": "The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches
array.
Level of confidence that what the bounding box contains is a face.
", "ComparedSourceImageFace$Confidence": "Confidence level that the selected bounding box contains a face.
", - "DetectLabelsRequest$MinConfidence": "Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.
If MinConfidence
is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.
If MinConfidence
is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.
If you don't specify MinConfidence
, the operation returns labels with confidence values greater than or equal to 50 percent.
Level of confidence in the determination.
", "EyeOpen$Confidence": "Level of confidence in the determination.
", @@ -966,7 +966,7 @@ "FaceMatch$Similarity": "Confidence in the match of this face with the input face.
", "FaceSearchSettings$FaceMatchThreshold": "Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.
", "Gender$Confidence": "Level of confidence in the determination.
", - "Instance$Confidence": "The confidence that Amazon Rekognition Image has in the accuracy of the bounding box.
", + "Instance$Confidence": "The confidence that Amazon Rekognition has in the accuracy of the bounding box.
", "Label$Confidence": "Level of confidence.
", "ModerationLabel$Confidence": "Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.
If you don't specify the MinConfidence
parameter in the call to DetectModerationLabels
, the operation returns labels with a confidence value greater than or equal to 50 percent.
Level of confidence in the determination.
", @@ -990,7 +990,7 @@ } }, "PersonDetection": { - "base": "Details and path tracking information for a single time a person's path is tracked in a video. Amazon Rekognition operations that track people's paths return an array of PersonDetection
objects with elements for each time a person's path is tracked in a video.
For more information, see API_GetPersonTracking in the Amazon Rekognition Developer Guide.
", + "base": "Details and path tracking information for a single time a person's path is tracked in a video. Amazon Rekognition operations that track people's paths return an array of PersonDetection
objects with elements for each time a person's path is tracked in a video.
For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.
", "refs": { "PersonDetections$member": null } @@ -1008,7 +1008,7 @@ } }, "PersonMatch": { - "base": "Information about a person whose face matches a face(s) in an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch
objects is returned by .
Information about a person whose face matches a face(s) in an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch
objects is returned by GetFaceSearch.
An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch
. Each Persons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.
An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch
. Each Persons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.
The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.
An array of Point
objects, Polygon
, is returned by . Polygon
represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Rekognition Developer Guide.
The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.
An array of Point
objects, Polygon
, is returned by DetectText. Polygon
represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Rekognition Developer Guide.
A unique identifier for the celebrity.
", "CelebrityDetail$Id": "The unique identifier for the celebrity.
", - "GetCelebrityInfoRequest$Id": "The ID for the celebrity. You get the celebrity ID from a call to the operation, which recognizes celebrities in an image.
" + "GetCelebrityInfoRequest$Id": "The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.
" } }, "ResourceAlreadyExistsException": { @@ -1257,7 +1257,7 @@ } }, "StreamProcessor": { - "base": "An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to . The request parameters for CreateStreamProcessor
describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.
An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor
describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.
An identifier you assign to the stream processor. You can use Name
to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name
is idempotent.
An identifier you assign to the stream processor. You can use Name
to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name
is idempotent.
The name of the stream processor you want to delete.
", "DescribeStreamProcessorRequest$Name": "Name of the stream processor for which you want information.
", "DescribeStreamProcessorResponse$Name": "Name of the stream processor.
", "StartStreamProcessorRequest$Name": "The name of the stream processor to start processing.
", - "StopStreamProcessorRequest$Name": "The name of a stream processor created by .
", + "StopStreamProcessorRequest$Name": "The name of a stream processor created by CreateStreamProcessor.
", "StreamProcessor$Name": "Name of the Amazon Rekognition stream processor.
" } }, @@ -1326,8 +1326,10 @@ "DescribeCollectionResponse$CollectionARN": "The Amazon Resource Name (ARN) of the collection.
", "DescribeStreamProcessorResponse$StatusMessage": "Detailed status message about the stream processor.
", "DetectLabelsResponse$LabelModelVersion": "Version number of the label detection model that was used to detect labels.
", + "DetectModerationLabelsResponse$ModerationModelVersion": "Version number of the moderation detection model that was used to detect unsafe content.
", "FaceModelVersionList$member": null, "GetCelebrityInfoResponse$Name": "The name of the celebrity.
", + "GetLabelDetectionResponse$LabelModelVersion": "Version number of the label detection model that was used to detect labels.
", "IndexFacesResponse$FaceModelVersion": "The version number of the face detection model that's associated with the input collection (CollectionId
).
The name (label) of the object or scene.
", "ListFacesResponse$NextToken": "If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
", @@ -1349,7 +1351,7 @@ } }, "TextDetection": { - "base": "Information about a word or line of text detected by .
The DetectedText
field contains the text that Amazon Rekognition detected in the image.
Every word and line has an identifier (Id
). Each word belongs to a line and has a parent identifier (ParentId
) that identifies the line of text in which the word appears. The word Id
is also an index for the word within a line of words.
For more information, see Detecting Text in the Amazon Rekognition Developer Guide.
", + "base": "Information about a word or line of text detected by DetectText.
The DetectedText
field contains the text that Amazon Rekognition detected in the image.
Every word and line has an identifier (Id
). Each word belongs to a line and has a parent identifier (ParentId
) that identifies the line of text in which the word appears. The word Id
is also an index for the word within a line of words.
For more information, see Detecting Text in the Amazon Rekognition Developer Guide.
", "refs": { "TextDetectionList$member": null } @@ -1397,14 +1399,14 @@ "ULong": { "base": null, "refs": { - "DescribeCollectionResponse$FaceCount": "The number of faces that are indexed into the collection. To index faces into a collection, use .
", + "DescribeCollectionResponse$FaceCount": "The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
", "VideoMetadata$DurationMillis": "Length of the video in milliseconds.
", "VideoMetadata$FrameHeight": "Vertical pixel dimension of the video.
", "VideoMetadata$FrameWidth": "Horizontal pixel dimension of the video.
" } }, "UnindexedFace": { - "base": "A face that detected, but didn't index. Use the Reasons
response attribute to determine why a face wasn't indexed.
A face that IndexFaces detected, but didn't index. Use the Reasons
response attribute to determine why a face wasn't indexed.
Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as use Video
to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video
to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
", "StartContentModerationRequest$Video": "The video in which you want to moderate content. The video must be stored in an Amazon S3 bucket.
", diff --git a/src/data/rekognition/2016-06-27/docs-2.json.php b/src/data/rekognition/2016-06-27/docs-2.json.php index 23f88bdbc8..bccf521d5f 100644 --- a/src/data/rekognition/2016-06-27/docs-2.json.php +++ b/src/data/rekognition/2016-06-27/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'This is the Amazon Rekognition API reference.
', 'operations' => [ 'CompareFaces' => '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.
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.
Creates a collection in an AWS Region. You can add faces to the collection using the operation.
For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces
operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.
When you create a collection, it is associated with the latest version of the face model version.
Collection names are case-sensitive.
This operation requires permissions to perform the rekognition:CreateCollection
action.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input
) and a Kinesis data stream (Output
) stream. You also specify the face recognition criteria in Settings
. For example, the collection containing faces that you want to recognize. Use Name
to assign an identifier for the stream processor. You use Name
to manage the stream processor. For example, you can start processing the source video by calling with the Name
field.
After you have finished analyzing a streaming video, use to stop processing. You can delete the stream processor by calling .
', 'DeleteCollection' => 'Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.
This operation requires permissions to perform the rekognition:DeleteCollection
action.
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the rekognition:DeleteFaces
action.
Deletes the stream processor identified by Name
. You assign the value for Name
when you create the stream processor with . You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor
.
Describes the specified collection. You can use DescribeCollection
to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.
For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
', 'DescribeStreamProcessor' => 'Provides information about a stream processor created by . You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
', 'DetectFaces' => 'Detects faces within an image that is provided as input.
DetectFaces
detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
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 to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectFaces
action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.
DetectLabels
does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.
You 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, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence
to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels
parameter to limit the number of labels returned.
If the object detected is a person, the operation doesn\'t provide the same facial details that the DetectFaces operation provides.
DetectLabels
returns bounding boxes for instances of common object labels in an array of objects. An Instance
object contains a object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.
DetectLabels
also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectLabels
action.
Detects explicit or suggestive adult 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.
', 'DetectText' => '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 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.
', 'GetCelebrityInfo' => 'Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo
action.
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by .
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to which returns a job identifier (JobId
). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
GetCelebrityRecognition
returns detected celebrities and the time(s) they are detected in an array (Celebrities
) of objects. Each CelebrityRecognition
contains information about the celebrity in a object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID
in the SortBy
input parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you don\'t store the additional information urls, you can get them later by calling with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetCelebrityRecognition
.
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by .
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling . which returns a job identifier (JobId
). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration
. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels
, of objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME
for the SortBy
input parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the number of labels returned in a single call to GetContentModeration
. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration
and populate the NextToken
request parameter with the value of NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
', 'GetFaceDetection' => 'Gets face detection results for a Amazon Rekognition Video analysis started by .
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling which returns a job identifier (JobId
). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
GetFaceDetection
returns an array of detected faces (Faces
) sorted by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetFaceDetection
.
Gets the face search results for Amazon Rekognition Video face search started by . The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.
Face search in a video is an asynchronous operation. You start face search by calling to which returns a job identifier (JobId
). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceSearch
and pass the job identifier (JobId
) from the initial call to StartFaceSearch
.
For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
The search results are retured in an array, Persons
, of objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
Gets the label detection results of a Amazon Rekognition Video analysis started by .
The label detection operation is started by a call to which returns a job identifier (JobId
). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection
. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME
for the SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetLabelDetection
.
GetLabelDetection
doesn\'t return a hierarchical taxonomy, or bounding box information, for detected labels. GetLabelDetection
returns null
for the Parents
and Instances
attributes of the object which is returned in the Labels
array.
Gets the path tracking results of a Amazon Rekognition Video analysis started by .
The person path tracking operation is started by a call to StartPersonTracking
which returns a job identifier (JobId
). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking
.
To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
GetPersonTracking
returns an array, Persons
, of tracked persons and the time(s) their paths were tracked in the video.
GetPersonTracking
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the array is sorted by the time(s) a person\'s path is tracked in the video. You can sort by tracked persons by specifying INDEX
for the SortBy
input parameter.
Use the MaxResults
parameter to limit the number of items returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking
and populate the NextToken
request parameter with the token value returned from the previous call to GetPersonTracking
.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn\'t save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the and operations.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
To get the number of faces in a collection, call .
If you\'re using version 1.0 of the face detection model, IndexFaces
indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.
If you\'re using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection
field.
To determine which version of the model you\'re using, call and supply the collection ID. You can also get the model version from the value of FaceModelVersion
in the response from IndexFaces
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageID
for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces
input parameter. This is useful when you want to index the largest faces in an image and don\'t want to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter
input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces
filters detected faces. You can also explicitly filter detected faces by specifying AUTO
for the value of QualityFilter
. If you do not want to filter detected faces, specify NONE
.
To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call .
Information about faces detected in an image, but not indexed, is returned in an array of objects, UnindexedFaces
. Faces aren\'t indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces
request parameter.
The face is too small compared to the image dimensions.
The face is too blurry.
The image is too dark.
The face has an extreme pose.
In response, the IndexFaces
operation returns an array of metadata for all detected faces, FaceRecords
. This includes:
The bounding box, BoundingBox
, of the detected face.
A confidence value, Confidence
, which indicates the confidence that the bounding box contains a face.
A face ID, faceId
, assigned by the service for each face that\'s detected and stored.
An image ID, ImageId
, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes
parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces
operation, Amazon Rekognition doesn\'t save duplicate face metadata.
The input image is passed 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 isn\'t supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces
action.
Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces
action.
Gets a list of stream processors that you have created with .
', 'RecognizeCelebrities' => '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 100 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 100 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 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.
For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.
You can also search faces without indexing faces by using the SearchFacesByImage
operation.
The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence
value for each face match, indicating the confidence that the specific face matches the input face.
For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFaces
action.
For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.
To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation.
You can also call the DetectFaces
operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage
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.
The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity
indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFacesByImage
action.
Starts asynchronous recognition of celebrities in a stored video.
Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition
returns a job identifier (JobId
) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartCelebrityRecognition
.
For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
', 'StartContentModeration' => 'Starts asynchronous detection of explicit or suggestive adult content in a stored video.
Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration
returns a job identifier (JobId
) which you use to get the results of the analysis. When content moderation analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
', 'StartFaceDetection' => 'Starts asynchronous detection of faces in a stored video.
Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection
returns a job identifier (JobId
) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.
', 'StartFaceSearch' => 'Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch
returns a job identifier (JobId
) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartFaceSearch
. For more information, see procedure-person-search-videos.
Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
Starts the asynchronous tracking of a person\'s path in a stored video.
Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
Starts processing a stream processor. You create a stream processor by calling . To tell StartStreamProcessor
which stream processor to start, use the value of the Name
field specified in the call to CreateStreamProcessor
.
Stops a running stream processor that was created by .
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You are not authorized to perform the action.
', 'refs' => [], ], 'AgeRange' => [ 'base' => 'Structure containing the estimated age range, in years, for a face.
Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the face of a 6-year-old might have an estimated range of 4-8.
', 'refs' => [ 'FaceDetail$AgeRange' => 'The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
', ], ], 'Attribute' => [ 'base' => NULL, 'refs' => [ 'Attributes$member' => NULL, ], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'DetectFacesRequest$Attributes' => 'An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don\'t specify a value for Attributes
or if you specify ["DEFAULT"]
, the API returns the following subset of facial attributes: BoundingBox
, Confidence
, Pose
, Quality
, and Landmarks
. If you provide ["ALL"]
, all facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"]
, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don\'t specify a value for Attributes
or if you specify ["DEFAULT"]
, the API returns the following subset of facial attributes: BoundingBox
, Confidence
, Pose
, Quality
, and Landmarks
. If you provide ["ALL"]
, all facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"]
, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
Indicates whether or not the face has a beard, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Beard' => 'Indicates whether or not the face has a beard, and the confidence level in the determination.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'Beard$Value' => 'Boolean value that indicates whether the face has beard or not.
', 'EyeOpen$Value' => 'Boolean value that indicates whether the eyes on the face are open.
', 'Eyeglasses$Value' => 'Boolean value that indicates whether the face is wearing eye glasses or not.
', 'MouthOpen$Value' => 'Boolean value that indicates whether the mouth on the face is open or not.
', 'Mustache$Value' => 'Boolean value that indicates whether the face has mustache or not.
', 'Smile$Value' => 'Boolean value that indicates whether the face is smiling or not.
', 'Sunglasses$Value' => 'Boolean value that indicates whether the face is wearing sunglasses or not.
', ], ], 'BoundingBox' => [ 'base' => 'Identifies the bounding box around the label, face, or text. The left
(x-coordinate) and top
(y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
The top
and left
values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left
value of 0.5 (350/700) and a top
value of 0.25 (50/200).
The width
and height
values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left
or top
values.
Bounding box around the body of a celebrity.
', 'ComparedFace$BoundingBox' => 'Bounding box of the face.
', 'ComparedSourceImageFace$BoundingBox' => 'Bounding box of the face.
', 'Face$BoundingBox' => 'Bounding box of the face.
', 'FaceDetail$BoundingBox' => 'Bounding box of the face. Default attribute.
', 'Geometry$BoundingBox' => 'An axis-aligned coarse representation of the detected text\'s location on the image.
', 'Instance$BoundingBox' => 'The position of the label instance on the image.
', 'PersonDetail$BoundingBox' => 'Bounding box around the detected person.
', 'SearchFacesByImageResponse$SearchedFaceBoundingBox' => 'The bounding box around the face in the input image that Amazon Rekognition used for the search.
', ], ], 'Celebrity' => [ 'base' => 'Provides information about a celebrity recognized by the operation.
', 'refs' => [ 'CelebrityList$member' => NULL, ], ], 'CelebrityDetail' => [ 'base' => 'Information about a recognized celebrity.
', 'refs' => [ 'CelebrityRecognition$Celebrity' => 'Information about a recognized celebrity.
', ], ], 'CelebrityList' => [ 'base' => NULL, 'refs' => [ 'RecognizeCelebritiesResponse$CelebrityFaces' => 'Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.
', ], ], 'CelebrityRecognition' => [ 'base' => 'Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see GetCelebrityRecognition in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'CelebrityRecognitions$member' => NULL, ], ], 'CelebrityRecognitionSortBy' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionRequest$SortBy' => 'Sort to use for celebrities returned in Celebrities
field. Specify ID
to sort by the celebrity identifier, specify TIMESTAMP
to sort by the time the celebrity was recognized.
Array of celebrities recognized in the video.
', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'StartCelebrityRecognitionRequest$ClientRequestToken' => 'Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartContentModeration
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
ID for the collection that you are creating.
', 'DeleteCollectionRequest$CollectionId' => 'ID of the collection to delete.
', 'DeleteFacesRequest$CollectionId' => 'Collection from which to remove the specific faces.
', 'DescribeCollectionRequest$CollectionId' => 'The ID of the collection to describe.
', 'FaceSearchSettings$CollectionId' => 'The ID of a collection that contains faces that you want to search for.
', 'IndexFacesRequest$CollectionId' => 'The ID of an existing collection to which you want to add the faces that are detected in the input images.
', 'ListFacesRequest$CollectionId' => 'ID of the collection from which to list the faces.
', 'SearchFacesByImageRequest$CollectionId' => 'ID of the collection to search.
', 'SearchFacesRequest$CollectionId' => 'ID of the collection the face belongs to.
', 'StartFaceSearchRequest$CollectionId' => 'ID of the collection that contains the faces you want to search for.
', ], ], 'CollectionIdList' => [ 'base' => NULL, 'refs' => [ 'ListCollectionsResponse$CollectionIds' => 'An array of collection IDs.
', ], ], 'CompareFacesMatch' => [ 'base' => 'Provides information about a face in a target image that matches the source image face analyzed by CompareFaces
. The Face
property contains the bounding box of the face in the target image. The Similarity
property is the confidence that the source image face matches the face in the bounding box.
An array of faces in the target image that match the source image face. Each CompareFacesMatch
object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.
An array of faces in the target image that did not match the source image face.
', ], ], 'ComparedFace' => [ 'base' => 'Provides face metadata for target image faces that are analyzed by CompareFaces
and RecognizeCelebrities
.
Provides information about the celebrity\'s face, such as its location on the image.
', 'CompareFacesMatch$Face' => 'Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
', 'CompareFacesUnmatchList$member' => NULL, 'ComparedFaceList$member' => NULL, ], ], 'ComparedFaceList' => [ 'base' => NULL, 'refs' => [ 'RecognizeCelebritiesResponse$UnrecognizedFaces' => 'Details about each unrecognized face in the image.
', ], ], 'ComparedSourceImageFace' => [ 'base' => 'Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.
', 'refs' => [ 'CompareFacesResponse$SourceImageFace' => 'The face in the source image that was used for comparison.
', ], ], 'ContentModerationDetection' => [ 'base' => 'Information about a moderation label detection in a stored video.
', 'refs' => [ 'ContentModerationDetections$member' => NULL, ], ], 'ContentModerationDetections' => [ 'base' => NULL, 'refs' => [ 'GetContentModerationResponse$ModerationLabels' => 'The detected moderation labels and the time(s) they were detected.
', ], ], 'ContentModerationSortBy' => [ 'base' => NULL, 'refs' => [ 'GetContentModerationRequest$SortBy' => 'Sort to use for elements in the ModerationLabelDetections
array. Use TIMESTAMP
to sort array elements by the time labels are detected. Use NAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP
.
The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
', 'DescribeStreamProcessorResponse$CreationTimestamp' => 'Date and time the stream processor was created
', 'DescribeStreamProcessorResponse$LastUpdateTimestamp' => 'The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.
', ], ], 'Degree' => [ 'base' => NULL, 'refs' => [ 'Pose$Roll' => 'Value representing the face rotation on the roll axis.
', 'Pose$Yaw' => 'Value representing the face rotation on the yaw axis.
', 'Pose$Pitch' => 'Value representing the face rotation on the pitch axis.
', ], ], 'DeleteCollectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCollectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStreamProcessorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStreamProcessorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCollectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCollectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStreamProcessorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStreamProcessorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectLabelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectLabelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectModerationLabelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectModerationLabelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectTextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectTextResponse' => [ 'base' => NULL, 'refs' => [], ], 'Emotion' => [ 'base' => 'The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.
', 'refs' => [ 'Emotions$member' => NULL, ], ], 'EmotionName' => [ 'base' => NULL, 'refs' => [ 'Emotion$Type' => 'Type of emotion detected.
', ], ], 'Emotions' => [ 'base' => NULL, 'refs' => [ 'FaceDetail$Emotions' => 'The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.
', ], ], 'ExternalImageId' => [ 'base' => NULL, 'refs' => [ 'Face$ExternalImageId' => 'Identifier that you assign to all the faces in the input image.
', 'IndexFacesRequest$ExternalImageId' => 'The ID you want to assign to all the faces detected in the image.
', ], ], 'EyeOpen' => [ 'base' => 'Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$EyesOpen' => 'Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
', ], ], 'Eyeglasses' => [ 'base' => 'Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Eyeglasses' => 'Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
', ], ], 'Face' => [ 'base' => 'Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
', 'refs' => [ 'FaceList$member' => NULL, 'FaceMatch$Face' => 'Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.
', 'FaceRecord$Face' => 'Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
', ], ], 'FaceAttributes' => [ 'base' => NULL, 'refs' => [ 'StartFaceDetectionRequest$FaceAttributes' => 'The face attributes you want returned.
DEFAULT
- The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.
ALL
- All facial attributes are returned.
Structure containing attributes of the face that the algorithm detected.
A FaceDetail
object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
.
is the only Amazon Rekognition Video stored video operation that can return a FaceDetail
object with all attributes. To specify which attributes to return, use the FaceAttributes
input parameter for . The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don\'t have a FaceAttributes
input parameter.
GetCelebrityRecognition
GetPersonTracking
GetFaceSearch
The Amazon Rekognition Image and operations can return all facial attributes. To specify which attributes to return, use the Attributes
input parameter for DetectFaces
. For IndexFaces
, use the DetectAttributes
input parameter.
Face details for the recognized celebrity.
', 'FaceDetailList$member' => NULL, 'FaceDetection$Face' => 'The face properties for the detected face.
', 'FaceRecord$FaceDetail' => 'Structure containing attributes of the face that the algorithm detected.
', 'PersonDetail$Face' => 'Face details for the detected person.
', 'UnindexedFace$FaceDetail' => 'The structure that contains attributes of a face that IndexFaces
detected, but didn\'t index.
Details of each face found in the image.
', ], ], 'FaceDetection' => [ 'base' => 'Information about a face detected in a video analysis request and the time the face was detected in the video.
', 'refs' => [ 'FaceDetections$member' => NULL, ], ], 'FaceDetections' => [ 'base' => NULL, 'refs' => [ 'GetFaceDetectionResponse$Faces' => 'An array of faces detected in the video. Each element contains a detected face\'s details and the time, in milliseconds from the start of the video, the face was detected.
', ], ], 'FaceId' => [ 'base' => NULL, 'refs' => [ 'Face$FaceId' => 'Unique identifier that Amazon Rekognition assigns to the face.
', 'FaceIdList$member' => NULL, 'SearchFacesRequest$FaceId' => 'ID of a face to find matches for in the collection.
', 'SearchFacesResponse$SearchedFaceId' => 'ID of the face that was searched for matches in a collection.
', ], ], 'FaceIdList' => [ 'base' => NULL, 'refs' => [ 'DeleteFacesRequest$FaceIds' => 'An array of face IDs to delete.
', 'DeleteFacesResponse$DeletedFaces' => 'An array of strings (face IDs) of the faces that were deleted.
', ], ], 'FaceList' => [ 'base' => NULL, 'refs' => [ 'ListFacesResponse$Faces' => 'An array of Face
objects.
Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.
', 'refs' => [ 'FaceMatchList$member' => NULL, ], ], 'FaceMatchList' => [ 'base' => NULL, 'refs' => [ 'PersonMatch$FaceMatches' => 'Information about the faces in the input collection that match the face of a person in the video.
', 'SearchFacesByImageResponse$FaceMatches' => 'An array of faces that match the input face, along with the confidence in the match.
', 'SearchFacesResponse$FaceMatches' => 'An array of faces that matched the input face, along with the confidence in the match.
', ], ], 'FaceModelVersionList' => [ 'base' => NULL, 'refs' => [ 'ListCollectionsResponse$FaceModelVersions' => 'Version numbers of the face detection models associated with the collections in the array CollectionIds
. For example, the value of FaceModelVersions[2]
is the version number for the face detection model used by the collection in CollectionId[2]
.
Object containing both the face metadata (stored in the backend database), and facial attributes that are detected but aren\'t stored in the database.
', 'refs' => [ 'FaceRecordList$member' => NULL, ], ], 'FaceRecordList' => [ 'base' => NULL, 'refs' => [ 'IndexFacesResponse$FaceRecords' => 'An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
', ], ], 'FaceSearchSettings' => [ 'base' => 'Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings
is a request parameter for .
Face search settings to use on a streaming video.
', ], ], 'FaceSearchSortBy' => [ 'base' => NULL, 'refs' => [ 'GetFaceSearchRequest$SortBy' => 'Sort to use for grouping faces in the response. Use TIMESTAMP
to group faces by the time that they are recognized. Use INDEX
to sort by recognized faces.
Width of the bounding box as a ratio of the overall image width.
', 'BoundingBox$Height' => 'Height of the bounding box as a ratio of the overall image height.
', 'BoundingBox$Left' => 'Left coordinate of the bounding box as a ratio of overall image width.
', 'BoundingBox$Top' => 'Top coordinate of the bounding box as a ratio of overall image height.
', 'ImageQuality$Brightness' => 'Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
', 'ImageQuality$Sharpness' => 'Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.
', 'Landmark$X' => 'The x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
', 'Landmark$Y' => 'The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.
', 'Point$X' => 'The value of the X coordinate for a point on a Polygon
.
The value of the Y coordinate for a point on a Polygon
.
Number of frames per second in the video.
', ], ], 'Gender' => [ 'base' => 'Gender of the face and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Gender' => 'Gender of the face and the confidence level in the determination.
', ], ], 'GenderType' => [ 'base' => NULL, 'refs' => [ 'Gender$Value' => 'Gender of the face.
', ], ], 'Geometry' => [ 'base' => 'Information about where the text detected by is located on an image.
', 'refs' => [ 'TextDetection$Geometry' => 'The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
', ], ], 'GetCelebrityInfoRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCelebrityInfoResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCelebrityRecognitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCelebrityRecognitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetContentModerationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContentModerationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceSearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceSearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLabelDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLabelDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPersonTrackingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPersonTrackingResponse' => [ 'base' => NULL, 'refs' => [], ], 'IdempotentParameterMismatchException' => [ 'base' => 'A ClientRequestToken
input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
Provides the input image either as bytes or an S3 object.
You pass image bytes to an Amazon Rekognition API operation by using the Bytes
property. For example, you would use the Bytes
property to pass an image loaded from a local file system. Image bytes passed by using the Bytes
property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object
property. Images stored in an S3 bucket do not need to be base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'CompareFacesRequest$SourceImage' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'CompareFacesRequest$TargetImage' => 'The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectFacesRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectLabelsRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectModerationLabelsRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectTextRequest$Image' => 'The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can\'t pass image bytes.
', 'IndexFacesRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn\'t supported.
', 'RecognizeCelebritiesRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'SearchFacesByImageRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', ], ], 'ImageBlob' => [ 'base' => NULL, 'refs' => [ 'Image$Bytes' => 'Blob of image bytes up to 5 MBs.
', ], ], 'ImageId' => [ 'base' => NULL, 'refs' => [ 'Face$ImageId' => 'Unique identifier that Amazon Rekognition assigns to the input image.
', ], ], 'ImageQuality' => [ 'base' => 'Identifies face image brightness and sharpness.
', 'refs' => [ 'ComparedFace$Quality' => 'Identifies face image brightness and sharpness.
', 'FaceDetail$Quality' => 'Identifies image brightness and sharpness. Default attribute.
', ], ], 'ImageTooLargeException' => [ 'base' => 'The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.
', 'refs' => [], ], 'IndexFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'IndexFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Instance' => [ 'base' => 'An instance of a label detected by .
', 'refs' => [ 'Instances$member' => NULL, ], ], 'Instances' => [ 'base' => NULL, 'refs' => [ 'Label$Instances' => 'If Label
represents an object, Instances
contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances
is returned as null
by GetLabelDetection
.
Amazon Rekognition experienced a service issue. Try your call again.
', 'refs' => [], ], 'InvalidImageFormatException' => [ 'base' => 'The provided image format is not supported.
', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => 'Pagination token in the request is not valid.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'Input parameter violated a constraint. Validate your parameter before calling the API operation again.
', 'refs' => [], ], 'InvalidS3ObjectException' => [ 'base' => 'Amazon Rekognition is unable to access the S3 object specified in the request.
', 'refs' => [], ], 'JobId' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionRequest$JobId' => 'Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition
.
The identifier for the content moderation job. Use JobId
to identify the job in a subsequent call to GetContentModeration
.
Unique identifier for the face detection job. The JobId
is returned from StartFaceDetection
.
The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch
.
Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection
.
The identifier for a job that tracks persons in a video. You get the JobId
from a call to StartPersonTracking
.
The identifier for the celebrity recognition analysis job. Use JobId
to identify the job in a subsequent call to GetCelebrityRecognition
.
The identifier for the content moderation analysis job. Use JobId
to identify the job in a subsequent call to GetContentModeration
.
The identifier for the face detection job. Use JobId
to identify the job in a subsequent call to GetFaceDetection
.
The identifier for the search job. Use JobId
to identify the job in a subsequent call to GetFaceSearch
.
The identifier for the label detection job. Use JobId
to identify the job in a subsequent call to GetLabelDetection
.
The identifier for the person detection job. Use JobId
to identify the job in a subsequent call to GetPersonTracking
.
Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartContentModerationRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartFaceDetectionRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartFaceSearchRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartLabelDetectionRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartPersonTrackingRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', ], ], 'KinesisDataArn' => [ 'base' => NULL, 'refs' => [ 'KinesisDataStream$Arn' => 'ARN of the output Amazon Kinesis Data Streams stream.
', ], ], 'KinesisDataStream' => [ 'base' => 'The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'StreamProcessorOutput$KinesisDataStream' => 'The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.
', ], ], 'KinesisVideoArn' => [ 'base' => NULL, 'refs' => [ 'KinesisVideoStream$Arn' => 'ARN of the Kinesis video stream stream that streams the source video.
', ], ], 'KinesisVideoStream' => [ 'base' => 'Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'StreamProcessorInput$KinesisVideoStream' => 'The Kinesis video stream input stream for the source streaming video.
', ], ], 'Label' => [ 'base' => 'Structure containing details about the detected label, including the name, and level of confidence.
The Amazon Rekognition Image operation operation returns a hierarchical taxonomy (Parents
) for detected labels and also bounding box information (Instances
) for detected labels. Amazon Rekognition Video doesn\'t return this information and returns null
for the Parents
and Instances
attributes.
Details about the detected label.
', 'Labels$member' => NULL, ], ], 'LabelDetection' => [ 'base' => 'Information about a label detected in a video analysis request and the time the label was detected in the video.
', 'refs' => [ 'LabelDetections$member' => NULL, ], ], 'LabelDetectionSortBy' => [ 'base' => NULL, 'refs' => [ 'GetLabelDetectionRequest$SortBy' => 'Sort to use for elements in the Labels
array. Use TIMESTAMP
to sort array elements by the time labels are detected. Use NAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP
.
An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
', ], ], 'Labels' => [ 'base' => NULL, 'refs' => [ 'DetectLabelsResponse$Labels' => 'An array of labels for the real-world objects detected.
', ], ], 'Landmark' => [ 'base' => 'Indicates the location of the landmark on the face.
', 'refs' => [ 'Landmarks$member' => NULL, ], ], 'LandmarkType' => [ 'base' => NULL, 'refs' => [ 'Landmark$Type' => 'Type of landmark.
', ], ], 'Landmarks' => [ 'base' => NULL, 'refs' => [ 'ComparedFace$Landmarks' => 'An array of facial landmarks.
', 'FaceDetail$Landmarks' => 'Indicates the location of landmarks on the face. Default attribute.
', ], ], 'LimitExceededException' => [ 'base' => 'An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will raise a LimitExceededException
exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
', 'SearchFacesRequest$MaxFaces' => 'Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
', ], ], 'MaxFacesToIndex' => [ 'base' => NULL, 'refs' => [ 'IndexFacesRequest$MaxFaces' => 'The maximum number of faces to index. The value of MaxFaces
must be greater than or equal to 1. IndexFaces
returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces
.
If IndexFaces
detects more faces than the value of MaxFaces
, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces
, the faces with the smallest bounding boxes are filtered out (up to the number that\'s needed to satisfy the value of MaxFaces
). Information about the unindexed faces is available in the UnindexedFaces
array.
The faces that are returned by IndexFaces
are sorted by the largest face bounding box size to the smallest size, in descending order.
MaxFaces
can be used with a collection associated with any version of the face model.
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetContentModerationRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetFaceDetectionRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetFaceSearchRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetLabelDetectionRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetPersonTrackingRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'ListStreamProcessorsRequest$MaxResults' => 'Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
', ], ], 'ModerationLabel' => [ 'base' => 'Provides information about a single type of moderated content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'ContentModerationDetection$ModerationLabel' => 'The moderation label detected by in the stored video.
', 'ModerationLabels$member' => NULL, ], ], 'ModerationLabels' => [ 'base' => NULL, 'refs' => [ 'DetectModerationLabelsResponse$ModerationLabels' => 'Array of detected Moderation labels and the time, in millseconds from the start of the video, they were detected.
', ], ], 'MouthOpen' => [ 'base' => 'Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$MouthOpen' => 'Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
', ], ], 'Mustache' => [ 'base' => 'Indicates whether or not the face has a mustache, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Mustache' => 'Indicates whether or not the face has a mustache, and the confidence level in the determination.
', ], ], 'NotificationChannel' => [ 'base' => 'The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
', 'refs' => [ 'StartCelebrityRecognitionRequest$NotificationChannel' => 'The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
', 'StartContentModerationRequest$NotificationChannel' => 'The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content moderation analysis to.
', 'StartFaceDetectionRequest$NotificationChannel' => 'The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
', 'StartFaceSearchRequest$NotificationChannel' => 'The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
', 'StartLabelDetectionRequest$NotificationChannel' => 'The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
', 'StartPersonTrackingRequest$NotificationChannel' => 'The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
', ], ], 'OrientationCorrection' => [ 'base' => NULL, 'refs' => [ 'CompareFacesResponse$SourceImageOrientationCorrection' => 'The value of SourceImageOrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'CompareFacesResponse$TargetImageOrientationCorrection' => 'The value of TargetImageOrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'DetectFacesResponse$OrientationCorrection' => 'The value of OrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'DetectLabelsResponse$OrientationCorrection' => 'The value of OrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'IndexFacesResponse$OrientationCorrection' => 'If your collection is associated with a face detection model that\'s later than version 3.0, the value of OrientationCorrection
is always null and no orientation information is returned.
If your collection is associated with a face detection model that\'s version 3.0 or earlier, the following applies:
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata. The value of OrientationCorrection
is null.
If the image doesn\'t contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
Bounding box information is returned in the FaceRecords
array. You can get the version of the face detection model by calling .
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces
and UnrecognizedFaces
represent face locations before the image orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image\'s orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection
is null. The CelebrityFaces
and UnrecognizedFaces
bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Maximum number of collection IDs to return.
', 'ListFacesRequest$MaxResults' => 'Maximum number of faces to return.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionRequest$NextToken' => 'If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.
', 'GetCelebrityRecognitionResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.
', 'GetContentModerationRequest$NextToken' => 'If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.
', 'GetContentModerationResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of moderation labels.
', 'GetFaceDetectionRequest$NextToken' => 'If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
', 'GetFaceDetectionResponse$NextToken' => 'If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
', 'GetFaceSearchRequest$NextToken' => 'If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.
', 'GetFaceSearchResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
', 'GetLabelDetectionRequest$NextToken' => 'If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.
', 'GetLabelDetectionResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.
', 'GetPersonTrackingRequest$NextToken' => 'If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
', 'GetPersonTrackingResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.
', 'ListCollectionsRequest$NextToken' => 'Pagination token from the previous response.
', 'ListCollectionsResponse$NextToken' => 'If the result is truncated, the response provides a NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
', 'ListStreamProcessorsRequest$NextToken' => 'If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.
', 'ListStreamProcessorsResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors.
', ], ], 'Parent' => [ 'base' => 'A parent label for a label. A label can have 0, 1, or more parents.
', 'refs' => [ 'Parents$member' => NULL, ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'Label$Parents' => 'The parent labels for a label. The response includes all ancestor labels.
Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents
is returned as null
by GetLabelDetection
.
Level of confidence in the determination.
', 'Celebrity$MatchConfidence' => 'The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
', 'CelebrityDetail$Confidence' => 'The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
', 'CompareFacesMatch$Similarity' => 'Level of confidence that the faces match.
', 'CompareFacesRequest$SimilarityThreshold' => 'The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches
array.
Level of confidence that what the bounding box contains is a face.
', 'ComparedSourceImageFace$Confidence' => 'Confidence level that the selected bounding box contains a face.
', 'DetectLabelsRequest$MinConfidence' => 'Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn\'t return any labels with confidence lower than this specified value.
If MinConfidence
is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn\'t return any labels with a confidence level lower than this specified value.
If you don\'t specify MinConfidence
, the operation returns labels with confidence values greater than or equal to 50 percent.
Level of confidence in the determination.
', 'EyeOpen$Confidence' => 'Level of confidence in the determination.
', 'Eyeglasses$Confidence' => 'Level of confidence in the determination.
', 'Face$Confidence' => 'Confidence level that the bounding box contains a face (and not a different object such as a tree).
', 'FaceDetail$Confidence' => 'Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
', 'FaceMatch$Similarity' => 'Confidence in the match of this face with the input face.
', 'FaceSearchSettings$FaceMatchThreshold' => 'Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.
', 'Gender$Confidence' => 'Level of confidence in the determination.
', 'Instance$Confidence' => 'The confidence that Amazon Rekognition Image has in the accuracy of the bounding box.
', 'Label$Confidence' => 'Level of confidence.
', 'ModerationLabel$Confidence' => 'Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.
If you don\'t specify the MinConfidence
parameter in the call to DetectModerationLabels
, the operation returns labels with a confidence value greater than or equal to 50 percent.
Level of confidence in the determination.
', 'Mustache$Confidence' => 'Level of confidence in the determination.
', 'SearchFacesByImageRequest$FaceMatchThreshold' => '(Optional) Specifies the minimum confidence in the face match to return. For example, don\'t return any matches where confidence in matches is less than 70%.
', 'SearchFacesByImageResponse$SearchedFaceConfidence' => 'The level of confidence that the searchedFaceBoundingBox
, contains a face.
Optional value specifying the minimum confidence in the face match to return. For example, don\'t return any matches where confidence in matches is less than 70%.
', 'Smile$Confidence' => 'Level of confidence in the determination.
', 'StartContentModerationRequest$MinConfidence' => 'Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn\'t return any moderated content labels with a confidence level lower than this specified value. If you don\'t specify MinConfidence
, GetContentModeration
returns labels with confidence values greater than or equal to 50 percent.
The minimum confidence in the person match to return. For example, don\'t return any matches where confidence in matches is less than 70%.
', 'StartLabelDetectionRequest$MinConfidence' => 'Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn\'t return any labels with a confidence level lower than this specified value.
If you don\'t specify MinConfidence
, the operation returns labels with confidence values greater than or equal to 50 percent.
Level of confidence in the determination.
', 'TextDetection$Confidence' => 'The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
', ], ], 'PersonDetail' => [ 'base' => 'Details about a person detected in a video analysis request.
', 'refs' => [ 'PersonDetection$Person' => 'Details about a person whose path was tracked in a video.
', 'PersonMatch$Person' => 'Information about the matched person.
', ], ], 'PersonDetection' => [ 'base' => 'Details and path tracking information for a single time a person\'s path is tracked in a video. Amazon Rekognition operations that track people\'s paths return an array of PersonDetection
objects with elements for each time a person\'s path is tracked in a video.
For more information, see API_GetPersonTracking in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'PersonDetections$member' => NULL, ], ], 'PersonDetections' => [ 'base' => NULL, 'refs' => [ 'GetPersonTrackingResponse$Persons' => 'An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person\'s path is tracked.
', ], ], 'PersonIndex' => [ 'base' => NULL, 'refs' => [ 'PersonDetail$Index' => 'Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.
', ], ], 'PersonMatch' => [ 'base' => 'Information about a person whose face matches a face(s) in an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch
objects is returned by .
An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch
. Each Persons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.
Sort to use for elements in the Persons
array. Use TIMESTAMP
to sort array elements by the time persons are detected. Use INDEX
to sort by the tracked persons. If you sort by INDEX
, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP
.
The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.
An array of Point
objects, Polygon
, is returned by . Polygon
represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Rekognition Developer Guide.
Within the bounding box, a fine-grained polygon around the detected text.
', ], ], 'Pose' => [ 'base' => 'Indicates the pose of the face as determined by its pitch, roll, and yaw.
', 'refs' => [ 'ComparedFace$Pose' => 'Indicates the pose of the face as determined by its pitch, roll, and yaw.
', 'FaceDetail$Pose' => 'Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
', ], ], 'ProvisionedThroughputExceededException' => [ 'base' => 'The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
', 'refs' => [], ], 'QualityFilter' => [ 'base' => NULL, 'refs' => [ 'IndexFacesRequest$QualityFilter' => 'A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered faces aren\'t indexed. If you specify AUTO
, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that\'s misidentified as a face, a face that\'s too blurry, or a face with a pose that\'s too extreme to use. If you specify NONE
, no filtering is performed. The default value is AUTO.
To use quality filtering, the collection you are using must be associated with version 3 of the face model.
', ], ], 'Reason' => [ 'base' => NULL, 'refs' => [ 'Reasons$member' => NULL, ], ], 'Reasons' => [ 'base' => NULL, 'refs' => [ 'UnindexedFace$Reasons' => 'An array of reasons that specify why a face wasn\'t indexed.
EXTREME_POSE - The face is at a pose that can\'t be detected. For example, the head is turned too far away from the camera.
EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces
input parameter for IndexFaces
.
LOW_BRIGHTNESS - The image is too dark.
LOW_SHARPNESS - The image is too blurry.
LOW_CONFIDENCE - The face was detected with a low confidence.
SMALL_BOUNDING_BOX - The bounding box around the face is too small.
A unique identifier for the celebrity.
', 'CelebrityDetail$Id' => 'The unique identifier for the celebrity.
', 'GetCelebrityInfoRequest$Id' => 'The ID for the celebrity. You get the celebrity ID from a call to the operation, which recognizes celebrities in an image.
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'A collection with the specified ID already exists.
', 'refs' => [], ], 'ResourceInUseException' => [ 'base' => '', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The collection specified in the request cannot be found.
', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateStreamProcessorRequest$RoleArn' => 'ARN of the IAM role that allows access to the stream processor.
', 'DescribeStreamProcessorResponse$RoleArn' => 'ARN of the IAM role that allows access to the stream processor.
', 'NotificationChannel$RoleArn' => 'The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.
', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'S3Object$Bucket' => 'Name of the S3 bucket.
', ], ], 'S3Object' => [ 'base' => 'Provides the S3 bucket name and object name.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'Image$S3Object' => 'Identifies an S3 object as the image source.
', 'Video$S3Object' => 'The Amazon S3 bucket name and file name for the video.
', ], ], 'S3ObjectName' => [ 'base' => NULL, 'refs' => [ 'S3Object$Name' => 'S3 object key name.
', ], ], 'S3ObjectVersion' => [ 'base' => NULL, 'refs' => [ 'S3Object$Version' => 'If the bucket is versioning enabled, you can specify the object version.
', ], ], 'SNSTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationChannel$SNSTopicArn' => 'The Amazon SNS topic to which Amazon Rekognition to posts the completion status.
', ], ], 'SearchFacesByImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchFacesByImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Smile' => [ 'base' => 'Indicates whether or not the face is smiling, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Smile' => 'Indicates whether or not the face is smiling, and the confidence level in the determination.
', ], ], 'StartCelebrityRecognitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCelebrityRecognitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContentModerationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContentModerationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceSearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceSearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartLabelDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartLabelDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartPersonTrackingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPersonTrackingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartStreamProcessorRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartStreamProcessorResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionResponse$StatusMessage' => 'If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to . The request parameters for CreateStreamProcessor
describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.
ARN for the newly create stream processor.
', 'DescribeStreamProcessorResponse$StreamProcessorArn' => 'ARN of the stream processor.
', ], ], 'StreamProcessorInput' => [ 'base' => 'Information about the source streaming video.
', 'refs' => [ 'CreateStreamProcessorRequest$Input' => 'Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput
.
Kinesis video stream that provides the source streaming video.
', ], ], 'StreamProcessorList' => [ 'base' => NULL, 'refs' => [ 'ListStreamProcessorsResponse$StreamProcessors' => 'List of stream processors that you have created.
', ], ], 'StreamProcessorName' => [ 'base' => NULL, 'refs' => [ 'CreateStreamProcessorRequest$Name' => 'An identifier you assign to the stream processor. You can use Name
to manage the stream processor. For example, you can get the current status of the stream processor by calling . Name
is idempotent.
The name of the stream processor you want to delete.
', 'DescribeStreamProcessorRequest$Name' => 'Name of the stream processor for which you want information.
', 'DescribeStreamProcessorResponse$Name' => 'Name of the stream processor.
', 'StartStreamProcessorRequest$Name' => 'The name of the stream processor to start processing.
', 'StopStreamProcessorRequest$Name' => 'The name of a stream processor created by .
', 'StreamProcessor$Name' => 'Name of the Amazon Rekognition stream processor.
', ], ], 'StreamProcessorOutput' => [ 'base' => 'Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'CreateStreamProcessorRequest$Output' => 'Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput
.
Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
', ], ], 'StreamProcessorSettings' => [ 'base' => 'Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.
', 'refs' => [ 'CreateStreamProcessorRequest$Settings' => 'Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
', 'DescribeStreamProcessorResponse$Settings' => 'Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
', ], ], 'StreamProcessorStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStreamProcessorResponse$Status' => 'Current status of the stream processor.
', 'StreamProcessor$Status' => 'Current status of the Amazon Rekognition stream processor.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Celebrity$Name' => 'The name of the celebrity.
', 'CelebrityDetail$Name' => 'The name of the celebrity.
', 'CreateCollectionResponse$CollectionArn' => 'Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
', 'CreateCollectionResponse$FaceModelVersion' => 'Version number of the face detection model associated with the collection you are creating.
', 'DescribeCollectionResponse$FaceModelVersion' => 'The version of the face model that\'s used by the collection for face detection.
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
', 'DescribeCollectionResponse$CollectionARN' => 'The Amazon Resource Name (ARN) of the collection.
', 'DescribeStreamProcessorResponse$StatusMessage' => 'Detailed status message about the stream processor.
', 'DetectLabelsResponse$LabelModelVersion' => 'Version number of the label detection model that was used to detect labels.
', 'FaceModelVersionList$member' => NULL, 'GetCelebrityInfoResponse$Name' => 'The name of the celebrity.
', 'IndexFacesResponse$FaceModelVersion' => 'The version number of the face detection model that\'s associated with the input collection (CollectionId
).
The name (label) of the object or scene.
', 'ListFacesResponse$NextToken' => 'If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
', 'ListFacesResponse$FaceModelVersion' => 'Version number of the face detection model associated with the input collection (CollectionId
).
The label name for the type of content detected in the image.
', 'ModerationLabel$ParentName' => 'The name for the parent label. Labels at the top level of the hierarchy have the parent label ""
.
The name of the parent label.
', 'SearchFacesByImageResponse$FaceModelVersion' => 'Version number of the face detection model associated with the input collection (CollectionId
).
Version number of the face detection model associated with the input collection (CollectionId
).
The word or line of text recognized by Amazon Rekognition.
', 'VideoMetadata$Codec' => 'Type of compression used in the analyzed video.
', 'VideoMetadata$Format' => 'Format of the analyzed video. Possible values are MP4, MOV and AVI.
', ], ], 'Sunglasses' => [ 'base' => 'Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Sunglasses' => 'Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
', ], ], 'TextDetection' => [ 'base' => 'Information about a word or line of text detected by .
The DetectedText
field contains the text that Amazon Rekognition detected in the image.
Every word and line has an identifier (Id
). Each word belongs to a line and has a parent identifier (ParentId
) that identifies the line of text in which the word appears. The word Id
is also an index for the word within a line of words.
For more information, see Detecting Text in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'TextDetectionList$member' => NULL, ], ], 'TextDetectionList' => [ 'base' => NULL, 'refs' => [ 'DetectTextResponse$TextDetections' => 'An array of text that was detected in the input image.
', ], ], 'TextTypes' => [ 'base' => NULL, 'refs' => [ 'TextDetection$Type' => 'The type of text that was detected.
', ], ], 'ThrottlingException' => [ 'base' => 'Amazon Rekognition is temporarily unable to process the request. Try your call again.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'CelebrityRecognition$Timestamp' => 'The time, in milliseconds from the start of the video, that the celebrity was recognized.
', 'ContentModerationDetection$Timestamp' => 'Time, in milliseconds from the beginning of the video, that the moderation label was detected.
', 'FaceDetection$Timestamp' => 'Time, in milliseconds from the start of the video, that the face was detected.
', 'LabelDetection$Timestamp' => 'Time, in milliseconds from the start of the video, that the label was detected.
', 'PersonDetection$Timestamp' => 'The time, in milliseconds from the start of the video, that the person\'s path was tracked.
', 'PersonMatch$Timestamp' => 'The time, in milliseconds from the beginning of the video, that the person was matched in the video.
', ], ], 'UInteger' => [ 'base' => NULL, 'refs' => [ 'AgeRange$Low' => 'The lowest estimated age.
', 'AgeRange$High' => 'The highest estimated age.
', 'CreateCollectionResponse$StatusCode' => 'HTTP status code indicating the result of the operation.
', 'DeleteCollectionResponse$StatusCode' => 'HTTP status code that indicates the result of the operation.
', 'DetectLabelsRequest$MaxLabels' => 'Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.
', 'TextDetection$Id' => 'The identifier for the detected text. The identifier is only unique for a single call to DetectText
.
The Parent identifier for the detected text identified by the value of ID
. If the type of detected text is LINE
, the value of ParentId
is Null
.
The number of faces that are indexed into the collection. To index faces into a collection, use .
', 'VideoMetadata$DurationMillis' => 'Length of the video in milliseconds.
', 'VideoMetadata$FrameHeight' => 'Vertical pixel dimension of the video.
', 'VideoMetadata$FrameWidth' => 'Horizontal pixel dimension of the video.
', ], ], 'UnindexedFace' => [ 'base' => 'A face that detected, but didn\'t index. Use the Reasons
response attribute to determine why a face wasn\'t indexed.
An array of faces that were detected in the image but weren\'t indexed. They weren\'t indexed because the quality filter identified them as low quality, or the MaxFaces
request parameter filtered them out. To use the quality filter, you specify the QualityFilter
request parameter.
An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
', 'CelebrityDetail$Urls' => 'An array of URLs pointing to additional celebrity information.
', 'GetCelebrityInfoResponse$Urls' => 'An array of URLs pointing to additional celebrity information.
', ], ], 'Video' => [ 'base' => 'Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as use Video
to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
', 'StartContentModerationRequest$Video' => 'The video in which you want to moderate content. The video must be stored in an Amazon S3 bucket.
', 'StartFaceDetectionRequest$Video' => 'The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
', 'StartFaceSearchRequest$Video' => 'The video you want to search. The video must be stored in an Amazon S3 bucket.
', 'StartLabelDetectionRequest$Video' => 'The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
', 'StartPersonTrackingRequest$Video' => 'The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
', ], ], 'VideoJobStatus' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionResponse$JobStatus' => 'The current status of the celebrity recognition job.
', 'GetContentModerationResponse$JobStatus' => 'The current status of the content moderation job.
', 'GetFaceDetectionResponse$JobStatus' => 'The current status of the face detection job.
', 'GetFaceSearchResponse$JobStatus' => 'The current status of the face search job.
', 'GetLabelDetectionResponse$JobStatus' => 'The current status of the label detection job.
', 'GetPersonTrackingResponse$JobStatus' => 'The current status of the person tracking job.
', ], ], 'VideoMetadata' => [ 'base' => 'Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.
Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in every page of paginated responses from GetContentModeration
.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.
Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.
The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.
', 'refs' => [], ], ],]; +return [ 'version' => '2.0', 'service' => 'This is the Amazon Rekognition API reference.
', 'operations' => [ 'CompareFaces' => '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.
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.
Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation.
For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces
operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.
When you create a collection, it is associated with the latest version of the face model version.
Collection names are case-sensitive.
This operation requires permissions to perform the rekognition:CreateCollection
action.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input
) and a Kinesis data stream (Output
) stream. You also specify the face recognition criteria in Settings
. For example, the collection containing faces that you want to recognize. Use Name
to assign an identifier for the stream processor. You use Name
to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name
field.
After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.
', 'DeleteCollection' => 'Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.
This operation requires permissions to perform the rekognition:DeleteCollection
action.
Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the rekognition:DeleteFaces
action.
Deletes the stream processor identified by Name
. You assign the value for Name
when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor
.
Describes the specified collection. You can use DescribeCollection
to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.
For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
', 'DescribeStreamProcessor' => 'Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
', 'DetectFaces' => 'Detects faces within an image that is provided as input.
DetectFaces
detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
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 to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectFaces
action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.
DetectLabels
does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.
You 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, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence
to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels
parameter to limit the number of labels returned.
If the object detected is a person, the operation doesn\'t provide the same facial details that the DetectFaces operation provides.
DetectLabels
returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance
object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.
DetectLabels
also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectLabels
action.
Detects explicit or suggestive adult 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.
', 'DetectText' => '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.
', 'GetCelebrityInfo' => 'Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo
action.
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId
). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
GetCelebrityRecognition
returns detected celebrities and the time(s) they are detected in an array (Celebrities
) of CelebrityRecognition objects. Each CelebrityRecognition
contains information about the celebrity in a CelebrityDetail object and the time, Timestamp
, the celebrity was detected.
GetCelebrityRecognition
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities
array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID
in the SortBy
input parameter.
The CelebrityDetail
object includes the celebrity identifer and additional information urls. If you don\'t store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetCelebrityRecognition
.
Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.
Content moderation analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration. which returns a job identifier (JobId
). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration
. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityDetection
and pass the job identifier (JobId
) from the initial call to StartCelebrityDetection
.
For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.
GetContentModeration
returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels
, of ContentModerationDetection objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME
for the SortBy
input parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit the number of labels returned in a single call to GetContentModeration
. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration
and populate the NextToken
request parameter with the value of NextToken
returned from the previous call to GetContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
', 'GetFaceDetection' => 'Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId
). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceDetection and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
GetFaceDetection
returns an array of detected faces (Faces
) sorted by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetFaceDetection
.
Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.
Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId
). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceSearch
and pass the job identifier (JobId
) from the initial call to StartFaceSearch
.
For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
The search results are retured in an array, Persons
, of PersonMatch objects. EachPersonMatch
element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Persons
array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX
for the SORTBY
input parameter.
Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId
). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection
. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetLabelDetection and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME
for the SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection
and populate the NextToken
request parameter with the token value returned from the previous call to GetLabelDetection
.
Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
The person path tracking operation is started by a call to StartPersonTracking
which returns a job identifier (JobId
). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking
.
To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetPersonTracking and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
GetPersonTracking
returns an array, Persons
, of tracked persons and the time(s) their paths were tracked in the video.
GetPersonTracking
only returns the default facial attributes (BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
). The other facial attributes listed in the Face
object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the array is sorted by the time(s) a person\'s path is tracked in the video. You can sort by tracked persons by specifying INDEX
for the SortBy
input parameter.
Use the MaxResults
parameter to limit the number of items returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking
and populate the NextToken
request parameter with the token value returned from the previous call to GetPersonTracking
.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn\'t save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.
For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.
To get the number of faces in a collection, call DescribeCollection.
If you\'re using version 1.0 of the face detection model, IndexFaces
indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.
If you\'re using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection
field.
To determine which version of the model you\'re using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion
in the response from IndexFaces
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageID
for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces
input parameter. This is useful when you want to index the largest faces in an image and don\'t want to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter
input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces
filters detected faces. You can also explicitly filter detected faces by specifying AUTO
for the value of QualityFilter
. If you do not want to filter detected faces, specify NONE
.
To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call DescribeCollection.
Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces
. Faces aren\'t indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces
request parameter.
The face is too small compared to the image dimensions.
The face is too blurry.
The image is too dark.
The face has an extreme pose.
In response, the IndexFaces
operation returns an array of metadata for all detected faces, FaceRecords
. This includes:
The bounding box, BoundingBox
, of the detected face.
A confidence value, Confidence
, which indicates the confidence that the bounding box contains a face.
A face ID, faceId
, assigned by the service for each face that\'s detected and stored.
An image ID, ImageId
, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes
parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces
operation, Amazon Rekognition doesn\'t save duplicate face metadata.
The input image is passed 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 isn\'t supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces
action.
Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
For an example, see Listing Collections in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListCollections
action.
Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:ListFaces
action.
Gets a list of stream processors that you have created with CreateStreamProcessor.
', 'RecognizeCelebrities' => '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 100 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 100 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.
For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.
You can also search faces without indexing faces by using the SearchFacesByImage
operation.
The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence
value for each face match, indicating the confidence that the specific face matches the input face.
For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFaces
action.
For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.
To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation.
You can also call the DetectFaces
operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage
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.
The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity
indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFacesByImage
action.
Starts asynchronous recognition of celebrities in a stored video.
Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition
returns a job identifier (JobId
) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetCelebrityRecognition and pass the job identifier (JobId
) from the initial call to StartCelebrityRecognition
.
For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
', 'StartContentModeration' => 'Starts asynchronous detection of explicit or suggestive adult content in a stored video.
Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration
returns a job identifier (JobId
) which you use to get the results of the analysis. When content moderation analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetContentModeration and pass the job identifier (JobId
) from the initial call to StartContentModeration
.
For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
', 'StartFaceDetection' => 'Starts asynchronous detection of faces in a stored video.
Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection
returns a job identifier (JobId
) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceDetection and pass the job identifier (JobId
) from the initial call to StartFaceDetection
.
For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.
', 'StartFaceSearch' => 'Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch
returns a job identifier (JobId
) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetFaceSearch and pass the job identifier (JobId
) from the initial call to StartFaceSearch
. For more information, see procedure-person-search-videos.
Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetLabelDetection and pass the job identifier (JobId
) from the initial call to StartLabelDetection
.
Starts the asynchronous tracking of a person\'s path in a stored video.
Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking
returns a job identifier (JobId
) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
.
To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetPersonTracking and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor
which stream processor to start, use the value of the Name
field specified in the call to CreateStreamProcessor
.
Stops a running stream processor that was created by CreateStreamProcessor.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You are not authorized to perform the action.
', 'refs' => [], ], 'AgeRange' => [ 'base' => 'Structure containing the estimated age range, in years, for a face.
Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the face of a 6-year-old might have an estimated range of 4-8.
', 'refs' => [ 'FaceDetail$AgeRange' => 'The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
', ], ], 'Attribute' => [ 'base' => NULL, 'refs' => [ 'Attributes$member' => NULL, ], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'DetectFacesRequest$Attributes' => 'An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don\'t specify a value for Attributes
or if you specify ["DEFAULT"]
, the API returns the following subset of facial attributes: BoundingBox
, Confidence
, Pose
, Quality
, and Landmarks
. If you provide ["ALL"]
, all facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"]
, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don\'t specify a value for Attributes
or if you specify ["DEFAULT"]
, the API returns the following subset of facial attributes: BoundingBox
, Confidence
, Pose
, Quality
, and Landmarks
. If you provide ["ALL"]
, all facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"]
, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
Indicates whether or not the face has a beard, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Beard' => 'Indicates whether or not the face has a beard, and the confidence level in the determination.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'Beard$Value' => 'Boolean value that indicates whether the face has beard or not.
', 'EyeOpen$Value' => 'Boolean value that indicates whether the eyes on the face are open.
', 'Eyeglasses$Value' => 'Boolean value that indicates whether the face is wearing eye glasses or not.
', 'MouthOpen$Value' => 'Boolean value that indicates whether the mouth on the face is open or not.
', 'Mustache$Value' => 'Boolean value that indicates whether the face has mustache or not.
', 'Smile$Value' => 'Boolean value that indicates whether the face is smiling or not.
', 'Sunglasses$Value' => 'Boolean value that indicates whether the face is wearing sunglasses or not.
', ], ], 'BoundingBox' => [ 'base' => 'Identifies the bounding box around the label, face, or text. The left
(x-coordinate) and top
(y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
The top
and left
values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left
value of 0.5 (350/700) and a top
value of 0.25 (50/200).
The width
and height
values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left
or top
values.
Bounding box around the body of a celebrity.
', 'ComparedFace$BoundingBox' => 'Bounding box of the face.
', 'ComparedSourceImageFace$BoundingBox' => 'Bounding box of the face.
', 'Face$BoundingBox' => 'Bounding box of the face.
', 'FaceDetail$BoundingBox' => 'Bounding box of the face. Default attribute.
', 'Geometry$BoundingBox' => 'An axis-aligned coarse representation of the detected text\'s location on the image.
', 'Instance$BoundingBox' => 'The position of the label instance on the image.
', 'PersonDetail$BoundingBox' => 'Bounding box around the detected person.
', 'SearchFacesByImageResponse$SearchedFaceBoundingBox' => 'The bounding box around the face in the input image that Amazon Rekognition used for the search.
', ], ], 'Celebrity' => [ 'base' => 'Provides information about a celebrity recognized by the RecognizeCelebrities operation.
', 'refs' => [ 'CelebrityList$member' => NULL, ], ], 'CelebrityDetail' => [ 'base' => 'Information about a recognized celebrity.
', 'refs' => [ 'CelebrityRecognition$Celebrity' => 'Information about a recognized celebrity.
', ], ], 'CelebrityList' => [ 'base' => NULL, 'refs' => [ 'RecognizeCelebritiesResponse$CelebrityFaces' => 'Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.
', ], ], 'CelebrityRecognition' => [ 'base' => 'Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see GetCelebrityRecognition in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'CelebrityRecognitions$member' => NULL, ], ], 'CelebrityRecognitionSortBy' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionRequest$SortBy' => 'Sort to use for celebrities returned in Celebrities
field. Specify ID
to sort by the celebrity identifier, specify TIMESTAMP
to sort by the time the celebrity was recognized.
Array of celebrities recognized in the video.
', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'StartCelebrityRecognitionRequest$ClientRequestToken' => 'Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartContentModeration
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
ID for the collection that you are creating.
', 'DeleteCollectionRequest$CollectionId' => 'ID of the collection to delete.
', 'DeleteFacesRequest$CollectionId' => 'Collection from which to remove the specific faces.
', 'DescribeCollectionRequest$CollectionId' => 'The ID of the collection to describe.
', 'FaceSearchSettings$CollectionId' => 'The ID of a collection that contains faces that you want to search for.
', 'IndexFacesRequest$CollectionId' => 'The ID of an existing collection to which you want to add the faces that are detected in the input images.
', 'ListFacesRequest$CollectionId' => 'ID of the collection from which to list the faces.
', 'SearchFacesByImageRequest$CollectionId' => 'ID of the collection to search.
', 'SearchFacesRequest$CollectionId' => 'ID of the collection the face belongs to.
', 'StartFaceSearchRequest$CollectionId' => 'ID of the collection that contains the faces you want to search for.
', ], ], 'CollectionIdList' => [ 'base' => NULL, 'refs' => [ 'ListCollectionsResponse$CollectionIds' => 'An array of collection IDs.
', ], ], 'CompareFacesMatch' => [ 'base' => 'Provides information about a face in a target image that matches the source image face analyzed by CompareFaces
. The Face
property contains the bounding box of the face in the target image. The Similarity
property is the confidence that the source image face matches the face in the bounding box.
An array of faces in the target image that match the source image face. Each CompareFacesMatch
object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.
An array of faces in the target image that did not match the source image face.
', ], ], 'ComparedFace' => [ 'base' => 'Provides face metadata for target image faces that are analyzed by CompareFaces
and RecognizeCelebrities
.
Provides information about the celebrity\'s face, such as its location on the image.
', 'CompareFacesMatch$Face' => 'Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
', 'CompareFacesUnmatchList$member' => NULL, 'ComparedFaceList$member' => NULL, ], ], 'ComparedFaceList' => [ 'base' => NULL, 'refs' => [ 'RecognizeCelebritiesResponse$UnrecognizedFaces' => 'Details about each unrecognized face in the image.
', ], ], 'ComparedSourceImageFace' => [ 'base' => 'Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.
', 'refs' => [ 'CompareFacesResponse$SourceImageFace' => 'The face in the source image that was used for comparison.
', ], ], 'ContentModerationDetection' => [ 'base' => 'Information about a moderation label detection in a stored video.
', 'refs' => [ 'ContentModerationDetections$member' => NULL, ], ], 'ContentModerationDetections' => [ 'base' => NULL, 'refs' => [ 'GetContentModerationResponse$ModerationLabels' => 'The detected moderation labels and the time(s) they were detected.
', ], ], 'ContentModerationSortBy' => [ 'base' => NULL, 'refs' => [ 'GetContentModerationRequest$SortBy' => 'Sort to use for elements in the ModerationLabelDetections
array. Use TIMESTAMP
to sort array elements by the time labels are detected. Use NAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP
.
The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
', 'DescribeStreamProcessorResponse$CreationTimestamp' => 'Date and time the stream processor was created
', 'DescribeStreamProcessorResponse$LastUpdateTimestamp' => 'The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.
', ], ], 'Degree' => [ 'base' => NULL, 'refs' => [ 'Pose$Roll' => 'Value representing the face rotation on the roll axis.
', 'Pose$Yaw' => 'Value representing the face rotation on the yaw axis.
', 'Pose$Pitch' => 'Value representing the face rotation on the pitch axis.
', ], ], 'DeleteCollectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCollectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStreamProcessorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStreamProcessorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCollectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCollectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStreamProcessorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStreamProcessorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectLabelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectLabelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectModerationLabelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectModerationLabelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectTextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetectTextResponse' => [ 'base' => NULL, 'refs' => [], ], 'Emotion' => [ 'base' => 'The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.
', 'refs' => [ 'Emotions$member' => NULL, ], ], 'EmotionName' => [ 'base' => NULL, 'refs' => [ 'Emotion$Type' => 'Type of emotion detected.
', ], ], 'Emotions' => [ 'base' => NULL, 'refs' => [ 'FaceDetail$Emotions' => 'The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.
', ], ], 'ExternalImageId' => [ 'base' => NULL, 'refs' => [ 'Face$ExternalImageId' => 'Identifier that you assign to all the faces in the input image.
', 'IndexFacesRequest$ExternalImageId' => 'The ID you want to assign to all the faces detected in the image.
', ], ], 'EyeOpen' => [ 'base' => 'Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$EyesOpen' => 'Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
', ], ], 'Eyeglasses' => [ 'base' => 'Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Eyeglasses' => 'Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
', ], ], 'Face' => [ 'base' => 'Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
', 'refs' => [ 'FaceList$member' => NULL, 'FaceMatch$Face' => 'Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.
', 'FaceRecord$Face' => 'Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
', ], ], 'FaceAttributes' => [ 'base' => NULL, 'refs' => [ 'StartFaceDetectionRequest$FaceAttributes' => 'The face attributes you want returned.
DEFAULT
- The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.
ALL
- All facial attributes are returned.
Structure containing attributes of the face that the algorithm detected.
A FaceDetail
object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox
, Confidence
, Landmarks
, Pose
, and Quality
.
GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a FaceDetail
object with all attributes. To specify which attributes to return, use the FaceAttributes
input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don\'t have a FaceAttributes
input parameter.
GetCelebrityRecognition
GetPersonTracking
GetFaceSearch
The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the Attributes
input parameter for DetectFaces
. For IndexFaces
, use the DetectAttributes
input parameter.
Face details for the recognized celebrity.
', 'FaceDetailList$member' => NULL, 'FaceDetection$Face' => 'The face properties for the detected face.
', 'FaceRecord$FaceDetail' => 'Structure containing attributes of the face that the algorithm detected.
', 'PersonDetail$Face' => 'Face details for the detected person.
', 'UnindexedFace$FaceDetail' => 'The structure that contains attributes of a face that IndexFaces
detected, but didn\'t index.
Details of each face found in the image.
', ], ], 'FaceDetection' => [ 'base' => 'Information about a face detected in a video analysis request and the time the face was detected in the video.
', 'refs' => [ 'FaceDetections$member' => NULL, ], ], 'FaceDetections' => [ 'base' => NULL, 'refs' => [ 'GetFaceDetectionResponse$Faces' => 'An array of faces detected in the video. Each element contains a detected face\'s details and the time, in milliseconds from the start of the video, the face was detected.
', ], ], 'FaceId' => [ 'base' => NULL, 'refs' => [ 'Face$FaceId' => 'Unique identifier that Amazon Rekognition assigns to the face.
', 'FaceIdList$member' => NULL, 'SearchFacesRequest$FaceId' => 'ID of a face to find matches for in the collection.
', 'SearchFacesResponse$SearchedFaceId' => 'ID of the face that was searched for matches in a collection.
', ], ], 'FaceIdList' => [ 'base' => NULL, 'refs' => [ 'DeleteFacesRequest$FaceIds' => 'An array of face IDs to delete.
', 'DeleteFacesResponse$DeletedFaces' => 'An array of strings (face IDs) of the faces that were deleted.
', ], ], 'FaceList' => [ 'base' => NULL, 'refs' => [ 'ListFacesResponse$Faces' => 'An array of Face
objects.
Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.
', 'refs' => [ 'FaceMatchList$member' => NULL, ], ], 'FaceMatchList' => [ 'base' => NULL, 'refs' => [ 'PersonMatch$FaceMatches' => 'Information about the faces in the input collection that match the face of a person in the video.
', 'SearchFacesByImageResponse$FaceMatches' => 'An array of faces that match the input face, along with the confidence in the match.
', 'SearchFacesResponse$FaceMatches' => 'An array of faces that matched the input face, along with the confidence in the match.
', ], ], 'FaceModelVersionList' => [ 'base' => NULL, 'refs' => [ 'ListCollectionsResponse$FaceModelVersions' => 'Version numbers of the face detection models associated with the collections in the array CollectionIds
. For example, the value of FaceModelVersions[2]
is the version number for the face detection model used by the collection in CollectionId[2]
.
Object containing both the face metadata (stored in the backend database), and facial attributes that are detected but aren\'t stored in the database.
', 'refs' => [ 'FaceRecordList$member' => NULL, ], ], 'FaceRecordList' => [ 'base' => NULL, 'refs' => [ 'IndexFacesResponse$FaceRecords' => 'An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
', ], ], 'FaceSearchSettings' => [ 'base' => 'Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings
is a request parameter for CreateStreamProcessor.
Face search settings to use on a streaming video.
', ], ], 'FaceSearchSortBy' => [ 'base' => NULL, 'refs' => [ 'GetFaceSearchRequest$SortBy' => 'Sort to use for grouping faces in the response. Use TIMESTAMP
to group faces by the time that they are recognized. Use INDEX
to sort by recognized faces.
Width of the bounding box as a ratio of the overall image width.
', 'BoundingBox$Height' => 'Height of the bounding box as a ratio of the overall image height.
', 'BoundingBox$Left' => 'Left coordinate of the bounding box as a ratio of overall image width.
', 'BoundingBox$Top' => 'Top coordinate of the bounding box as a ratio of overall image height.
', 'ImageQuality$Brightness' => 'Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
', 'ImageQuality$Sharpness' => 'Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.
', 'Landmark$X' => 'The x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
', 'Landmark$Y' => 'The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.
', 'Point$X' => 'The value of the X coordinate for a point on a Polygon
.
The value of the Y coordinate for a point on a Polygon
.
Number of frames per second in the video.
', ], ], 'Gender' => [ 'base' => 'Gender of the face and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Gender' => 'Gender of the face and the confidence level in the determination.
', ], ], 'GenderType' => [ 'base' => NULL, 'refs' => [ 'Gender$Value' => 'Gender of the face.
', ], ], 'Geometry' => [ 'base' => 'Information about where the text detected by DetectText is located on an image.
', 'refs' => [ 'TextDetection$Geometry' => 'The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
', ], ], 'GetCelebrityInfoRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCelebrityInfoResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCelebrityRecognitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCelebrityRecognitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetContentModerationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContentModerationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceSearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFaceSearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLabelDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLabelDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPersonTrackingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPersonTrackingResponse' => [ 'base' => NULL, 'refs' => [], ], 'IdempotentParameterMismatchException' => [ 'base' => 'A ClientRequestToken
input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
Provides the input image either as bytes or an S3 object.
You pass image bytes to an Amazon Rekognition API operation by using the Bytes
property. For example, you would use the Bytes
property to pass an image loaded from a local file system. Image bytes passed by using the Bytes
property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object
property. Images stored in an S3 bucket do not need to be base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'CompareFacesRequest$SourceImage' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'CompareFacesRequest$TargetImage' => 'The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectFacesRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectLabelsRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectModerationLabelsRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'DetectTextRequest$Image' => 'The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can\'t pass image bytes.
', 'IndexFacesRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn\'t supported.
', 'RecognizeCelebritiesRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', 'SearchFacesByImageRequest$Image' => 'The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
', ], ], 'ImageBlob' => [ 'base' => NULL, 'refs' => [ 'Image$Bytes' => 'Blob of image bytes up to 5 MBs.
', ], ], 'ImageId' => [ 'base' => NULL, 'refs' => [ 'Face$ImageId' => 'Unique identifier that Amazon Rekognition assigns to the input image.
', ], ], 'ImageQuality' => [ 'base' => 'Identifies face image brightness and sharpness.
', 'refs' => [ 'ComparedFace$Quality' => 'Identifies face image brightness and sharpness.
', 'FaceDetail$Quality' => 'Identifies image brightness and sharpness. Default attribute.
', ], ], 'ImageTooLargeException' => [ 'base' => 'The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.
', 'refs' => [], ], 'IndexFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'IndexFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Instance' => [ 'base' => 'An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).
', 'refs' => [ 'Instances$member' => NULL, ], ], 'Instances' => [ 'base' => NULL, 'refs' => [ 'Label$Instances' => 'If Label
represents an object, Instances
contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
Amazon Rekognition experienced a service issue. Try your call again.
', 'refs' => [], ], 'InvalidImageFormatException' => [ 'base' => 'The provided image format is not supported.
', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => 'Pagination token in the request is not valid.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'Input parameter violated a constraint. Validate your parameter before calling the API operation again.
', 'refs' => [], ], 'InvalidS3ObjectException' => [ 'base' => 'Amazon Rekognition is unable to access the S3 object specified in the request.
', 'refs' => [], ], 'JobId' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionRequest$JobId' => 'Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition
.
The identifier for the content moderation job. Use JobId
to identify the job in a subsequent call to GetContentModeration
.
Unique identifier for the face detection job. The JobId
is returned from StartFaceDetection
.
The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch
.
Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection
.
The identifier for a job that tracks persons in a video. You get the JobId
from a call to StartPersonTracking
.
The identifier for the celebrity recognition analysis job. Use JobId
to identify the job in a subsequent call to GetCelebrityRecognition
.
The identifier for the content moderation analysis job. Use JobId
to identify the job in a subsequent call to GetContentModeration
.
The identifier for the face detection job. Use JobId
to identify the job in a subsequent call to GetFaceDetection
.
The identifier for the search job. Use JobId
to identify the job in a subsequent call to GetFaceSearch
.
The identifier for the label detection job. Use JobId
to identify the job in a subsequent call to GetLabelDetection
.
The identifier for the person detection job. Use JobId
to identify the job in a subsequent call to GetPersonTracking
.
Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartContentModerationRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartFaceDetectionRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartFaceSearchRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartLabelDetectionRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', 'StartPersonTrackingRequest$JobTag' => 'Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
', ], ], 'KinesisDataArn' => [ 'base' => NULL, 'refs' => [ 'KinesisDataStream$Arn' => 'ARN of the output Amazon Kinesis Data Streams stream.
', ], ], 'KinesisDataStream' => [ 'base' => 'The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'StreamProcessorOutput$KinesisDataStream' => 'The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.
', ], ], 'KinesisVideoArn' => [ 'base' => NULL, 'refs' => [ 'KinesisVideoStream$Arn' => 'ARN of the Kinesis video stream stream that streams the source video.
', ], ], 'KinesisVideoStream' => [ 'base' => 'Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'StreamProcessorInput$KinesisVideoStream' => 'The Kinesis video stream input stream for the source streaming video.
', ], ], 'Label' => [ 'base' => 'Structure containing details about the detected label, including the name, detected instances, parent labels, and level of confidence.
', 'refs' => [ 'LabelDetection$Label' => '
Details about the detected label.
', 'Labels$member' => NULL, ], ], 'LabelDetection' => [ 'base' => 'Information about a label detected in a video analysis request and the time the label was detected in the video.
', 'refs' => [ 'LabelDetections$member' => NULL, ], ], 'LabelDetectionSortBy' => [ 'base' => NULL, 'refs' => [ 'GetLabelDetectionRequest$SortBy' => 'Sort to use for elements in the Labels
array. Use TIMESTAMP
to sort array elements by the time labels are detected. Use NAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP
.
An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
', ], ], 'Labels' => [ 'base' => NULL, 'refs' => [ 'DetectLabelsResponse$Labels' => 'An array of labels for the real-world objects detected.
', ], ], 'Landmark' => [ 'base' => 'Indicates the location of the landmark on the face.
', 'refs' => [ 'Landmarks$member' => NULL, ], ], 'LandmarkType' => [ 'base' => NULL, 'refs' => [ 'Landmark$Type' => 'Type of landmark.
', ], ], 'Landmarks' => [ 'base' => NULL, 'refs' => [ 'ComparedFace$Landmarks' => 'An array of facial landmarks.
', 'FaceDetail$Landmarks' => 'Indicates the location of landmarks on the face. Default attribute.
', ], ], 'LimitExceededException' => [ 'base' => 'An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection
, for example) will raise a LimitExceededException
exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
', 'SearchFacesRequest$MaxFaces' => 'Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
', ], ], 'MaxFacesToIndex' => [ 'base' => NULL, 'refs' => [ 'IndexFacesRequest$MaxFaces' => 'The maximum number of faces to index. The value of MaxFaces
must be greater than or equal to 1. IndexFaces
returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces
.
If IndexFaces
detects more faces than the value of MaxFaces
, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces
, the faces with the smallest bounding boxes are filtered out (up to the number that\'s needed to satisfy the value of MaxFaces
). Information about the unindexed faces is available in the UnindexedFaces
array.
The faces that are returned by IndexFaces
are sorted by the largest face bounding box size to the smallest size, in descending order.
MaxFaces
can be used with a collection associated with any version of the face model.
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetContentModerationRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetFaceDetectionRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetFaceSearchRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetLabelDetectionRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'GetPersonTrackingRequest$MaxResults' => 'Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
', 'ListStreamProcessorsRequest$MaxResults' => 'Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
', ], ], 'ModerationLabel' => [ 'base' => 'Provides information about a single type of moderated content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'ContentModerationDetection$ModerationLabel' => 'The moderation label detected by in the stored video.
', 'ModerationLabels$member' => NULL, ], ], 'ModerationLabels' => [ 'base' => NULL, 'refs' => [ 'DetectModerationLabelsResponse$ModerationLabels' => 'Array of detected Moderation labels and the time, in millseconds from the start of the video, they were detected.
', ], ], 'MouthOpen' => [ 'base' => 'Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$MouthOpen' => 'Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
', ], ], 'Mustache' => [ 'base' => 'Indicates whether or not the face has a mustache, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Mustache' => 'Indicates whether or not the face has a mustache, and the confidence level in the determination.
', ], ], 'NotificationChannel' => [ 'base' => 'The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
', 'refs' => [ 'StartCelebrityRecognitionRequest$NotificationChannel' => 'The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
', 'StartContentModerationRequest$NotificationChannel' => 'The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content moderation analysis to.
', 'StartFaceDetectionRequest$NotificationChannel' => 'The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
', 'StartFaceSearchRequest$NotificationChannel' => 'The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
', 'StartLabelDetectionRequest$NotificationChannel' => 'The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
', 'StartPersonTrackingRequest$NotificationChannel' => 'The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
', ], ], 'OrientationCorrection' => [ 'base' => NULL, 'refs' => [ 'CompareFacesResponse$SourceImageOrientationCorrection' => 'The value of SourceImageOrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'CompareFacesResponse$TargetImageOrientationCorrection' => 'The value of TargetImageOrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'DetectFacesResponse$OrientationCorrection' => 'The value of OrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'DetectLabelsResponse$OrientationCorrection' => 'The value of OrientationCorrection
is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
', 'IndexFacesResponse$OrientationCorrection' => 'If your collection is associated with a face detection model that\'s later than version 3.0, the value of OrientationCorrection
is always null and no orientation information is returned.
If your collection is associated with a face detection model that\'s version 3.0 or earlier, the following applies:
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image\'s orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata. The value of OrientationCorrection
is null.
If the image doesn\'t contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren\'t translated and represent the object locations before the image is rotated.
Bounding box information is returned in the FaceRecords
array. You can get the version of the face detection model by calling DescribeCollection.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces
and UnrecognizedFaces
represent face locations before the image orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image\'s orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection
is null. The CelebrityFaces
and UnrecognizedFaces
bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don\'t contain Exif metadata.
Maximum number of collection IDs to return.
', 'ListFacesRequest$MaxResults' => 'Maximum number of faces to return.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionRequest$NextToken' => 'If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.
', 'GetCelebrityRecognitionResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.
', 'GetContentModerationRequest$NextToken' => 'If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.
', 'GetContentModerationResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of moderation labels.
', 'GetFaceDetectionRequest$NextToken' => 'If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
', 'GetFaceDetectionResponse$NextToken' => 'If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
', 'GetFaceSearchRequest$NextToken' => 'If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.
', 'GetFaceSearchResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
', 'GetLabelDetectionRequest$NextToken' => 'If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.
', 'GetLabelDetectionResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.
', 'GetPersonTrackingRequest$NextToken' => 'If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
', 'GetPersonTrackingResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.
', 'ListCollectionsRequest$NextToken' => 'Pagination token from the previous response.
', 'ListCollectionsResponse$NextToken' => 'If the result is truncated, the response provides a NextToken
that you can use in the subsequent request to fetch the next set of collection IDs.
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
', 'ListStreamProcessorsRequest$NextToken' => 'If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.
', 'ListStreamProcessorsResponse$NextToken' => 'If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors.
', ], ], 'Parent' => [ 'base' => 'A parent label for a label. A label can have 0, 1, or more parents.
', 'refs' => [ 'Parents$member' => NULL, ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'Label$Parents' => 'The parent labels for a label. The response includes all ancestor labels.
', ], ], 'Percent' => [ 'base' => NULL, 'refs' => [ 'Beard$Confidence' => 'Level of confidence in the determination.
', 'Celebrity$MatchConfidence' => 'The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
', 'CelebrityDetail$Confidence' => 'The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
', 'CompareFacesMatch$Similarity' => 'Level of confidence that the faces match.
', 'CompareFacesRequest$SimilarityThreshold' => 'The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches
array.
Level of confidence that what the bounding box contains is a face.
', 'ComparedSourceImageFace$Confidence' => 'Confidence level that the selected bounding box contains a face.
', 'DetectLabelsRequest$MinConfidence' => 'Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn\'t return any labels with confidence lower than this specified value.
If MinConfidence
is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn\'t return any labels with a confidence level lower than this specified value.
If you don\'t specify MinConfidence
, the operation returns labels with confidence values greater than or equal to 50 percent.
Level of confidence in the determination.
', 'EyeOpen$Confidence' => 'Level of confidence in the determination.
', 'Eyeglasses$Confidence' => 'Level of confidence in the determination.
', 'Face$Confidence' => 'Confidence level that the bounding box contains a face (and not a different object such as a tree).
', 'FaceDetail$Confidence' => 'Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
', 'FaceMatch$Similarity' => 'Confidence in the match of this face with the input face.
', 'FaceSearchSettings$FaceMatchThreshold' => 'Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.
', 'Gender$Confidence' => 'Level of confidence in the determination.
', 'Instance$Confidence' => 'The confidence that Amazon Rekognition has in the accuracy of the bounding box.
', 'Label$Confidence' => 'Level of confidence.
', 'ModerationLabel$Confidence' => 'Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.
If you don\'t specify the MinConfidence
parameter in the call to DetectModerationLabels
, the operation returns labels with a confidence value greater than or equal to 50 percent.
Level of confidence in the determination.
', 'Mustache$Confidence' => 'Level of confidence in the determination.
', 'SearchFacesByImageRequest$FaceMatchThreshold' => '(Optional) Specifies the minimum confidence in the face match to return. For example, don\'t return any matches where confidence in matches is less than 70%.
', 'SearchFacesByImageResponse$SearchedFaceConfidence' => 'The level of confidence that the searchedFaceBoundingBox
, contains a face.
Optional value specifying the minimum confidence in the face match to return. For example, don\'t return any matches where confidence in matches is less than 70%.
', 'Smile$Confidence' => 'Level of confidence in the determination.
', 'StartContentModerationRequest$MinConfidence' => 'Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn\'t return any moderated content labels with a confidence level lower than this specified value. If you don\'t specify MinConfidence
, GetContentModeration
returns labels with confidence values greater than or equal to 50 percent.
The minimum confidence in the person match to return. For example, don\'t return any matches where confidence in matches is less than 70%.
', 'StartLabelDetectionRequest$MinConfidence' => 'Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn\'t return any labels with a confidence level lower than this specified value.
If you don\'t specify MinConfidence
, the operation returns labels with confidence values greater than or equal to 50 percent.
Level of confidence in the determination.
', 'TextDetection$Confidence' => 'The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
', ], ], 'PersonDetail' => [ 'base' => 'Details about a person detected in a video analysis request.
', 'refs' => [ 'PersonDetection$Person' => 'Details about a person whose path was tracked in a video.
', 'PersonMatch$Person' => 'Information about the matched person.
', ], ], 'PersonDetection' => [ 'base' => 'Details and path tracking information for a single time a person\'s path is tracked in a video. Amazon Rekognition operations that track people\'s paths return an array of PersonDetection
objects with elements for each time a person\'s path is tracked in a video.
For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'PersonDetections$member' => NULL, ], ], 'PersonDetections' => [ 'base' => NULL, 'refs' => [ 'GetPersonTrackingResponse$Persons' => 'An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person\'s path is tracked.
', ], ], 'PersonIndex' => [ 'base' => NULL, 'refs' => [ 'PersonDetail$Index' => 'Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.
', ], ], 'PersonMatch' => [ 'base' => 'Information about a person whose face matches a face(s) in an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch
objects is returned by GetFaceSearch.
An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch
. Each Persons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.
Sort to use for elements in the Persons
array. Use TIMESTAMP
to sort array elements by the time persons are detected. Use INDEX
to sort by the tracked persons. If you sort by INDEX
, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP
.
The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.
An array of Point
objects, Polygon
, is returned by DetectText. Polygon
represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Rekognition Developer Guide.
Within the bounding box, a fine-grained polygon around the detected text.
', ], ], 'Pose' => [ 'base' => 'Indicates the pose of the face as determined by its pitch, roll, and yaw.
', 'refs' => [ 'ComparedFace$Pose' => 'Indicates the pose of the face as determined by its pitch, roll, and yaw.
', 'FaceDetail$Pose' => 'Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
', ], ], 'ProvisionedThroughputExceededException' => [ 'base' => 'The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
', 'refs' => [], ], 'QualityFilter' => [ 'base' => NULL, 'refs' => [ 'IndexFacesRequest$QualityFilter' => 'A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered faces aren\'t indexed. If you specify AUTO
, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that\'s misidentified as a face, a face that\'s too blurry, or a face with a pose that\'s too extreme to use. If you specify NONE
, no filtering is performed. The default value is AUTO.
To use quality filtering, the collection you are using must be associated with version 3 of the face model.
', ], ], 'Reason' => [ 'base' => NULL, 'refs' => [ 'Reasons$member' => NULL, ], ], 'Reasons' => [ 'base' => NULL, 'refs' => [ 'UnindexedFace$Reasons' => 'An array of reasons that specify why a face wasn\'t indexed.
EXTREME_POSE - The face is at a pose that can\'t be detected. For example, the head is turned too far away from the camera.
EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces
input parameter for IndexFaces
.
LOW_BRIGHTNESS - The image is too dark.
LOW_SHARPNESS - The image is too blurry.
LOW_CONFIDENCE - The face was detected with a low confidence.
SMALL_BOUNDING_BOX - The bounding box around the face is too small.
A unique identifier for the celebrity.
', 'CelebrityDetail$Id' => 'The unique identifier for the celebrity.
', 'GetCelebrityInfoRequest$Id' => 'The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'A collection with the specified ID already exists.
', 'refs' => [], ], 'ResourceInUseException' => [ 'base' => '', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The collection specified in the request cannot be found.
', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateStreamProcessorRequest$RoleArn' => 'ARN of the IAM role that allows access to the stream processor.
', 'DescribeStreamProcessorResponse$RoleArn' => 'ARN of the IAM role that allows access to the stream processor.
', 'NotificationChannel$RoleArn' => 'The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.
', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'S3Object$Bucket' => 'Name of the S3 bucket.
', ], ], 'S3Object' => [ 'base' => 'Provides the S3 bucket name and object name.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'Image$S3Object' => 'Identifies an S3 object as the image source.
', 'Video$S3Object' => 'The Amazon S3 bucket name and file name for the video.
', ], ], 'S3ObjectName' => [ 'base' => NULL, 'refs' => [ 'S3Object$Name' => 'S3 object key name.
', ], ], 'S3ObjectVersion' => [ 'base' => NULL, 'refs' => [ 'S3Object$Version' => 'If the bucket is versioning enabled, you can specify the object version.
', ], ], 'SNSTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationChannel$SNSTopicArn' => 'The Amazon SNS topic to which Amazon Rekognition to posts the completion status.
', ], ], 'SearchFacesByImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchFacesByImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchFacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchFacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'Smile' => [ 'base' => 'Indicates whether or not the face is smiling, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Smile' => 'Indicates whether or not the face is smiling, and the confidence level in the determination.
', ], ], 'StartCelebrityRecognitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCelebrityRecognitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContentModerationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContentModerationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceSearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFaceSearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartLabelDetectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartLabelDetectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartPersonTrackingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPersonTrackingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartStreamProcessorRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartStreamProcessorResponse' => [ 'base' => NULL, 'refs' => [], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionResponse$StatusMessage' => 'If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
If the job fails, StatusMessage
provides a descriptive error message.
An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor
describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.
ARN for the newly create stream processor.
', 'DescribeStreamProcessorResponse$StreamProcessorArn' => 'ARN of the stream processor.
', ], ], 'StreamProcessorInput' => [ 'base' => 'Information about the source streaming video.
', 'refs' => [ 'CreateStreamProcessorRequest$Input' => 'Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput
.
Kinesis video stream that provides the source streaming video.
', ], ], 'StreamProcessorList' => [ 'base' => NULL, 'refs' => [ 'ListStreamProcessorsResponse$StreamProcessors' => 'List of stream processors that you have created.
', ], ], 'StreamProcessorName' => [ 'base' => NULL, 'refs' => [ 'CreateStreamProcessorRequest$Name' => 'An identifier you assign to the stream processor. You can use Name
to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name
is idempotent.
The name of the stream processor you want to delete.
', 'DescribeStreamProcessorRequest$Name' => 'Name of the stream processor for which you want information.
', 'DescribeStreamProcessorResponse$Name' => 'Name of the stream processor.
', 'StartStreamProcessorRequest$Name' => 'The name of the stream processor to start processing.
', 'StopStreamProcessorRequest$Name' => 'The name of a stream processor created by CreateStreamProcessor.
', 'StreamProcessor$Name' => 'Name of the Amazon Rekognition stream processor.
', ], ], 'StreamProcessorOutput' => [ 'base' => 'Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'CreateStreamProcessorRequest$Output' => 'Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput
.
Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
', ], ], 'StreamProcessorSettings' => [ 'base' => 'Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.
', 'refs' => [ 'CreateStreamProcessorRequest$Settings' => 'Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
', 'DescribeStreamProcessorResponse$Settings' => 'Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
', ], ], 'StreamProcessorStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStreamProcessorResponse$Status' => 'Current status of the stream processor.
', 'StreamProcessor$Status' => 'Current status of the Amazon Rekognition stream processor.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Celebrity$Name' => 'The name of the celebrity.
', 'CelebrityDetail$Name' => 'The name of the celebrity.
', 'CreateCollectionResponse$CollectionArn' => 'Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
', 'CreateCollectionResponse$FaceModelVersion' => 'Version number of the face detection model associated with the collection you are creating.
', 'DescribeCollectionResponse$FaceModelVersion' => 'The version of the face model that\'s used by the collection for face detection.
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
', 'DescribeCollectionResponse$CollectionARN' => 'The Amazon Resource Name (ARN) of the collection.
', 'DescribeStreamProcessorResponse$StatusMessage' => 'Detailed status message about the stream processor.
', 'DetectLabelsResponse$LabelModelVersion' => 'Version number of the label detection model that was used to detect labels.
', 'DetectModerationLabelsResponse$ModerationModelVersion' => 'Version number of the moderation detection model that was used to detect unsafe content.
', 'FaceModelVersionList$member' => NULL, 'GetCelebrityInfoResponse$Name' => 'The name of the celebrity.
', 'GetLabelDetectionResponse$LabelModelVersion' => 'Version number of the label detection model that was used to detect labels.
', 'IndexFacesResponse$FaceModelVersion' => 'The version number of the face detection model that\'s associated with the input collection (CollectionId
).
The name (label) of the object or scene.
', 'ListFacesResponse$NextToken' => 'If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
', 'ListFacesResponse$FaceModelVersion' => 'Version number of the face detection model associated with the input collection (CollectionId
).
The label name for the type of content detected in the image.
', 'ModerationLabel$ParentName' => 'The name for the parent label. Labels at the top level of the hierarchy have the parent label ""
.
The name of the parent label.
', 'SearchFacesByImageResponse$FaceModelVersion' => 'Version number of the face detection model associated with the input collection (CollectionId
).
Version number of the face detection model associated with the input collection (CollectionId
).
The word or line of text recognized by Amazon Rekognition.
', 'VideoMetadata$Codec' => 'Type of compression used in the analyzed video.
', 'VideoMetadata$Format' => 'Format of the analyzed video. Possible values are MP4, MOV and AVI.
', ], ], 'Sunglasses' => [ 'base' => 'Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
', 'refs' => [ 'FaceDetail$Sunglasses' => 'Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
', ], ], 'TextDetection' => [ 'base' => 'Information about a word or line of text detected by DetectText.
The DetectedText
field contains the text that Amazon Rekognition detected in the image.
Every word and line has an identifier (Id
). Each word belongs to a line and has a parent identifier (ParentId
) that identifies the line of text in which the word appears. The word Id
is also an index for the word within a line of words.
For more information, see Detecting Text in the Amazon Rekognition Developer Guide.
', 'refs' => [ 'TextDetectionList$member' => NULL, ], ], 'TextDetectionList' => [ 'base' => NULL, 'refs' => [ 'DetectTextResponse$TextDetections' => 'An array of text that was detected in the input image.
', ], ], 'TextTypes' => [ 'base' => NULL, 'refs' => [ 'TextDetection$Type' => 'The type of text that was detected.
', ], ], 'ThrottlingException' => [ 'base' => 'Amazon Rekognition is temporarily unable to process the request. Try your call again.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'CelebrityRecognition$Timestamp' => 'The time, in milliseconds from the start of the video, that the celebrity was recognized.
', 'ContentModerationDetection$Timestamp' => 'Time, in milliseconds from the beginning of the video, that the moderation label was detected.
', 'FaceDetection$Timestamp' => 'Time, in milliseconds from the start of the video, that the face was detected.
', 'LabelDetection$Timestamp' => 'Time, in milliseconds from the start of the video, that the label was detected.
', 'PersonDetection$Timestamp' => 'The time, in milliseconds from the start of the video, that the person\'s path was tracked.
', 'PersonMatch$Timestamp' => 'The time, in milliseconds from the beginning of the video, that the person was matched in the video.
', ], ], 'UInteger' => [ 'base' => NULL, 'refs' => [ 'AgeRange$Low' => 'The lowest estimated age.
', 'AgeRange$High' => 'The highest estimated age.
', 'CreateCollectionResponse$StatusCode' => 'HTTP status code indicating the result of the operation.
', 'DeleteCollectionResponse$StatusCode' => 'HTTP status code that indicates the result of the operation.
', 'DetectLabelsRequest$MaxLabels' => 'Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.
', 'TextDetection$Id' => 'The identifier for the detected text. The identifier is only unique for a single call to DetectText
.
The Parent identifier for the detected text identified by the value of ID
. If the type of detected text is LINE
, the value of ParentId
is Null
.
The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
', 'VideoMetadata$DurationMillis' => 'Length of the video in milliseconds.
', 'VideoMetadata$FrameHeight' => 'Vertical pixel dimension of the video.
', 'VideoMetadata$FrameWidth' => 'Horizontal pixel dimension of the video.
', ], ], 'UnindexedFace' => [ 'base' => 'A face that IndexFaces detected, but didn\'t index. Use the Reasons
response attribute to determine why a face wasn\'t indexed.
An array of faces that were detected in the image but weren\'t indexed. They weren\'t indexed because the quality filter identified them as low quality, or the MaxFaces
request parameter filtered them out. To use the quality filter, you specify the QualityFilter
request parameter.
An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
', 'CelebrityDetail$Urls' => 'An array of URLs pointing to additional celebrity information.
', 'GetCelebrityInfoResponse$Urls' => 'An array of URLs pointing to additional celebrity information.
', ], ], 'Video' => [ 'base' => 'Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video
to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
', 'StartContentModerationRequest$Video' => 'The video in which you want to moderate content. The video must be stored in an Amazon S3 bucket.
', 'StartFaceDetectionRequest$Video' => 'The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
', 'StartFaceSearchRequest$Video' => 'The video you want to search. The video must be stored in an Amazon S3 bucket.
', 'StartLabelDetectionRequest$Video' => 'The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
', 'StartPersonTrackingRequest$Video' => 'The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
', ], ], 'VideoJobStatus' => [ 'base' => NULL, 'refs' => [ 'GetCelebrityRecognitionResponse$JobStatus' => 'The current status of the celebrity recognition job.
', 'GetContentModerationResponse$JobStatus' => 'The current status of the content moderation job.
', 'GetFaceDetectionResponse$JobStatus' => 'The current status of the face detection job.
', 'GetFaceSearchResponse$JobStatus' => 'The current status of the face search job.
', 'GetLabelDetectionResponse$JobStatus' => 'The current status of the label detection job.
', 'GetPersonTrackingResponse$JobStatus' => 'The current status of the person tracking job.
', ], ], 'VideoMetadata' => [ 'base' => 'Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.
Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in every page of paginated responses from GetContentModeration
.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.
Information about a video that Amazon Rekognition analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.
Information about a video that Amazon Rekognition Video analyzed. Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.
The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.
', 'refs' => [], ], ],];