From 943f90491585a44111bbf460eea74b50ffd82935 Mon Sep 17 00:00:00 2001 From: AwsSdkPhpAutomation Date: Thu, 7 Mar 2019 19:34:29 +0000 Subject: [PATCH] Update models for release --- .changes/3.89.0 | 42 + .../nextrelease/stream_wrapper_fixes.json | 7 - CHANGELOG.md | 11 + src/AppMesh/AppMeshClient.php | 10 + src/data/appmesh/2019-01-25/api-2.json | 2600 +++++++++++++++++ src/data/appmesh/2019-01-25/api-2.json.php | 3 + src/data/appmesh/2019-01-25/docs-2.json | 807 +++++ src/data/appmesh/2019-01-25/docs-2.json.php | 3 + src/data/appmesh/2019-01-25/examples-1.json | 4 + .../appmesh/2019-01-25/examples-1.json.php | 3 + src/data/appmesh/2019-01-25/paginators-1.json | 34 + .../appmesh/2019-01-25/paginators-1.json.php | 3 + src/data/autoscaling/2011-01-01/docs-2.json | 300 +- .../autoscaling/2011-01-01/docs-2.json.php | 2 +- src/data/ecs/2014-11-13/api-2.json | 50 +- src/data/ecs/2014-11-13/api-2.json.php | 2 +- src/data/ecs/2014-11-13/docs-2.json | 48 +- src/data/ecs/2014-11-13/docs-2.json.php | 2 +- src/data/endpoints.json | 8 + src/data/endpoints.json.php | 2 +- src/data/gamelift/2015-10-01/api-2.json | 6 +- src/data/gamelift/2015-10-01/api-2.json.php | 2 +- src/data/gamelift/2015-10-01/docs-2.json | 46 +- src/data/gamelift/2015-10-01/docs-2.json.php | 2 +- src/data/greengrass/2017-06-07/api-2.json | 3 + src/data/greengrass/2017-06-07/api-2.json.php | 2 +- src/data/greengrass/2017-06-07/docs-2.json | 25 +- .../greengrass/2017-06-07/docs-2.json.php | 2 +- src/data/manifest.json | 3 +- src/data/manifest.json.php | 2 +- src/data/medialive/2017-10-14/api-2.json | 44 + src/data/medialive/2017-10-14/api-2.json.php | 2 +- src/data/medialive/2017-10-14/docs-2.json | 32 +- src/data/medialive/2017-10-14/docs-2.json.php | 2 +- src/data/rds/2014-10-31/api-2.json | 18 +- src/data/rds/2014-10-31/api-2.json.php | 2 +- src/data/rds/2014-10-31/docs-2.json | 294 +- src/data/rds/2014-10-31/docs-2.json.php | 2 +- 38 files changed, 4064 insertions(+), 366 deletions(-) create mode 100644 .changes/3.89.0 delete mode 100644 .changes/nextrelease/stream_wrapper_fixes.json create mode 100644 src/data/appmesh/2019-01-25/api-2.json create mode 100644 src/data/appmesh/2019-01-25/api-2.json.php create mode 100644 src/data/appmesh/2019-01-25/docs-2.json create mode 100644 src/data/appmesh/2019-01-25/docs-2.json.php create mode 100644 src/data/appmesh/2019-01-25/examples-1.json create mode 100644 src/data/appmesh/2019-01-25/examples-1.json.php create mode 100644 src/data/appmesh/2019-01-25/paginators-1.json create mode 100644 src/data/appmesh/2019-01-25/paginators-1.json.php diff --git a/.changes/3.89.0 b/.changes/3.89.0 new file mode 100644 index 0000000000..94f9fbf0aa --- /dev/null +++ b/.changes/3.89.0 @@ -0,0 +1,42 @@ +[ + { + "type": "feature", + "category": "S3", + "description": "Updates the S3 stream wrapper to be able to write empty files for PHP 7+." + }, + { + "type": "api-change", + "category": "Greengrass", + "description": "Greengrass group UID and GID settings can now be configured to use a provided default via FunctionDefaultConfig. If configured, all Lambda processes in your deployed Greengrass group will by default start with the provided UID and\/or GID, rather than by default starting with UID \"ggc_user\" and GID \"ggc_group\" as they would if not configured. Individual Lambdas can also be configured to override the defaults if desired via each object in the Functions list of your FunctionDefinitionVersion." + }, + { + "type": "api-change", + "category": "RDS", + "description": "You can configure your Aurora database cluster to automatically copy tags on the cluster to any automated or manual database cluster snapshots that are created from the cluster. This allows you to easily set metadata on your snapshots to match the parent cluster, including access policies. You may enable or disable this functionality while creating a new cluster, or by modifying an existing database cluster." + }, + { + "type": "enhancement", + "category": "AutoScaling", + "description": "Documentation updates for autoscaling" + }, + { + "type": "api-change", + "category": "MediaLive", + "description": "This release adds a MediaPackage output group, simplifying configuration of outputs to AWS Elemental MediaPackage." + }, + { + "type": "api-change", + "category": "GameLift", + "description": "Amazon GameLift-hosted instances can now securely access resources on other AWS services using IAM roles. See more details at https:\/\/aws.amazon.com\/releasenotes\/amazon-gamelift\/." + }, + { + "type": "api-change", + "category": "ECS", + "description": "This release of Amazon Elastic Container Service (Amazon ECS) introduces additional task definition parameters that enable you to define dependencies for container startup and shutdown, a per-container start and stop timeout value, as well as an AWS App Mesh proxy configuration which eases the integration between Amazon ECS and AWS App Mesh." + }, + { + "type": "api-change", + "category": "AppMesh", + "description": "This release includes a new version of the AWS App Mesh APIs. You can read more about the new APIs here: https:\/\/docs.aws.amazon.com\/app-mesh\/latest\/APIReference\/Welcome.html." + } +] \ No newline at end of file diff --git a/.changes/nextrelease/stream_wrapper_fixes.json b/.changes/nextrelease/stream_wrapper_fixes.json deleted file mode 100644 index 8d79d0099f..0000000000 --- a/.changes/nextrelease/stream_wrapper_fixes.json +++ /dev/null @@ -1,7 +0,0 @@ -[ - { - "type": "feature", - "category": "S3", - "description": "Updates the S3 stream wrapper to be able to write empty files for PHP 7+." - } -] \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index aa89d5c71e..a544d19d8e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # CHANGELOG +## next release + +* `Aws\AppMesh` - This release includes a new version of the AWS App Mesh APIs. You can read more about the new APIs here: https://docs.aws.amazon.com/app-mesh/latest/APIReference/Welcome.html. +* `Aws\AutoScaling` - Documentation updates for autoscaling +* `Aws\ECS` - This release of Amazon Elastic Container Service (Amazon ECS) introduces additional task definition parameters that enable you to define dependencies for container startup and shutdown, a per-container start and stop timeout value, as well as an AWS App Mesh proxy configuration which eases the integration between Amazon ECS and AWS App Mesh. +* `Aws\GameLift` - Amazon GameLift-hosted instances can now securely access resources on other AWS services using IAM roles. See more details at https://aws.amazon.com/releasenotes/amazon-gamelift/. +* `Aws\Greengrass` - Greengrass group UID and GID settings can now be configured to use a provided default via FunctionDefaultConfig. If configured, all Lambda processes in your deployed Greengrass group will by default start with the provided UID and/or GID, rather than by default starting with UID "ggc_user" and GID "ggc_group" as they would if not configured. Individual Lambdas can also be configured to override the defaults if desired via each object in the Functions list of your FunctionDefinitionVersion. +* `Aws\MediaLive` - This release adds a MediaPackage output group, simplifying configuration of outputs to AWS Elemental MediaPackage. +* `Aws\RDS` - You can configure your Aurora database cluster to automatically copy tags on the cluster to any automated or manual database cluster snapshots that are created from the cluster. This allows you to easily set metadata on your snapshots to match the parent cluster, including access policies. You may enable or disable this functionality while creating a new cluster, or by modifying an existing database cluster. +* `Aws\S3` - Updates the S3 stream wrapper to be able to write empty files for PHP 7+. + ## 3.88.1 - 2019-03-06 * `Aws\DirectConnect` - Exposed a new available port speeds field in the DescribeLocation api call. diff --git a/src/AppMesh/AppMeshClient.php b/src/AppMesh/AppMeshClient.php index 71973e7493..479b832c0d 100644 --- a/src/AppMesh/AppMeshClient.php +++ b/src/AppMesh/AppMeshClient.php @@ -43,5 +43,15 @@ * @method \GuzzleHttp\Promise\Promise updateVirtualNodeAsync(array $args = []) * @method \Aws\Result updateVirtualRouter(array $args = []) * @method \GuzzleHttp\Promise\Promise updateVirtualRouterAsync(array $args = []) + * @method \Aws\Result createVirtualService(array $args = []) (supported in versions 2019-01-25) + * @method \GuzzleHttp\Promise\Promise createVirtualServiceAsync(array $args = []) (supported in versions 2019-01-25) + * @method \Aws\Result deleteVirtualService(array $args = []) (supported in versions 2019-01-25) + * @method \GuzzleHttp\Promise\Promise deleteVirtualServiceAsync(array $args = []) (supported in versions 2019-01-25) + * @method \Aws\Result describeVirtualService(array $args = []) (supported in versions 2019-01-25) + * @method \GuzzleHttp\Promise\Promise describeVirtualServiceAsync(array $args = []) (supported in versions 2019-01-25) + * @method \Aws\Result listVirtualServices(array $args = []) (supported in versions 2019-01-25) + * @method \GuzzleHttp\Promise\Promise listVirtualServicesAsync(array $args = []) (supported in versions 2019-01-25) + * @method \Aws\Result updateVirtualService(array $args = []) (supported in versions 2019-01-25) + * @method \GuzzleHttp\Promise\Promise updateVirtualServiceAsync(array $args = []) (supported in versions 2019-01-25) */ class AppMeshClient extends AwsClient {} diff --git a/src/data/appmesh/2019-01-25/api-2.json b/src/data/appmesh/2019-01-25/api-2.json new file mode 100644 index 0000000000..8496d61e5a --- /dev/null +++ b/src/data/appmesh/2019-01-25/api-2.json @@ -0,0 +1,2600 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-01-25", + "endpointPrefix": "appmesh", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS App Mesh", + "serviceId": "App Mesh", + "signatureVersion": "v4", + "signingName": "appmesh", + "uid": "appmesh-2019-01-25" + }, + "operations": { + "CreateMesh": { + "name": "CreateMesh", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes", + "responseCode": 200 + }, + "input": { + "shape": "CreateMeshInput" + }, + "output": { + "shape": "CreateMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "CreateRoute": { + "name": "CreateRoute", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "shape": "CreateRouteInput" + }, + "output": { + "shape": "CreateRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "CreateVirtualNode": { + "name": "CreateVirtualNode", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualNodeInput" + }, + "output": { + "shape": "CreateVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "CreateVirtualRouter": { + "name": "CreateVirtualRouter", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualRouterInput" + }, + "output": { + "shape": "CreateVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "CreateVirtualService": { + "name": "CreateVirtualService", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualServiceInput" + }, + "output": { + "shape": "CreateVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "DeleteMesh": { + "name": "DeleteMesh", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteMeshInput" + }, + "output": { + "shape": "DeleteMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "DeleteRoute": { + "name": "DeleteRoute", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteRouteInput" + }, + "output": { + "shape": "DeleteRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "DeleteVirtualNode": { + "name": "DeleteVirtualNode", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualNodeInput" + }, + "output": { + "shape": "DeleteVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "DeleteVirtualRouter": { + "name": "DeleteVirtualRouter", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualRouterInput" + }, + "output": { + "shape": "DeleteVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "DeleteVirtualService": { + "name": "DeleteVirtualService", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualServiceInput" + }, + "output": { + "shape": "DeleteVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "DescribeMesh": { + "name": "DescribeMesh", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeMeshInput" + }, + "output": { + "shape": "DescribeMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "DescribeRoute": { + "name": "DescribeRoute", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeRouteInput" + }, + "output": { + "shape": "DescribeRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "DescribeVirtualNode": { + "name": "DescribeVirtualNode", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualNodeInput" + }, + "output": { + "shape": "DescribeVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "DescribeVirtualRouter": { + "name": "DescribeVirtualRouter", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualRouterInput" + }, + "output": { + "shape": "DescribeVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "DescribeVirtualService": { + "name": "DescribeVirtualService", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualServiceInput" + }, + "output": { + "shape": "DescribeVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "ListMeshes": { + "name": "ListMeshes", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes", + "responseCode": 200 + }, + "input": { + "shape": "ListMeshesInput" + }, + "output": { + "shape": "ListMeshesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "ListRoutes": { + "name": "ListRoutes", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "shape": "ListRoutesInput" + }, + "output": { + "shape": "ListRoutesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "ListVirtualNodes": { + "name": "ListVirtualNodes", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualNodesInput" + }, + "output": { + "shape": "ListVirtualNodesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "ListVirtualRouters": { + "name": "ListVirtualRouters", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualRoutersInput" + }, + "output": { + "shape": "ListVirtualRoutersOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "ListVirtualServices": { + "name": "ListVirtualServices", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualServicesInput" + }, + "output": { + "shape": "ListVirtualServicesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ] + }, + "UpdateRoute": { + "name": "UpdateRoute", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateRouteInput" + }, + "output": { + "shape": "UpdateRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "UpdateVirtualNode": { + "name": "UpdateVirtualNode", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualNodeInput" + }, + "output": { + "shape": "UpdateVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "UpdateVirtualRouter": { + "name": "UpdateVirtualRouter", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualRouterInput" + }, + "output": { + "shape": "UpdateVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + }, + "UpdateVirtualService": { + "name": "UpdateVirtualService", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualServiceInput" + }, + "output": { + "shape": "UpdateVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "idempotent": true + } + }, + "shapes": { + "VirtualRouterListener": { + "type": "structure", + "required": [ + "portMapping" + ], + "members": { + "portMapping": { + "shape": "PortMapping" + } + } + }, + "UpdateVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualNodeSpec" + }, + "virtualNodeName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "DeleteMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + } + } + }, + "CreateVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualServiceName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualServiceSpec" + }, + "virtualServiceName": { + "shape": "ServiceName" + } + } + }, + "VirtualRouterStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "UpdateVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualRouterSpec" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "CreateVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData" + } + }, + "payload": "virtualNode" + }, + "ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "ServiceUnavailableException", + "httpStatusCode": 503, + "fault": true + } + }, + "Long": { + "type": "long", + "box": true + }, + "UpdateVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData" + } + }, + "payload": "virtualRouter" + }, + "DescribeMeshOutput": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "MeshData" + } + }, + "payload": "mesh" + }, + "DeleteVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "ListVirtualRoutersOutput": { + "type": "structure", + "required": [ + "virtualRouters" + ], + "members": { + "nextToken": { + "shape": "String" + }, + "virtualRouters": { + "shape": "VirtualRouterList" + } + } + }, + "DescribeRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "DeleteRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData" + } + }, + "payload": "route" + }, + "ResourceMetadata": { + "type": "structure", + "required": [ + "arn", + "createdAt", + "lastUpdatedAt", + "uid", + "version" + ], + "members": { + "arn": { + "shape": "Arn" + }, + "createdAt": { + "shape": "Timestamp" + }, + "lastUpdatedAt": { + "shape": "Timestamp" + }, + "uid": { + "shape": "String" + }, + "version": { + "shape": "Long" + } + } + }, + "Listeners": { + "type": "list", + "member": { + "shape": "Listener" + } + }, + "Backends": { + "type": "list", + "member": { + "shape": "Backend" + } + }, + "ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "ResourceInUseException", + "httpStatusCode": 409, + "senderFault": true + } + }, + "PortProtocol": { + "type": "string", + "enum": [ + "http", + "tcp" + ] + }, + "UpdateVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData" + } + }, + "payload": "virtualNode" + }, + "ListRoutesOutput": { + "type": "structure", + "required": [ + "routes" + ], + "members": { + "nextToken": { + "shape": "String" + }, + "routes": { + "shape": "RouteList" + } + } + }, + "VirtualServiceBackend": { + "type": "structure", + "required": [ + "virtualServiceName" + ], + "members": { + "virtualServiceName": { + "shape": "ServiceName" + } + } + }, + "VirtualNodeStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "ServiceName": { + "type": "string" + }, + "BadRequestException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "BadRequestException", + "httpStatusCode": 400, + "senderFault": true + } + }, + "UpdateVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualServiceName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualServiceSpec" + }, + "virtualServiceName": { + "shape": "ServiceName", + "location": "uri", + "locationName": "virtualServiceName" + } + } + }, + "HealthCheckThreshold": { + "type": "integer", + "min": 2, + "max": 10 + }, + "UpdateRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData" + } + }, + "payload": "route" + }, + "PercentInt": { + "type": "integer", + "min": 0, + "max": 100 + }, + "HttpRouteAction": { + "type": "structure", + "required": [ + "weightedTargets" + ], + "members": { + "weightedTargets": { + "shape": "WeightedTargets" + } + } + }, + "ListRoutesInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "limit": { + "shape": "ListRoutesLimit", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "HealthCheckPolicy": { + "type": "structure", + "required": [ + "healthyThreshold", + "intervalMillis", + "protocol", + "timeoutMillis", + "unhealthyThreshold" + ], + "members": { + "healthyThreshold": { + "shape": "HealthCheckThreshold" + }, + "intervalMillis": { + "shape": "HealthCheckIntervalMillis" + }, + "path": { + "shape": "String" + }, + "port": { + "shape": "PortNumber" + }, + "protocol": { + "shape": "PortProtocol" + }, + "timeoutMillis": { + "shape": "HealthCheckTimeoutMillis" + }, + "unhealthyThreshold": { + "shape": "HealthCheckThreshold" + } + } + }, + "VirtualServiceRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualServiceName" + ], + "members": { + "arn": { + "shape": "Arn" + }, + "meshName": { + "shape": "ResourceName" + }, + "virtualServiceName": { + "shape": "ServiceName" + } + } + }, + "VirtualServiceList": { + "type": "list", + "member": { + "shape": "VirtualServiceRef" + } + }, + "VirtualNodeStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "VirtualNodeStatusCode" + } + } + }, + "VirtualRouterRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualRouterName" + ], + "members": { + "arn": { + "shape": "Arn" + }, + "meshName": { + "shape": "ResourceName" + }, + "virtualRouterName": { + "shape": "ResourceName" + } + } + }, + "VirtualServiceData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualServiceName" + ], + "members": { + "meshName": { + "shape": "ResourceName" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "spec": { + "shape": "VirtualServiceSpec" + }, + "status": { + "shape": "VirtualServiceStatus" + }, + "virtualServiceName": { + "shape": "ServiceName" + } + } + }, + "DescribeVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData" + } + }, + "payload": "virtualService" + }, + "VirtualNodeRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualNodeName" + ], + "members": { + "arn": { + "shape": "Arn" + }, + "meshName": { + "shape": "ResourceName" + }, + "virtualNodeName": { + "shape": "ResourceName" + } + } + }, + "CreateMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName" + } + } + }, + "DescribeVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData" + } + }, + "payload": "virtualNode" + }, + "LimitExceededException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "LimitExceededException", + "httpStatusCode": 400, + "senderFault": true + } + }, + "CreateRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData" + } + }, + "payload": "route" + }, + "DnsServiceDiscovery": { + "type": "structure", + "required": [ + "hostname" + ], + "members": { + "hostname": { + "shape": "Hostname" + } + } + }, + "DescribeVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "virtualServiceName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "virtualServiceName": { + "shape": "ServiceName", + "location": "uri", + "locationName": "virtualServiceName" + } + } + }, + "ListVirtualServicesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "DeleteRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "VirtualNodeData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "spec": { + "shape": "VirtualNodeSpec" + }, + "status": { + "shape": "VirtualNodeStatus" + }, + "virtualNodeName": { + "shape": "ResourceName" + } + } + }, + "VirtualServiceSpec": { + "type": "structure", + "members": { + "provider": { + "shape": "VirtualServiceProvider" + } + } + }, + "Backend": { + "type": "structure", + "members": { + "virtualService": { + "shape": "VirtualServiceBackend" + } + } + }, + "ListVirtualRoutersLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "HealthCheckIntervalMillis": { + "type": "long", + "box": true, + "min": 5000, + "max": 300000 + }, + "VirtualRouterList": { + "type": "list", + "member": { + "shape": "VirtualRouterRef" + } + }, + "ListMeshesInput": { + "type": "structure", + "members": { + "limit": { + "shape": "ListMeshesLimit", + "location": "querystring", + "locationName": "limit" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "Arn": { + "type": "string" + }, + "VirtualNodeList": { + "type": "list", + "member": { + "shape": "VirtualNodeRef" + } + }, + "ListVirtualRoutersInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualRoutersLimit", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "VirtualRouterData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "spec": { + "shape": "VirtualRouterSpec" + }, + "status": { + "shape": "VirtualRouterStatus" + }, + "virtualRouterName": { + "shape": "ResourceName" + } + } + }, + "ListVirtualServicesInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualServicesLimit", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "CreateVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualRouterSpec" + }, + "virtualRouterName": { + "shape": "ResourceName" + } + } + }, + "ListVirtualNodesInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualNodesLimit", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "DescribeVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData" + } + }, + "payload": "virtualRouter" + }, + "CreateMeshOutput": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "MeshData" + } + }, + "payload": "mesh" + }, + "CreateVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData" + } + }, + "payload": "virtualRouter" + }, + "VirtualServiceStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "VirtualServiceStatusCode" + } + } + }, + "ListVirtualNodesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "HealthCheckTimeoutMillis": { + "type": "long", + "box": true, + "min": 2000, + "max": 60000 + }, + "ListMeshesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "ResourceName": { + "type": "string", + "min": 1, + "max": 255 + }, + "VirtualRouterSpec": { + "type": "structure", + "required": [ + "listeners" + ], + "members": { + "listeners": { + "shape": "VirtualRouterListeners" + } + } + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "TooManyRequestsException", + "httpStatusCode": 429, + "senderFault": true + } + }, + "Timestamp": { + "type": "timestamp" + }, + "VirtualNodeSpec": { + "type": "structure", + "members": { + "backends": { + "shape": "Backends" + }, + "listeners": { + "shape": "Listeners" + }, + "serviceDiscovery": { + "shape": "ServiceDiscovery" + } + } + }, + "ListMeshesOutput": { + "type": "structure", + "required": [ + "meshes" + ], + "members": { + "meshes": { + "shape": "MeshList" + }, + "nextToken": { + "shape": "String" + } + } + }, + "VirtualRouterListeners": { + "type": "list", + "member": { + "shape": "VirtualRouterListener" + } + }, + "ConflictException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "ConflictException", + "httpStatusCode": 409, + "senderFault": true + } + }, + "DescribeRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData" + } + }, + "payload": "route" + }, + "HttpRouteMatch": { + "type": "structure", + "required": [ + "prefix" + ], + "members": { + "prefix": { + "shape": "String" + } + } + }, + "MeshList": { + "type": "list", + "member": { + "shape": "MeshRef" + } + }, + "MeshRef": { + "type": "structure", + "required": [ + "arn", + "meshName" + ], + "members": { + "arn": { + "shape": "Arn" + }, + "meshName": { + "shape": "ResourceName" + } + } + }, + "MeshStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "PortMapping": { + "type": "structure", + "required": [ + "port", + "protocol" + ], + "members": { + "port": { + "shape": "PortNumber" + }, + "protocol": { + "shape": "PortProtocol" + } + } + }, + "MeshData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "status" + ], + "members": { + "meshName": { + "shape": "ResourceName" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "status": { + "shape": "MeshStatus" + } + } + }, + "VirtualRouterStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "VirtualRouterStatusCode" + } + } + }, + "ListVirtualServicesOutput": { + "type": "structure", + "required": [ + "virtualServices" + ], + "members": { + "nextToken": { + "shape": "String" + }, + "virtualServices": { + "shape": "VirtualServiceList" + } + } + }, + "WeightedTarget": { + "type": "structure", + "required": [ + "virtualNode", + "weight" + ], + "members": { + "virtualNode": { + "shape": "ResourceName" + }, + "weight": { + "shape": "PercentInt" + } + } + }, + "DescribeVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "RouteStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "RouteStatusCode" + } + } + }, + "RouteRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "arn": { + "shape": "Arn" + }, + "meshName": { + "shape": "ResourceName" + }, + "routeName": { + "shape": "ResourceName" + }, + "virtualRouterName": { + "shape": "ResourceName" + } + } + }, + "Listener": { + "type": "structure", + "required": [ + "portMapping" + ], + "members": { + "healthCheck": { + "shape": "HealthCheckPolicy" + }, + "portMapping": { + "shape": "PortMapping" + } + } + }, + "DeleteVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "RouteData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "routeName", + "spec", + "status", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "routeName": { + "shape": "ResourceName" + }, + "spec": { + "shape": "RouteSpec" + }, + "status": { + "shape": "RouteStatus" + }, + "virtualRouterName": { + "shape": "ResourceName" + } + } + }, + "RouteStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "ListRoutesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "DeleteVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData" + } + }, + "payload": "virtualService" + }, + "VirtualNodeServiceProvider": { + "type": "structure", + "required": [ + "virtualNodeName" + ], + "members": { + "virtualNodeName": { + "shape": "ResourceName" + } + } + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "InternalServerErrorException", + "httpStatusCode": 500, + "fault": true + } + }, + "DescribeVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "RouteList": { + "type": "list", + "member": { + "shape": "RouteRef" + } + }, + "ForbiddenException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "ForbiddenException", + "httpStatusCode": 403, + "senderFault": true + } + }, + "DeleteMeshOutput": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "MeshData" + } + }, + "payload": "mesh" + }, + "Hostname": { + "type": "string" + }, + "PortNumber": { + "type": "integer", + "min": 1, + "max": 65535 + }, + "CreateRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName" + }, + "spec": { + "shape": "RouteSpec" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "WeightedTargets": { + "type": "list", + "member": { + "shape": "WeightedTarget" + } + }, + "VirtualServiceProvider": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "VirtualNodeServiceProvider" + }, + "virtualRouter": { + "shape": "VirtualRouterServiceProvider" + } + } + }, + "String": { + "type": "string" + }, + "UpdateVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData" + } + }, + "payload": "virtualService" + }, + "UpdateRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "routeName" + }, + "spec": { + "shape": "RouteSpec" + }, + "virtualRouterName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "MeshStatus": { + "type": "structure", + "members": { + "status": { + "shape": "MeshStatusCode" + } + } + }, + "CreateVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "shape": "String", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualNodeSpec" + }, + "virtualNodeName": { + "shape": "ResourceName" + } + } + }, + "NotFoundException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "NotFoundException", + "httpStatusCode": 404, + "senderFault": true + } + }, + "RouteSpec": { + "type": "structure", + "members": { + "httpRoute": { + "shape": "HttpRoute" + } + } + }, + "HttpRoute": { + "type": "structure", + "required": [ + "action", + "match" + ], + "members": { + "action": { + "shape": "HttpRouteAction" + }, + "match": { + "shape": "HttpRouteMatch" + } + } + }, + "DescribeMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + } + } + }, + "CreateVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData" + } + }, + "payload": "virtualService" + }, + "VirtualRouterServiceProvider": { + "type": "structure", + "required": [ + "virtualRouterName" + ], + "members": { + "virtualRouterName": { + "shape": "ResourceName" + } + } + }, + "DeleteVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "virtualServiceName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "location": "uri", + "locationName": "meshName" + }, + "virtualServiceName": { + "shape": "ServiceName", + "location": "uri", + "locationName": "virtualServiceName" + } + } + }, + "ServiceDiscovery": { + "type": "structure", + "members": { + "dns": { + "shape": "DnsServiceDiscovery" + } + } + }, + "ListVirtualNodesOutput": { + "type": "structure", + "required": [ + "virtualNodes" + ], + "members": { + "nextToken": { + "shape": "String" + }, + "virtualNodes": { + "shape": "VirtualNodeList" + } + } + }, + "DeleteVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData" + } + }, + "payload": "virtualRouter" + }, + "VirtualServiceStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "DeleteVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData" + } + }, + "payload": "virtualNode" + } + } +} \ No newline at end of file diff --git a/src/data/appmesh/2019-01-25/api-2.json.php b/src/data/appmesh/2019-01-25/api-2.json.php new file mode 100644 index 0000000000..3d08e9c458 --- /dev/null +++ b/src/data/appmesh/2019-01-25/api-2.json.php @@ -0,0 +1,3 @@ + '2.0', 'metadata' => [ 'apiVersion' => '2019-01-25', 'endpointPrefix' => 'appmesh', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'AWS App Mesh', 'serviceId' => 'App Mesh', 'signatureVersion' => 'v4', 'signingName' => 'appmesh', 'uid' => 'appmesh-2019-01-25', ], 'operations' => [ 'CreateMesh' => [ 'name' => 'CreateMesh', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateMeshInput', ], 'output' => [ 'shape' => 'CreateMeshOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'CreateRoute' => [ 'name' => 'CreateRoute', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateRouteInput', ], 'output' => [ 'shape' => 'CreateRouteOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'CreateVirtualNode' => [ 'name' => 'CreateVirtualNode', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualNodes', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateVirtualNodeInput', ], 'output' => [ 'shape' => 'CreateVirtualNodeOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'CreateVirtualRouter' => [ 'name' => 'CreateVirtualRouter', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouters', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateVirtualRouterInput', ], 'output' => [ 'shape' => 'CreateVirtualRouterOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'CreateVirtualService' => [ 'name' => 'CreateVirtualService', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualServices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateVirtualServiceInput', ], 'output' => [ 'shape' => 'CreateVirtualServiceOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'DeleteMesh' => [ 'name' => 'DeleteMesh', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v20190125/meshes/{meshName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteMeshInput', ], 'output' => [ 'shape' => 'DeleteMeshOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'DeleteRoute' => [ 'name' => 'DeleteRoute', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteRouteInput', ], 'output' => [ 'shape' => 'DeleteRouteOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'DeleteVirtualNode' => [ 'name' => 'DeleteVirtualNode', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteVirtualNodeInput', ], 'output' => [ 'shape' => 'DeleteVirtualNodeOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'DeleteVirtualRouter' => [ 'name' => 'DeleteVirtualRouter', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteVirtualRouterInput', ], 'output' => [ 'shape' => 'DeleteVirtualRouterOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'DeleteVirtualService' => [ 'name' => 'DeleteVirtualService', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteVirtualServiceInput', ], 'output' => [ 'shape' => 'DeleteVirtualServiceOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'DescribeMesh' => [ 'name' => 'DescribeMesh', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeMeshInput', ], 'output' => [ 'shape' => 'DescribeMeshOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeRoute' => [ 'name' => 'DescribeRoute', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeRouteInput', ], 'output' => [ 'shape' => 'DescribeRouteOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeVirtualNode' => [ 'name' => 'DescribeVirtualNode', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeVirtualNodeInput', ], 'output' => [ 'shape' => 'DescribeVirtualNodeOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeVirtualRouter' => [ 'name' => 'DescribeVirtualRouter', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeVirtualRouterInput', ], 'output' => [ 'shape' => 'DescribeVirtualRouterOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeVirtualService' => [ 'name' => 'DescribeVirtualService', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeVirtualServiceInput', ], 'output' => [ 'shape' => 'DescribeVirtualServiceOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListMeshes' => [ 'name' => 'ListMeshes', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListMeshesInput', ], 'output' => [ 'shape' => 'ListMeshesOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListRoutes' => [ 'name' => 'ListRoutes', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListRoutesInput', ], 'output' => [ 'shape' => 'ListRoutesOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListVirtualNodes' => [ 'name' => 'ListVirtualNodes', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualNodes', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVirtualNodesInput', ], 'output' => [ 'shape' => 'ListVirtualNodesOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListVirtualRouters' => [ 'name' => 'ListVirtualRouters', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouters', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVirtualRoutersInput', ], 'output' => [ 'shape' => 'ListVirtualRoutersOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListVirtualServices' => [ 'name' => 'ListVirtualServices', 'http' => [ 'method' => 'GET', 'requestUri' => '/v20190125/meshes/{meshName}/virtualServices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVirtualServicesInput', ], 'output' => [ 'shape' => 'ListVirtualServicesOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'UpdateRoute' => [ 'name' => 'UpdateRoute', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateRouteInput', ], 'output' => [ 'shape' => 'UpdateRouteOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'UpdateVirtualNode' => [ 'name' => 'UpdateVirtualNode', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVirtualNodeInput', ], 'output' => [ 'shape' => 'UpdateVirtualNodeOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'UpdateVirtualRouter' => [ 'name' => 'UpdateVirtualRouter', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVirtualRouterInput', ], 'output' => [ 'shape' => 'UpdateVirtualRouterOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], 'UpdateVirtualService' => [ 'name' => 'UpdateVirtualService', 'http' => [ 'method' => 'PUT', 'requestUri' => '/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateVirtualServiceInput', ], 'output' => [ 'shape' => 'UpdateVirtualServiceOutput', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'TooManyRequestsException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'VirtualRouterListener' => [ 'type' => 'structure', 'required' => [ 'portMapping', ], 'members' => [ 'portMapping' => [ 'shape' => 'PortMapping', ], ], ], 'UpdateVirtualNodeInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'spec', 'virtualNodeName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'spec' => [ 'shape' => 'VirtualNodeSpec', ], 'virtualNodeName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualNodeName', ], ], ], 'DeleteMeshInput' => [ 'type' => 'structure', 'required' => [ 'meshName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], ], ], 'CreateVirtualServiceInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'spec', 'virtualServiceName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'spec' => [ 'shape' => 'VirtualServiceSpec', ], 'virtualServiceName' => [ 'shape' => 'ServiceName', ], ], ], 'VirtualRouterStatusCode' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETED', 'INACTIVE', ], ], 'UpdateVirtualRouterInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'spec', 'virtualRouterName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'spec' => [ 'shape' => 'VirtualRouterSpec', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'CreateVirtualNodeOutput' => [ 'type' => 'structure', 'required' => [ 'virtualNode', ], 'members' => [ 'virtualNode' => [ 'shape' => 'VirtualNodeData', ], ], 'payload' => 'virtualNode', ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'ServiceUnavailableException', 'httpStatusCode' => 503, 'fault' => true, ], ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'UpdateVirtualRouterOutput' => [ 'type' => 'structure', 'required' => [ 'virtualRouter', ], 'members' => [ 'virtualRouter' => [ 'shape' => 'VirtualRouterData', ], ], 'payload' => 'virtualRouter', ], 'DescribeMeshOutput' => [ 'type' => 'structure', 'required' => [ 'mesh', ], 'members' => [ 'mesh' => [ 'shape' => 'MeshData', ], ], 'payload' => 'mesh', ], 'DeleteVirtualRouterInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'virtualRouterName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'ListVirtualRoutersOutput' => [ 'type' => 'structure', 'required' => [ 'virtualRouters', ], 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'virtualRouters' => [ 'shape' => 'VirtualRouterList', ], ], ], 'DescribeRouteInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'routeName', 'virtualRouterName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'routeName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'routeName', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'DeleteRouteOutput' => [ 'type' => 'structure', 'required' => [ 'route', ], 'members' => [ 'route' => [ 'shape' => 'RouteData', ], ], 'payload' => 'route', ], 'ResourceMetadata' => [ 'type' => 'structure', 'required' => [ 'arn', 'createdAt', 'lastUpdatedAt', 'uid', 'version', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'lastUpdatedAt' => [ 'shape' => 'Timestamp', ], 'uid' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], ], ], 'Listeners' => [ 'type' => 'list', 'member' => [ 'shape' => 'Listener', ], ], 'Backends' => [ 'type' => 'list', 'member' => [ 'shape' => 'Backend', ], ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'ResourceInUseException', 'httpStatusCode' => 409, 'senderFault' => true, ], ], 'PortProtocol' => [ 'type' => 'string', 'enum' => [ 'http', 'tcp', ], ], 'UpdateVirtualNodeOutput' => [ 'type' => 'structure', 'required' => [ 'virtualNode', ], 'members' => [ 'virtualNode' => [ 'shape' => 'VirtualNodeData', ], ], 'payload' => 'virtualNode', ], 'ListRoutesOutput' => [ 'type' => 'structure', 'required' => [ 'routes', ], 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'routes' => [ 'shape' => 'RouteList', ], ], ], 'VirtualServiceBackend' => [ 'type' => 'structure', 'required' => [ 'virtualServiceName', ], 'members' => [ 'virtualServiceName' => [ 'shape' => 'ServiceName', ], ], ], 'VirtualNodeStatusCode' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETED', 'INACTIVE', ], ], 'ServiceName' => [ 'type' => 'string', ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'BadRequestException', 'httpStatusCode' => 400, 'senderFault' => true, ], ], 'UpdateVirtualServiceInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'spec', 'virtualServiceName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'spec' => [ 'shape' => 'VirtualServiceSpec', ], 'virtualServiceName' => [ 'shape' => 'ServiceName', 'location' => 'uri', 'locationName' => 'virtualServiceName', ], ], ], 'HealthCheckThreshold' => [ 'type' => 'integer', 'min' => 2, 'max' => 10, ], 'UpdateRouteOutput' => [ 'type' => 'structure', 'required' => [ 'route', ], 'members' => [ 'route' => [ 'shape' => 'RouteData', ], ], 'payload' => 'route', ], 'PercentInt' => [ 'type' => 'integer', 'min' => 0, 'max' => 100, ], 'HttpRouteAction' => [ 'type' => 'structure', 'required' => [ 'weightedTargets', ], 'members' => [ 'weightedTargets' => [ 'shape' => 'WeightedTargets', ], ], ], 'ListRoutesInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'virtualRouterName', ], 'members' => [ 'limit' => [ 'shape' => 'ListRoutesLimit', 'location' => 'querystring', 'locationName' => 'limit', ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'HealthCheckPolicy' => [ 'type' => 'structure', 'required' => [ 'healthyThreshold', 'intervalMillis', 'protocol', 'timeoutMillis', 'unhealthyThreshold', ], 'members' => [ 'healthyThreshold' => [ 'shape' => 'HealthCheckThreshold', ], 'intervalMillis' => [ 'shape' => 'HealthCheckIntervalMillis', ], 'path' => [ 'shape' => 'String', ], 'port' => [ 'shape' => 'PortNumber', ], 'protocol' => [ 'shape' => 'PortProtocol', ], 'timeoutMillis' => [ 'shape' => 'HealthCheckTimeoutMillis', ], 'unhealthyThreshold' => [ 'shape' => 'HealthCheckThreshold', ], ], ], 'VirtualServiceRef' => [ 'type' => 'structure', 'required' => [ 'arn', 'meshName', 'virtualServiceName', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'meshName' => [ 'shape' => 'ResourceName', ], 'virtualServiceName' => [ 'shape' => 'ServiceName', ], ], ], 'VirtualServiceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualServiceRef', ], ], 'VirtualNodeStatus' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'VirtualNodeStatusCode', ], ], ], 'VirtualRouterRef' => [ 'type' => 'structure', 'required' => [ 'arn', 'meshName', 'virtualRouterName', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'meshName' => [ 'shape' => 'ResourceName', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', ], ], ], 'VirtualServiceData' => [ 'type' => 'structure', 'required' => [ 'meshName', 'metadata', 'spec', 'status', 'virtualServiceName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', ], 'metadata' => [ 'shape' => 'ResourceMetadata', ], 'spec' => [ 'shape' => 'VirtualServiceSpec', ], 'status' => [ 'shape' => 'VirtualServiceStatus', ], 'virtualServiceName' => [ 'shape' => 'ServiceName', ], ], ], 'DescribeVirtualServiceOutput' => [ 'type' => 'structure', 'required' => [ 'virtualService', ], 'members' => [ 'virtualService' => [ 'shape' => 'VirtualServiceData', ], ], 'payload' => 'virtualService', ], 'VirtualNodeRef' => [ 'type' => 'structure', 'required' => [ 'arn', 'meshName', 'virtualNodeName', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'meshName' => [ 'shape' => 'ResourceName', ], 'virtualNodeName' => [ 'shape' => 'ResourceName', ], ], ], 'CreateMeshInput' => [ 'type' => 'structure', 'required' => [ 'meshName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', ], ], ], 'DescribeVirtualNodeOutput' => [ 'type' => 'structure', 'required' => [ 'virtualNode', ], 'members' => [ 'virtualNode' => [ 'shape' => 'VirtualNodeData', ], ], 'payload' => 'virtualNode', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'LimitExceededException', 'httpStatusCode' => 400, 'senderFault' => true, ], ], 'CreateRouteOutput' => [ 'type' => 'structure', 'required' => [ 'route', ], 'members' => [ 'route' => [ 'shape' => 'RouteData', ], ], 'payload' => 'route', ], 'DnsServiceDiscovery' => [ 'type' => 'structure', 'required' => [ 'hostname', ], 'members' => [ 'hostname' => [ 'shape' => 'Hostname', ], ], ], 'DescribeVirtualServiceInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'virtualServiceName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'virtualServiceName' => [ 'shape' => 'ServiceName', 'location' => 'uri', 'locationName' => 'virtualServiceName', ], ], ], 'ListVirtualServicesLimit' => [ 'type' => 'integer', 'box' => true, 'min' => 1, 'max' => 100, ], 'DeleteRouteInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'routeName', 'virtualRouterName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'routeName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'routeName', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'VirtualNodeData' => [ 'type' => 'structure', 'required' => [ 'meshName', 'metadata', 'spec', 'status', 'virtualNodeName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', ], 'metadata' => [ 'shape' => 'ResourceMetadata', ], 'spec' => [ 'shape' => 'VirtualNodeSpec', ], 'status' => [ 'shape' => 'VirtualNodeStatus', ], 'virtualNodeName' => [ 'shape' => 'ResourceName', ], ], ], 'VirtualServiceSpec' => [ 'type' => 'structure', 'members' => [ 'provider' => [ 'shape' => 'VirtualServiceProvider', ], ], ], 'Backend' => [ 'type' => 'structure', 'members' => [ 'virtualService' => [ 'shape' => 'VirtualServiceBackend', ], ], ], 'ListVirtualRoutersLimit' => [ 'type' => 'integer', 'box' => true, 'min' => 1, 'max' => 100, ], 'HealthCheckIntervalMillis' => [ 'type' => 'long', 'box' => true, 'min' => 5000, 'max' => 300000, ], 'VirtualRouterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualRouterRef', ], ], 'ListMeshesInput' => [ 'type' => 'structure', 'members' => [ 'limit' => [ 'shape' => 'ListMeshesLimit', 'location' => 'querystring', 'locationName' => 'limit', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'Arn' => [ 'type' => 'string', ], 'VirtualNodeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualNodeRef', ], ], 'ListVirtualRoutersInput' => [ 'type' => 'structure', 'required' => [ 'meshName', ], 'members' => [ 'limit' => [ 'shape' => 'ListVirtualRoutersLimit', 'location' => 'querystring', 'locationName' => 'limit', ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'VirtualRouterData' => [ 'type' => 'structure', 'required' => [ 'meshName', 'metadata', 'spec', 'status', 'virtualRouterName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', ], 'metadata' => [ 'shape' => 'ResourceMetadata', ], 'spec' => [ 'shape' => 'VirtualRouterSpec', ], 'status' => [ 'shape' => 'VirtualRouterStatus', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', ], ], ], 'ListVirtualServicesInput' => [ 'type' => 'structure', 'required' => [ 'meshName', ], 'members' => [ 'limit' => [ 'shape' => 'ListVirtualServicesLimit', 'location' => 'querystring', 'locationName' => 'limit', ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'CreateVirtualRouterInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'spec', 'virtualRouterName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'spec' => [ 'shape' => 'VirtualRouterSpec', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', ], ], ], 'ListVirtualNodesInput' => [ 'type' => 'structure', 'required' => [ 'meshName', ], 'members' => [ 'limit' => [ 'shape' => 'ListVirtualNodesLimit', 'location' => 'querystring', 'locationName' => 'limit', ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'nextToken' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeVirtualRouterOutput' => [ 'type' => 'structure', 'required' => [ 'virtualRouter', ], 'members' => [ 'virtualRouter' => [ 'shape' => 'VirtualRouterData', ], ], 'payload' => 'virtualRouter', ], 'CreateMeshOutput' => [ 'type' => 'structure', 'required' => [ 'mesh', ], 'members' => [ 'mesh' => [ 'shape' => 'MeshData', ], ], 'payload' => 'mesh', ], 'CreateVirtualRouterOutput' => [ 'type' => 'structure', 'required' => [ 'virtualRouter', ], 'members' => [ 'virtualRouter' => [ 'shape' => 'VirtualRouterData', ], ], 'payload' => 'virtualRouter', ], 'VirtualServiceStatus' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'VirtualServiceStatusCode', ], ], ], 'ListVirtualNodesLimit' => [ 'type' => 'integer', 'box' => true, 'min' => 1, 'max' => 100, ], 'HealthCheckTimeoutMillis' => [ 'type' => 'long', 'box' => true, 'min' => 2000, 'max' => 60000, ], 'ListMeshesLimit' => [ 'type' => 'integer', 'box' => true, 'min' => 1, 'max' => 100, ], 'ResourceName' => [ 'type' => 'string', 'min' => 1, 'max' => 255, ], 'VirtualRouterSpec' => [ 'type' => 'structure', 'required' => [ 'listeners', ], 'members' => [ 'listeners' => [ 'shape' => 'VirtualRouterListeners', ], ], ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'TooManyRequestsException', 'httpStatusCode' => 429, 'senderFault' => true, ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'VirtualNodeSpec' => [ 'type' => 'structure', 'members' => [ 'backends' => [ 'shape' => 'Backends', ], 'listeners' => [ 'shape' => 'Listeners', ], 'serviceDiscovery' => [ 'shape' => 'ServiceDiscovery', ], ], ], 'ListMeshesOutput' => [ 'type' => 'structure', 'required' => [ 'meshes', ], 'members' => [ 'meshes' => [ 'shape' => 'MeshList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'VirtualRouterListeners' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualRouterListener', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'ConflictException', 'httpStatusCode' => 409, 'senderFault' => true, ], ], 'DescribeRouteOutput' => [ 'type' => 'structure', 'required' => [ 'route', ], 'members' => [ 'route' => [ 'shape' => 'RouteData', ], ], 'payload' => 'route', ], 'HttpRouteMatch' => [ 'type' => 'structure', 'required' => [ 'prefix', ], 'members' => [ 'prefix' => [ 'shape' => 'String', ], ], ], 'MeshList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MeshRef', ], ], 'MeshRef' => [ 'type' => 'structure', 'required' => [ 'arn', 'meshName', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'meshName' => [ 'shape' => 'ResourceName', ], ], ], 'MeshStatusCode' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETED', 'INACTIVE', ], ], 'PortMapping' => [ 'type' => 'structure', 'required' => [ 'port', 'protocol', ], 'members' => [ 'port' => [ 'shape' => 'PortNumber', ], 'protocol' => [ 'shape' => 'PortProtocol', ], ], ], 'MeshData' => [ 'type' => 'structure', 'required' => [ 'meshName', 'metadata', 'status', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', ], 'metadata' => [ 'shape' => 'ResourceMetadata', ], 'status' => [ 'shape' => 'MeshStatus', ], ], ], 'VirtualRouterStatus' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'VirtualRouterStatusCode', ], ], ], 'ListVirtualServicesOutput' => [ 'type' => 'structure', 'required' => [ 'virtualServices', ], 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'virtualServices' => [ 'shape' => 'VirtualServiceList', ], ], ], 'WeightedTarget' => [ 'type' => 'structure', 'required' => [ 'virtualNode', 'weight', ], 'members' => [ 'virtualNode' => [ 'shape' => 'ResourceName', ], 'weight' => [ 'shape' => 'PercentInt', ], ], ], 'DescribeVirtualNodeInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'virtualNodeName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'virtualNodeName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualNodeName', ], ], ], 'RouteStatus' => [ 'type' => 'structure', 'required' => [ 'status', ], 'members' => [ 'status' => [ 'shape' => 'RouteStatusCode', ], ], ], 'RouteRef' => [ 'type' => 'structure', 'required' => [ 'arn', 'meshName', 'routeName', 'virtualRouterName', ], 'members' => [ 'arn' => [ 'shape' => 'Arn', ], 'meshName' => [ 'shape' => 'ResourceName', ], 'routeName' => [ 'shape' => 'ResourceName', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', ], ], ], 'Listener' => [ 'type' => 'structure', 'required' => [ 'portMapping', ], 'members' => [ 'healthCheck' => [ 'shape' => 'HealthCheckPolicy', ], 'portMapping' => [ 'shape' => 'PortMapping', ], ], ], 'DeleteVirtualNodeInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'virtualNodeName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'virtualNodeName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualNodeName', ], ], ], 'RouteData' => [ 'type' => 'structure', 'required' => [ 'meshName', 'metadata', 'routeName', 'spec', 'status', 'virtualRouterName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', ], 'metadata' => [ 'shape' => 'ResourceMetadata', ], 'routeName' => [ 'shape' => 'ResourceName', ], 'spec' => [ 'shape' => 'RouteSpec', ], 'status' => [ 'shape' => 'RouteStatus', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', ], ], ], 'RouteStatusCode' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETED', 'INACTIVE', ], ], 'ListRoutesLimit' => [ 'type' => 'integer', 'box' => true, 'min' => 1, 'max' => 100, ], 'DeleteVirtualServiceOutput' => [ 'type' => 'structure', 'required' => [ 'virtualService', ], 'members' => [ 'virtualService' => [ 'shape' => 'VirtualServiceData', ], ], 'payload' => 'virtualService', ], 'VirtualNodeServiceProvider' => [ 'type' => 'structure', 'required' => [ 'virtualNodeName', ], 'members' => [ 'virtualNodeName' => [ 'shape' => 'ResourceName', ], ], ], 'InternalServerErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'InternalServerErrorException', 'httpStatusCode' => 500, 'fault' => true, ], ], 'DescribeVirtualRouterInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'virtualRouterName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'RouteList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RouteRef', ], ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'ForbiddenException', 'httpStatusCode' => 403, 'senderFault' => true, ], ], 'DeleteMeshOutput' => [ 'type' => 'structure', 'required' => [ 'mesh', ], 'members' => [ 'mesh' => [ 'shape' => 'MeshData', ], ], 'payload' => 'mesh', ], 'Hostname' => [ 'type' => 'string', ], 'PortNumber' => [ 'type' => 'integer', 'min' => 1, 'max' => 65535, ], 'CreateRouteInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'routeName', 'spec', 'virtualRouterName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'routeName' => [ 'shape' => 'ResourceName', ], 'spec' => [ 'shape' => 'RouteSpec', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'WeightedTargets' => [ 'type' => 'list', 'member' => [ 'shape' => 'WeightedTarget', ], ], 'VirtualServiceProvider' => [ 'type' => 'structure', 'members' => [ 'virtualNode' => [ 'shape' => 'VirtualNodeServiceProvider', ], 'virtualRouter' => [ 'shape' => 'VirtualRouterServiceProvider', ], ], ], 'String' => [ 'type' => 'string', ], 'UpdateVirtualServiceOutput' => [ 'type' => 'structure', 'required' => [ 'virtualService', ], 'members' => [ 'virtualService' => [ 'shape' => 'VirtualServiceData', ], ], 'payload' => 'virtualService', ], 'UpdateRouteInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'routeName', 'spec', 'virtualRouterName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'routeName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'routeName', ], 'spec' => [ 'shape' => 'RouteSpec', ], 'virtualRouterName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'virtualRouterName', ], ], ], 'MeshStatus' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'MeshStatusCode', ], ], ], 'CreateVirtualNodeInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'spec', 'virtualNodeName', ], 'members' => [ 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'spec' => [ 'shape' => 'VirtualNodeSpec', ], 'virtualNodeName' => [ 'shape' => 'ResourceName', ], ], ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'error' => [ 'code' => 'NotFoundException', 'httpStatusCode' => 404, 'senderFault' => true, ], ], 'RouteSpec' => [ 'type' => 'structure', 'members' => [ 'httpRoute' => [ 'shape' => 'HttpRoute', ], ], ], 'HttpRoute' => [ 'type' => 'structure', 'required' => [ 'action', 'match', ], 'members' => [ 'action' => [ 'shape' => 'HttpRouteAction', ], 'match' => [ 'shape' => 'HttpRouteMatch', ], ], ], 'DescribeMeshInput' => [ 'type' => 'structure', 'required' => [ 'meshName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], ], ], 'CreateVirtualServiceOutput' => [ 'type' => 'structure', 'required' => [ 'virtualService', ], 'members' => [ 'virtualService' => [ 'shape' => 'VirtualServiceData', ], ], 'payload' => 'virtualService', ], 'VirtualRouterServiceProvider' => [ 'type' => 'structure', 'required' => [ 'virtualRouterName', ], 'members' => [ 'virtualRouterName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteVirtualServiceInput' => [ 'type' => 'structure', 'required' => [ 'meshName', 'virtualServiceName', ], 'members' => [ 'meshName' => [ 'shape' => 'ResourceName', 'location' => 'uri', 'locationName' => 'meshName', ], 'virtualServiceName' => [ 'shape' => 'ServiceName', 'location' => 'uri', 'locationName' => 'virtualServiceName', ], ], ], 'ServiceDiscovery' => [ 'type' => 'structure', 'members' => [ 'dns' => [ 'shape' => 'DnsServiceDiscovery', ], ], ], 'ListVirtualNodesOutput' => [ 'type' => 'structure', 'required' => [ 'virtualNodes', ], 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'virtualNodes' => [ 'shape' => 'VirtualNodeList', ], ], ], 'DeleteVirtualRouterOutput' => [ 'type' => 'structure', 'required' => [ 'virtualRouter', ], 'members' => [ 'virtualRouter' => [ 'shape' => 'VirtualRouterData', ], ], 'payload' => 'virtualRouter', ], 'VirtualServiceStatusCode' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETED', 'INACTIVE', ], ], 'DeleteVirtualNodeOutput' => [ 'type' => 'structure', 'required' => [ 'virtualNode', ], 'members' => [ 'virtualNode' => [ 'shape' => 'VirtualNodeData', ], ], 'payload' => 'virtualNode', ], ],]; diff --git a/src/data/appmesh/2019-01-25/docs-2.json b/src/data/appmesh/2019-01-25/docs-2.json new file mode 100644 index 0000000000..2634331718 --- /dev/null +++ b/src/data/appmesh/2019-01-25/docs-2.json @@ -0,0 +1,807 @@ +{ + "version": "2.0", + "service": "

AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control containerized microservices. App Mesh standardizes how your microservices\n communicate, giving you end-to-end visibility and helping to ensure high-availability for\n your applications.

\n

App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with Amazon ECS\n (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.

\n \n

App Mesh supports containerized microservice applications that use service discovery\n naming for their components. To use App Mesh, you must have a containerized application\n running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For\n more information about service discovery on Amazon ECS, see Service Discovery in the\n Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns and\n coredns are supported. For more information, see DNS\n for Services and Pods in the Kubernetes documentation.

\n ", + "operations": { + "CreateMesh": "

Creates a new service mesh. A service mesh is a logical boundary for network traffic\n between the services that reside within it.

\n

After you create your service mesh, you can create virtual services, virtual nodes,\n virtual routers, and routes to distribute traffic between the applications in your\n mesh.

", + "CreateRoute": "

Creates a new route that is associated with a virtual router.

\n

You can use the prefix parameter in your route specification for path-based\n routing of requests. For example, if your virtual router service name is\n my-service.local, and you want the route to match requests to\n my-service.local/metrics, then your prefix should be\n /metrics.

\n

If your route matches a request, you can distribute traffic to one or more target\n virtual nodes with relative weighting.

", + "CreateVirtualNode": "

Creates a new virtual node within a service mesh.

\n

A virtual node acts as logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you must specify the\n DNS service discovery hostname for your task group.

\n

Any inbound traffic that your virtual node expects should be specified as a\n listener. Any outbound traffic that your virtual node expects to reach\n should be specified as a backend.

\n

The response metadata for your new virtual node contains the arn that is\n associated with the virtual node. Set this value (either the full ARN or the truncated\n resource name, for example, mesh/default/virtualNode/simpleapp, as the\n APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n node.id and node.cluster Envoy parameters.

\n \n

If you require your Envoy stats or tracing to use a different name, you can override\n the node.cluster value that is set by\n APPMESH_VIRTUAL_NODE_NAME with the\n APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

\n ", + "CreateVirtualRouter": "

Creates a new virtual router within a service mesh.

\n

Any inbound traffic that your virtual router expects should be specified as a\n listener.

\n

Virtual routers handle traffic for one or more service names within your mesh. After you\n create your virtual router, create and associate routes for your virtual router that direct\n incoming requests to different virtual nodes.

", + "CreateVirtualService": "

Creates a virtual service within a service mesh.

\n

A virtual service is an abstraction of a real service that is either provided by a\n virtual node directly, or indirectly by means of a virtual router. Dependent services call\n your virtual service by its virtualServiceName, and those requests are routed\n to the virtual node or virtual router that is specified as the provider for the virtual\n service.

", + "DeleteMesh": "

Deletes an existing service mesh.

\n

You must delete all resources (virtual services, routes, virtual routers, virtual nodes)\n in the service mesh before you can delete the mesh itself.

", + "DeleteRoute": "

Deletes an existing route.

", + "DeleteVirtualNode": "

Deletes an existing virtual node.

\n

You must delete any virtual services that list a virtual node as a service provider\n before you can delete the virtual node itself.

", + "DeleteVirtualRouter": "

Deletes an existing virtual router.

\n

You must delete any routes associated with the virtual router before you can delete the\n router itself.

", + "DeleteVirtualService": "

Deletes an existing virtual service.

", + "DescribeMesh": "

Describes an existing service mesh.

", + "DescribeRoute": "

Describes an existing route.

", + "DescribeVirtualNode": "

Describes an existing virtual node.

", + "DescribeVirtualRouter": "

Describes an existing virtual router.

", + "DescribeVirtualService": "

Describes an existing virtual service.

", + "ListMeshes": "

Returns a list of existing service meshes.

", + "ListRoutes": "

Returns a list of existing routes in a service mesh.

", + "ListVirtualNodes": "

Returns a list of existing virtual nodes.

", + "ListVirtualRouters": "

Returns a list of existing virtual routers in a service mesh.

", + "ListVirtualServices": "

Returns a list of existing virtual services in a service mesh.

", + "UpdateRoute": "

Updates an existing route for a specified service mesh and virtual router.

", + "UpdateVirtualNode": "

Updates an existing virtual node in a specified service mesh.

", + "UpdateVirtualRouter": "

Updates an existing virtual router in a specified service mesh.

", + "UpdateVirtualService": "

Updates an existing virtual service in a specified service mesh.

" + }, + "shapes": { + "Arn": { + "base": null, + "refs": { } + }, + "Backend": { + "base": "

An object representing the backends that a virtual node is expected to send outbound\n traffic to.

", + "refs": { + "Backend$virtualService": "

Specifies a virtual service to use as a backend for a virtual node.

" + } + }, + "Backends": { + "base": null, + "refs": { + "Backends$member": null + } + }, + "BadRequestException": { + "base": "

The request syntax was malformed. Check your request syntax and try again.

", + "refs": { } + }, + "ConflictException": { + "base": "

The request contains a client token that was used for a previous update resource call\n with different specifications. Try the request again with a new client token.

", + "refs": { } + }, + "CreateMeshInput": { + "base": "", + "refs": { + "CreateMeshInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "CreateMeshInput$meshName": "

The name to use for the service mesh.

" + } + }, + "CreateMeshOutput": { + "base": "", + "refs": { + "CreateMeshOutput$mesh": "

The full description of your service mesh following the create call.

" + } + }, + "CreateRouteInput": { + "base": "", + "refs": { + "CreateRouteInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "CreateRouteInput$meshName": "

The name of the service mesh in which to create the route.

", + "CreateRouteInput$routeName": "

The name to use for the route.

", + "CreateRouteInput$spec": "

The route specification to apply.

", + "CreateRouteInput$virtualRouterName": "

The name of the virtual router in which to create the route.

" + } + }, + "CreateRouteOutput": { + "base": "", + "refs": { + "CreateRouteOutput$route": "

The full description of your mesh following the create call.

" + } + }, + "CreateVirtualNodeInput": { + "base": "", + "refs": { + "CreateVirtualNodeInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "CreateVirtualNodeInput$meshName": "

The name of the service mesh in which to create the virtual node.

", + "CreateVirtualNodeInput$spec": "

The virtual node specification to apply.

", + "CreateVirtualNodeInput$virtualNodeName": "

The name to use for the virtual node.

" + } + }, + "CreateVirtualNodeOutput": { + "base": "", + "refs": { + "CreateVirtualNodeOutput$virtualNode": "

The full description of your virtual node following the create call.

" + } + }, + "CreateVirtualRouterInput": { + "base": "", + "refs": { + "CreateVirtualRouterInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "CreateVirtualRouterInput$meshName": "

The name of the service mesh to create the virtual router in.

", + "CreateVirtualRouterInput$spec": "

The virtual router specification to apply.

", + "CreateVirtualRouterInput$virtualRouterName": "

The name to use for the virtual router.

" + } + }, + "CreateVirtualRouterOutput": { + "base": "", + "refs": { + "CreateVirtualRouterOutput$virtualRouter": "

The full description of your virtual router following the create call.

" + } + }, + "CreateVirtualServiceInput": { + "base": "", + "refs": { + "CreateVirtualServiceInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "CreateVirtualServiceInput$meshName": "

The name of the service mesh in which to create the virtual service.

", + "CreateVirtualServiceInput$spec": "

The virtual service specification to apply.

", + "CreateVirtualServiceInput$virtualServiceName": "

The name to use for the virtual service.

" + } + }, + "CreateVirtualServiceOutput": { + "base": "", + "refs": { + "CreateVirtualServiceOutput$virtualService": "

The full description of your virtual service following the create call.

" + } + }, + "DeleteMeshInput": { + "base": "", + "refs": { + "DeleteMeshInput$meshName": "

The name of the service mesh to delete.

" + } + }, + "DeleteMeshOutput": { + "base": "", + "refs": { + "DeleteMeshOutput$mesh": "

The service mesh that was deleted.

" + } + }, + "DeleteRouteInput": { + "base": "", + "refs": { + "DeleteRouteInput$meshName": "

The name of the service mesh to delete the route in.

", + "DeleteRouteInput$routeName": "

The name of the route to delete.

", + "DeleteRouteInput$virtualRouterName": "

The name of the virtual router to delete the route in.

" + } + }, + "DeleteRouteOutput": { + "base": "", + "refs": { + "DeleteRouteOutput$route": "

The route that was deleted.

" + } + }, + "DeleteVirtualNodeInput": { + "base": "", + "refs": { + "DeleteVirtualNodeInput$meshName": "

The name of the service mesh to delete the virtual node in.

", + "DeleteVirtualNodeInput$virtualNodeName": "

The name of the virtual node to delete.

" + } + }, + "DeleteVirtualNodeOutput": { + "base": "", + "refs": { + "DeleteVirtualNodeOutput$virtualNode": "

The virtual node that was deleted.

" + } + }, + "DeleteVirtualRouterInput": { + "base": "", + "refs": { + "DeleteVirtualRouterInput$meshName": "

The name of the service mesh to delete the virtual router in.

", + "DeleteVirtualRouterInput$virtualRouterName": "

The name of the virtual router to delete.

" + } + }, + "DeleteVirtualRouterOutput": { + "base": "", + "refs": { + "DeleteVirtualRouterOutput$virtualRouter": "

The virtual router that was deleted.

" + } + }, + "DeleteVirtualServiceInput": { + "base": "", + "refs": { + "DeleteVirtualServiceInput$meshName": "

The name of the service mesh to delete the virtual service in.

", + "DeleteVirtualServiceInput$virtualServiceName": "

The name of the virtual service to delete.

" + } + }, + "DeleteVirtualServiceOutput": { + "base": "", + "refs": { + "DeleteVirtualServiceOutput$virtualService": "

The virtual service that was deleted.

" + } + }, + "DescribeMeshInput": { + "base": "", + "refs": { + "DescribeMeshInput$meshName": "

The name of the service mesh to describe.

" + } + }, + "DescribeMeshOutput": { + "base": "", + "refs": { + "DescribeMeshOutput$mesh": "

The full description of your service mesh.

" + } + }, + "DescribeRouteInput": { + "base": "", + "refs": { + "DescribeRouteInput$meshName": "

The name of the service mesh that the route resides in.

", + "DescribeRouteInput$routeName": "

The name of the route to describe.

", + "DescribeRouteInput$virtualRouterName": "

The name of the virtual router that the route is associated with.

" + } + }, + "DescribeRouteOutput": { + "base": "", + "refs": { + "DescribeRouteOutput$route": "

The full description of your route.

" + } + }, + "DescribeVirtualNodeInput": { + "base": "", + "refs": { + "DescribeVirtualNodeInput$meshName": "

The name of the service mesh that the virtual node resides in.

", + "DescribeVirtualNodeInput$virtualNodeName": "

The name of the virtual node to describe.

" + } + }, + "DescribeVirtualNodeOutput": { + "base": "", + "refs": { + "DescribeVirtualNodeOutput$virtualNode": "

The full description of your virtual node.

" + } + }, + "DescribeVirtualRouterInput": { + "base": "", + "refs": { + "DescribeVirtualRouterInput$meshName": "

The name of the service mesh that the virtual router resides in.

", + "DescribeVirtualRouterInput$virtualRouterName": "

The name of the virtual router to describe.

" + } + }, + "DescribeVirtualRouterOutput": { + "base": "", + "refs": { + "DescribeVirtualRouterOutput$virtualRouter": "

The full description of your virtual router.

" + } + }, + "DescribeVirtualServiceInput": { + "base": "", + "refs": { + "DescribeVirtualServiceInput$meshName": "

The name of the service mesh that the virtual service resides in.

", + "DescribeVirtualServiceInput$virtualServiceName": "

The name of the virtual service to describe.

" + } + }, + "DescribeVirtualServiceOutput": { + "base": "", + "refs": { + "DescribeVirtualServiceOutput$virtualService": "

The full description of your virtual service.

" + } + }, + "DnsServiceDiscovery": { + "base": "

An object representing the DNS service discovery information for your virtual\n node.

", + "refs": { + "DnsServiceDiscovery$hostname": "

Specifies the DNS service discovery hostname for the virtual node.

" + } + }, + "ForbiddenException": { + "base": "

You don't have permissions to perform this action.

", + "refs": { } + }, + "HealthCheckIntervalMillis": { + "base": null, + "refs": { } + }, + "HealthCheckPolicy": { + "base": "

An object representing the health check policy for a virtual node's listener.

", + "refs": { + "HealthCheckPolicy$healthyThreshold": "

The number of consecutive successful health checks that must occur before declaring\n listener healthy.

", + "HealthCheckPolicy$intervalMillis": "

The time period in milliseconds between each health check execution.

", + "HealthCheckPolicy$path": "

The destination path for the health check request. This is required only if the\n specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

", + "HealthCheckPolicy$port": "

The destination port for the health check request. This port must match the port defined\n in the PortMapping for the listener.

", + "HealthCheckPolicy$protocol": "

The protocol for the health check request.

", + "HealthCheckPolicy$timeoutMillis": "

The amount of time to wait when receiving a response from the health check, in\n milliseconds.

", + "HealthCheckPolicy$unhealthyThreshold": "

The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy.

" + } + }, + "HealthCheckThreshold": { + "base": null, + "refs": { } + }, + "HealthCheckTimeoutMillis": { + "base": null, + "refs": { } + }, + "Hostname": { + "base": null, + "refs": { } + }, + "HttpRoute": { + "base": "

An object representing the HTTP routing specification for a route.

", + "refs": { + "HttpRoute$action": "

The action to take if a match is determined.

", + "HttpRoute$match": "

The criteria for determining an HTTP request match.

" + } + }, + "HttpRouteAction": { + "base": "

An object representing the traffic distribution requirements for matched HTTP\n requests.

", + "refs": { + "HttpRouteAction$weightedTargets": "

The targets that traffic is routed to when a request matches the route. You can specify\n one or more targets and their relative weights to distribute traffic with.

" + } + }, + "HttpRouteMatch": { + "base": "

An object representing the requirements for a route to match HTTP requests for a virtual\n router.

", + "refs": { + "HttpRouteMatch$prefix": "

Specifies the path to match requests with. This parameter must always start with\n /, which by itself matches all requests to the virtual router service name.\n You can also match for path-based routing of requests. For example, if your virtual router\n service name is my-service.local and you want the route to match requests to\n my-service.local/metrics, your prefix should be\n /metrics.

" + } + }, + "InternalServerErrorException": { + "base": "

The request processing has failed because of an unknown error, exception, or failure.

", + "refs": { } + }, + "LimitExceededException": { + "base": "

You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.

", + "refs": { } + }, + "ListMeshesInput": { + "base": "", + "refs": { + "ListMeshesInput$limit": "

The maximum number of results returned by ListMeshes in paginated output.\n When you use this parameter, ListMeshes returns only limit\n results in a single page along with a nextToken response element. You can see the\n remaining results of the initial request by sending another\n ListMeshes request with the returned nextToken value. This\n value can be between 1 and 100. If you don't use this parameter,\n ListMeshes returns up to 100 results and a\n nextToken value if applicable.

", + "ListMeshesInput$nextToken": "

The nextToken value returned from a previous paginated\n ListMeshes request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + }, + "ListMeshesLimit": { + "base": null, + "refs": { } + }, + "ListMeshesOutput": { + "base": "", + "refs": { + "ListMeshesOutput$meshes": "

The list of existing service meshes.

", + "ListMeshesOutput$nextToken": "

The nextToken value to include in a future ListMeshes\n request. When the results of a ListMeshes request exceed\n limit, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } + }, + "ListRoutesInput": { + "base": "", + "refs": { + "ListRoutesInput$limit": "

The maximum number of results returned by ListRoutes in paginated output.\n When you use this parameter, ListRoutes returns only limit\n results in a single page along with a nextToken response element. You can see the\n remaining results of the initial request by sending another\n ListRoutes request with the returned nextToken value. This\n value can be between 1 and 100. If you don't use this parameter,\n ListRoutes returns up to 100 results and a\n nextToken value if applicable.

", + "ListRoutesInput$meshName": "

The name of the service mesh in which to list routes.

", + "ListRoutesInput$nextToken": "

The nextToken value returned from a previous paginated\n ListRoutes request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "ListRoutesInput$virtualRouterName": "

The name of the virtual router to list routes in.

" + } + }, + "ListRoutesLimit": { + "base": null, + "refs": { } + }, + "ListRoutesOutput": { + "base": "", + "refs": { + "ListRoutesOutput$nextToken": "

The nextToken value to include in a future ListRoutes\n request. When the results of a ListRoutes request exceed\n limit, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

", + "ListRoutesOutput$routes": "

The list of existing routes for the specified service mesh and virtual router.

" + } + }, + "ListVirtualNodesInput": { + "base": "", + "refs": { + "ListVirtualNodesInput$limit": "

The maximum number of results returned by ListVirtualNodes in paginated\n output. When you use this parameter, ListVirtualNodes returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListVirtualNodes request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this parameter,\n ListVirtualNodes returns up to 100 results and a\n nextToken value if applicable.

", + "ListVirtualNodesInput$meshName": "

The name of the service mesh to list virtual nodes in.

", + "ListVirtualNodesInput$nextToken": "

The nextToken value returned from a previous paginated\n ListVirtualNodes request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

" + } + }, + "ListVirtualNodesLimit": { + "base": null, + "refs": { } + }, + "ListVirtualNodesOutput": { + "base": "", + "refs": { + "ListVirtualNodesOutput$nextToken": "

The nextToken value to include in a future ListVirtualNodes\n request. When the results of a ListVirtualNodes request exceed\n limit, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

", + "ListVirtualNodesOutput$virtualNodes": "

The list of existing virtual nodes for the specified service mesh.

" + } + }, + "ListVirtualRoutersInput": { + "base": "", + "refs": { + "ListVirtualRoutersInput$limit": "

The maximum number of results returned by ListVirtualRouters in paginated\n output. When you use this parameter, ListVirtualRouters returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListVirtualRouters request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this parameter, \n ListVirtualRouters returns up to 100 results and\n a nextToken value if applicable.

", + "ListVirtualRoutersInput$meshName": "

The name of the service mesh to list virtual routers in.

", + "ListVirtualRoutersInput$nextToken": "

The nextToken value returned from a previous paginated\n ListVirtualRouters request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

" + } + }, + "ListVirtualRoutersLimit": { + "base": null, + "refs": { } + }, + "ListVirtualRoutersOutput": { + "base": "", + "refs": { + "ListVirtualRoutersOutput$nextToken": "

The nextToken value to include in a future ListVirtualRouters\n request. When the results of a ListVirtualRouters request exceed\n limit, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

", + "ListVirtualRoutersOutput$virtualRouters": "

The list of existing virtual routers for the specified service mesh.

" + } + }, + "ListVirtualServicesInput": { + "base": "", + "refs": { + "ListVirtualServicesInput$limit": "

The maximum number of results returned by ListVirtualServices in paginated\n output. When you use this parameter, ListVirtualServices returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListVirtualServices request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this parameter,\n ListVirtualServices returns up to 100 results and\n a nextToken value if applicable.

", + "ListVirtualServicesInput$meshName": "

The name of the service mesh to list virtual services in.

", + "ListVirtualServicesInput$nextToken": "

The nextToken value returned from a previous paginated\n ListVirtualServices request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

" + } + }, + "ListVirtualServicesLimit": { + "base": null, + "refs": { } + }, + "ListVirtualServicesOutput": { + "base": "", + "refs": { + "ListVirtualServicesOutput$nextToken": "

The nextToken value to include in a future ListVirtualServices\n request. When the results of a ListVirtualServices request exceed\n limit, you can use this value to retrieve the next page of results. This\n value is null when there are no more results to return.

", + "ListVirtualServicesOutput$virtualServices": "

The list of existing virtual services for the specified service mesh.

" + } + }, + "Listener": { + "base": "

An object representing a listener for a virtual node.

", + "refs": { + "Listener$healthCheck": "

The health check information for the listener.

", + "Listener$portMapping": "

The port mapping information for the listener.

" + } + }, + "Listeners": { + "base": null, + "refs": { + "Listeners$member": null + } + }, + "Long": { + "base": null, + "refs": { } + }, + "MeshData": { + "base": "

An object representing a service mesh returned by a describe operation.

", + "refs": { + "MeshData$meshName": "

The name of the service mesh.

", + "MeshData$metadata": "

The associated metadata for the service mesh.

", + "MeshData$status": "

The status of the service mesh.

" + } + }, + "MeshList": { + "base": null, + "refs": { + "MeshList$member": null + } + }, + "MeshRef": { + "base": "

An object representing a service mesh returned by a list operation.

", + "refs": { + "MeshRef$arn": "

The full Amazon Resource Name (ARN) of the service mesh.

", + "MeshRef$meshName": "

The name of the service mesh.

" + } + }, + "MeshStatus": { + "base": "

An object representing the status of a service mesh.

", + "refs": { + "MeshStatus$status": "

The current mesh status.

" + } + }, + "MeshStatusCode": { + "base": null, + "refs": { } + }, + "NotFoundException": { + "base": "

The specified resource doesn't exist. Check your request syntax and try again.

", + "refs": { } + }, + "PercentInt": { + "base": null, + "refs": { } + }, + "PortMapping": { + "base": "

An object representing a virtual node or virtual router listener port mapping.

", + "refs": { + "PortMapping$port": "

The port used for the port mapping.

", + "PortMapping$protocol": "

The protocol used for the port mapping.

" + } + }, + "PortNumber": { + "base": null, + "refs": { } + }, + "PortProtocol": { + "base": null, + "refs": { } + }, + "ResourceInUseException": { + "base": "

You can't delete the specified resource because it's in use or required by another resource.

", + "refs": { } + }, + "ResourceMetadata": { + "base": "

An object representing metadata for a resource.

", + "refs": { + "ResourceMetadata$arn": "

The full Amazon Resource Name (ARN) for the resource.

\n \n

After you create a virtual node, set this value (either the full ARN or the\n truncated resource name, for example, mesh/default/virtualNode/simpleapp,\n as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's\n Envoy proxy container in your task definition or pod spec. This is then mapped to the\n node.id and node.cluster Envoy parameters.

\n

If you require your Envoy stats or tracing to use a different name, you can override\n the node.cluster value that is set by\n APPMESH_VIRTUAL_NODE_NAME with the\n APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

\n ", + "ResourceMetadata$createdAt": "

The Unix epoch timestamp in seconds for when the resource was created.

", + "ResourceMetadata$lastUpdatedAt": "

The Unix epoch timestamp in seconds for when the resource was last updated.

", + "ResourceMetadata$uid": "

The unique identifier for the resource.

", + "ResourceMetadata$version": "

The version of the resource. Resources are created at version 1, and this version is\n incremented each time that they're updated.

" + } + }, + "ResourceName": { + "base": null, + "refs": { } + }, + "RouteData": { + "base": "

An object representing a route returned by a describe operation.

", + "refs": { + "RouteData$meshName": "

The name of the service mesh that the route resides in.

", + "RouteData$metadata": "

The associated metadata for the route.

", + "RouteData$routeName": "

The name of the route.

", + "RouteData$spec": "

The specifications of the route.

", + "RouteData$status": "

The status of the route.

", + "RouteData$virtualRouterName": "

The virtual router that the route is associated with.

" + } + }, + "RouteList": { + "base": null, + "refs": { + "RouteList$member": null + } + }, + "RouteRef": { + "base": "

An object representing a route returned by a list operation.

", + "refs": { + "RouteRef$arn": "

The full Amazon Resource Name (ARN) for the route.

", + "RouteRef$meshName": "

The name of the service mesh that the route resides in.

", + "RouteRef$routeName": "

The name of the route.

", + "RouteRef$virtualRouterName": "

The virtual router that the route is associated with.

" + } + }, + "RouteSpec": { + "base": "

An object representing the specification of a route.

", + "refs": { + "RouteSpec$httpRoute": "

The HTTP routing information for the route.

" + } + }, + "RouteStatus": { + "base": "

An object representing the current status of a route.

", + "refs": { + "RouteStatus$status": "

The current status for the route.

" + } + }, + "RouteStatusCode": { + "base": null, + "refs": { } + }, + "ServiceDiscovery": { + "base": "

An object representing the service discovery information for a virtual node.

", + "refs": { + "ServiceDiscovery$dns": "

Specifies the DNS information for the virtual node.

" + } + }, + "ServiceName": { + "base": null, + "refs": { } + }, + "ServiceUnavailableException": { + "base": "

The request has failed due to a temporary failure of the service.

", + "refs": { } + }, + "String": { + "base": null, + "refs": { } + }, + "Timestamp": { + "base": null, + "refs": { } + }, + "TooManyRequestsException": { + "base": "

The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between requests.

", + "refs": { } + }, + "UpdateRouteInput": { + "base": "", + "refs": { + "UpdateRouteInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "UpdateRouteInput$meshName": "

The name of the service mesh that the route resides in.

", + "UpdateRouteInput$routeName": "

The name of the route to update.

", + "UpdateRouteInput$spec": "

The new route specification to apply. This overwrites the existing data.

", + "UpdateRouteInput$virtualRouterName": "

The name of the virtual router that the route is associated with.

" + } + }, + "UpdateRouteOutput": { + "base": "", + "refs": { + "UpdateRouteOutput$route": "

A full description of the route that was updated.

" + } + }, + "UpdateVirtualNodeInput": { + "base": "", + "refs": { + "UpdateVirtualNodeInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "UpdateVirtualNodeInput$meshName": "

The name of the service mesh that the virtual node resides in.

", + "UpdateVirtualNodeInput$spec": "

The new virtual node specification to apply. This overwrites the existing data.

", + "UpdateVirtualNodeInput$virtualNodeName": "

The name of the virtual node to update.

" + } + }, + "UpdateVirtualNodeOutput": { + "base": "", + "refs": { + "UpdateVirtualNodeOutput$virtualNode": "

A full description of the virtual node that was updated.

" + } + }, + "UpdateVirtualRouterInput": { + "base": "", + "refs": { + "UpdateVirtualRouterInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "UpdateVirtualRouterInput$meshName": "

The name of the service mesh that the virtual router resides in.

", + "UpdateVirtualRouterInput$spec": "

The new virtual router specification to apply. This overwrites the existing data.

", + "UpdateVirtualRouterInput$virtualRouterName": "

The name of the virtual router to update.

" + } + }, + "UpdateVirtualRouterOutput": { + "base": "", + "refs": { + "UpdateVirtualRouterOutput$virtualRouter": "

A full description of the virtual router that was updated.

" + } + }, + "UpdateVirtualServiceInput": { + "base": "", + "refs": { + "UpdateVirtualServiceInput$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "UpdateVirtualServiceInput$meshName": "

The name of the service mesh that the virtual service resides in.

", + "UpdateVirtualServiceInput$spec": "

The new virtual service specification to apply. This overwrites the existing\n data.

", + "UpdateVirtualServiceInput$virtualServiceName": "

The name of the virtual service to update.

" + } + }, + "UpdateVirtualServiceOutput": { + "base": "", + "refs": { + "UpdateVirtualServiceOutput$virtualService": "

A full description of the virtual service that was updated.

" + } + }, + "VirtualNodeData": { + "base": "

An object representing a virtual node returned by a describe operation.

", + "refs": { + "VirtualNodeData$meshName": "

The name of the service mesh that the virtual node resides in.

", + "VirtualNodeData$metadata": "

The associated metadata for the virtual node.

", + "VirtualNodeData$spec": "

The specifications of the virtual node.

", + "VirtualNodeData$status": "

The current status for the virtual node.

", + "VirtualNodeData$virtualNodeName": "

The name of the virtual node.

" + } + }, + "VirtualNodeList": { + "base": null, + "refs": { + "VirtualNodeList$member": null + } + }, + "VirtualNodeRef": { + "base": "

An object representing a virtual node returned by a list operation.

", + "refs": { + "VirtualNodeRef$arn": "

The full Amazon Resource Name (ARN) for the virtual node.

", + "VirtualNodeRef$meshName": "

The name of the service mesh that the virtual node resides in.

", + "VirtualNodeRef$virtualNodeName": "

The name of the virtual node.

" + } + }, + "VirtualNodeServiceProvider": { + "base": "

An object representing a virtual node service provider.

", + "refs": { + "VirtualNodeServiceProvider$virtualNodeName": "

The name of the virtual node that is acting as a service provider.

" + } + }, + "VirtualNodeSpec": { + "base": "

An object representing the specification of a virtual node.

", + "refs": { + "VirtualNodeSpec$backends": "

The backends that the virtual node is expected to send outbound traffic to.

", + "VirtualNodeSpec$listeners": "

The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

", + "VirtualNodeSpec$serviceDiscovery": "

The service discovery information for the virtual node.

" + } + }, + "VirtualNodeStatus": { + "base": "

An object representing the current status of the virtual node.

", + "refs": { + "VirtualNodeStatus$status": "

The current status of the virtual node.

" + } + }, + "VirtualNodeStatusCode": { + "base": null, + "refs": { } + }, + "VirtualRouterData": { + "base": "

An object representing a virtual router returned by a describe operation.

", + "refs": { + "VirtualRouterData$meshName": "

The name of the service mesh that the virtual router resides in.

", + "VirtualRouterData$metadata": "

The associated metadata for the virtual router.

", + "VirtualRouterData$spec": "

The specifications of the virtual router.

", + "VirtualRouterData$status": "

The current status of the virtual router.

", + "VirtualRouterData$virtualRouterName": "

The name of the virtual router.

" + } + }, + "VirtualRouterList": { + "base": null, + "refs": { + "VirtualRouterList$member": null + } + }, + "VirtualRouterListener": { + "base": "

An object representing a virtual router listener.

", + "refs": { } + }, + "VirtualRouterListeners": { + "base": null, + "refs": { + "VirtualRouterListeners$member": null + } + }, + "VirtualRouterRef": { + "base": "

An object representing a virtual router returned by a list operation.

", + "refs": { + "VirtualRouterRef$arn": "

The full Amazon Resource Name (ARN) for the virtual router.

", + "VirtualRouterRef$meshName": "

The name of the service mesh that the virtual router resides in.

", + "VirtualRouterRef$virtualRouterName": "

The name of the virtual router.

" + } + }, + "VirtualRouterServiceProvider": { + "base": "

An object representing a virtual node service provider.

", + "refs": { + "VirtualRouterServiceProvider$virtualRouterName": "

The name of the virtual router that is acting as a service provider.

" + } + }, + "VirtualRouterSpec": { + "base": "

An object representing the specification of a virtual router.

", + "refs": { + "VirtualRouterSpec$listeners": "

The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.

" + } + }, + "VirtualRouterStatus": { + "base": "

An object representing the status of a virtual router.

", + "refs": { + "VirtualRouterStatus$status": "

The current status of the virtual router.

" + } + }, + "VirtualRouterStatusCode": { + "base": null, + "refs": { } + }, + "VirtualServiceBackend": { + "base": "

An object representing a virtual service backend for a virtual node.

", + "refs": { + "VirtualServiceBackend$virtualServiceName": "

The name of the virtual service that is acting as a virtual node backend.

" + } + }, + "VirtualServiceData": { + "base": "

An object representing a virtual service returned by a describe operation.

", + "refs": { + "VirtualServiceData$meshName": "

The name of the service mesh that the virtual service resides in.

", + "VirtualServiceData$spec": "

The specifications of the virtual service.

", + "VirtualServiceData$status": "

The current status of the virtual service.

", + "VirtualServiceData$virtualServiceName": "

The name of the virtual service.

" + } + }, + "VirtualServiceList": { + "base": null, + "refs": { + "VirtualServiceList$member": null + } + }, + "VirtualServiceProvider": { + "base": "

An object representing the provider for a virtual service.

", + "refs": { + "VirtualServiceProvider$virtualNode": "

The virtual node associated with a virtual service.

", + "VirtualServiceProvider$virtualRouter": "

The virtual router associated with a virtual service.

" + } + }, + "VirtualServiceRef": { + "base": "

An object representing a virtual service returned by a list operation.

", + "refs": { + "VirtualServiceRef$arn": "

The full Amazon Resource Name (ARN) for the virtual service.

", + "VirtualServiceRef$meshName": "

The name of the service mesh that the virtual service resides in.

", + "VirtualServiceRef$virtualServiceName": "

The name of the virtual service.

" + } + }, + "VirtualServiceSpec": { + "base": "

An object representing the specification of a virtual service.

", + "refs": { + "VirtualServiceSpec$provider": "

The App Mesh object that is acting as the provider for a virtual service. You can specify\n a single virtual node or virtual router.

" + } + }, + "VirtualServiceStatus": { + "base": "

An object representing the status of a virtual service.

", + "refs": { + "VirtualServiceStatus$status": "

The current status of the virtual service.

" + } + }, + "VirtualServiceStatusCode": { + "base": null, + "refs": { } + }, + "WeightedTarget": { + "base": "

An object representing a target and its relative weight. Traffic is distributed across\n targets according to their relative weight. For example, a weighted target with a relative\n weight of 50 receives five times as much traffic as one with a relative weight of\n 10.

", + "refs": { + "WeightedTarget$virtualNode": "

The virtual node to associate with the weighted target.

", + "WeightedTarget$weight": "

The relative weight of the weighted target.

" + } + }, + "WeightedTargets": { + "base": null, + "refs": { + "WeightedTargets$member": null + } + } + } +} \ No newline at end of file diff --git a/src/data/appmesh/2019-01-25/docs-2.json.php b/src/data/appmesh/2019-01-25/docs-2.json.php new file mode 100644 index 0000000000..9f8f8c07da --- /dev/null +++ b/src/data/appmesh/2019-01-25/docs-2.json.php @@ -0,0 +1,3 @@ + '2.0', 'service' => '

AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control containerized microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high-availability for your applications.

App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon ECS (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.

App Mesh supports containerized microservice applications that use service discovery naming for their components. To use App Mesh, you must have a containerized application running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns and coredns are supported. For more information, see DNS for Services and Pods in the Kubernetes documentation.

', 'operations' => [ 'CreateMesh' => '

Creates a new service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

', 'CreateRoute' => '

Creates a new route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

', 'CreateVirtualNode' => '

Creates a new virtual node within a service mesh.

A virtual node acts as logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you must specify the DNS service discovery hostname for your task group.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group\'s Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

', 'CreateVirtualRouter' => '

Creates a new virtual router within a service mesh.

Any inbound traffic that your virtual router expects should be specified as a listener.

Virtual routers handle traffic for one or more service names within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

', 'CreateVirtualService' => '

Creates a virtual service within a service mesh.

A virtual service is an abstraction of a real service that is either provided by a virtual node directly, or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.

', 'DeleteMesh' => '

Deletes an existing service mesh.

You must delete all resources (virtual services, routes, virtual routers, virtual nodes) in the service mesh before you can delete the mesh itself.

', 'DeleteRoute' => '

Deletes an existing route.

', 'DeleteVirtualNode' => '

Deletes an existing virtual node.

You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.

', 'DeleteVirtualRouter' => '

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

', 'DeleteVirtualService' => '

Deletes an existing virtual service.

', 'DescribeMesh' => '

Describes an existing service mesh.

', 'DescribeRoute' => '

Describes an existing route.

', 'DescribeVirtualNode' => '

Describes an existing virtual node.

', 'DescribeVirtualRouter' => '

Describes an existing virtual router.

', 'DescribeVirtualService' => '

Describes an existing virtual service.

', 'ListMeshes' => '

Returns a list of existing service meshes.

', 'ListRoutes' => '

Returns a list of existing routes in a service mesh.

', 'ListVirtualNodes' => '

Returns a list of existing virtual nodes.

', 'ListVirtualRouters' => '

Returns a list of existing virtual routers in a service mesh.

', 'ListVirtualServices' => '

Returns a list of existing virtual services in a service mesh.

', 'UpdateRoute' => '

Updates an existing route for a specified service mesh and virtual router.

', 'UpdateVirtualNode' => '

Updates an existing virtual node in a specified service mesh.

', 'UpdateVirtualRouter' => '

Updates an existing virtual router in a specified service mesh.

', 'UpdateVirtualService' => '

Updates an existing virtual service in a specified service mesh.

', ], 'shapes' => [ 'Arn' => [ 'base' => NULL, 'refs' => [], ], 'Backend' => [ 'base' => '

An object representing the backends that a virtual node is expected to send outbound traffic to.

', 'refs' => [ 'Backend$virtualService' => '

Specifies a virtual service to use as a backend for a virtual node.

', ], ], 'Backends' => [ 'base' => NULL, 'refs' => [ 'Backends$member' => NULL, ], ], 'BadRequestException' => [ 'base' => '

The request syntax was malformed. Check your request syntax and try again.

', 'refs' => [], ], 'ConflictException' => [ 'base' => '

The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.

', 'refs' => [], ], 'CreateMeshInput' => [ 'base' => '', 'refs' => [ 'CreateMeshInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'CreateMeshInput$meshName' => '

The name to use for the service mesh.

', ], ], 'CreateMeshOutput' => [ 'base' => '', 'refs' => [ 'CreateMeshOutput$mesh' => '

The full description of your service mesh following the create call.

', ], ], 'CreateRouteInput' => [ 'base' => '', 'refs' => [ 'CreateRouteInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'CreateRouteInput$meshName' => '

The name of the service mesh in which to create the route.

', 'CreateRouteInput$routeName' => '

The name to use for the route.

', 'CreateRouteInput$spec' => '

The route specification to apply.

', 'CreateRouteInput$virtualRouterName' => '

The name of the virtual router in which to create the route.

', ], ], 'CreateRouteOutput' => [ 'base' => '', 'refs' => [ 'CreateRouteOutput$route' => '

The full description of your mesh following the create call.

', ], ], 'CreateVirtualNodeInput' => [ 'base' => '', 'refs' => [ 'CreateVirtualNodeInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'CreateVirtualNodeInput$meshName' => '

The name of the service mesh in which to create the virtual node.

', 'CreateVirtualNodeInput$spec' => '

The virtual node specification to apply.

', 'CreateVirtualNodeInput$virtualNodeName' => '

The name to use for the virtual node.

', ], ], 'CreateVirtualNodeOutput' => [ 'base' => '', 'refs' => [ 'CreateVirtualNodeOutput$virtualNode' => '

The full description of your virtual node following the create call.

', ], ], 'CreateVirtualRouterInput' => [ 'base' => '', 'refs' => [ 'CreateVirtualRouterInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'CreateVirtualRouterInput$meshName' => '

The name of the service mesh to create the virtual router in.

', 'CreateVirtualRouterInput$spec' => '

The virtual router specification to apply.

', 'CreateVirtualRouterInput$virtualRouterName' => '

The name to use for the virtual router.

', ], ], 'CreateVirtualRouterOutput' => [ 'base' => '', 'refs' => [ 'CreateVirtualRouterOutput$virtualRouter' => '

The full description of your virtual router following the create call.

', ], ], 'CreateVirtualServiceInput' => [ 'base' => '', 'refs' => [ 'CreateVirtualServiceInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'CreateVirtualServiceInput$meshName' => '

The name of the service mesh in which to create the virtual service.

', 'CreateVirtualServiceInput$spec' => '

The virtual service specification to apply.

', 'CreateVirtualServiceInput$virtualServiceName' => '

The name to use for the virtual service.

', ], ], 'CreateVirtualServiceOutput' => [ 'base' => '', 'refs' => [ 'CreateVirtualServiceOutput$virtualService' => '

The full description of your virtual service following the create call.

', ], ], 'DeleteMeshInput' => [ 'base' => '', 'refs' => [ 'DeleteMeshInput$meshName' => '

The name of the service mesh to delete.

', ], ], 'DeleteMeshOutput' => [ 'base' => '', 'refs' => [ 'DeleteMeshOutput$mesh' => '

The service mesh that was deleted.

', ], ], 'DeleteRouteInput' => [ 'base' => '', 'refs' => [ 'DeleteRouteInput$meshName' => '

The name of the service mesh to delete the route in.

', 'DeleteRouteInput$routeName' => '

The name of the route to delete.

', 'DeleteRouteInput$virtualRouterName' => '

The name of the virtual router to delete the route in.

', ], ], 'DeleteRouteOutput' => [ 'base' => '', 'refs' => [ 'DeleteRouteOutput$route' => '

The route that was deleted.

', ], ], 'DeleteVirtualNodeInput' => [ 'base' => '', 'refs' => [ 'DeleteVirtualNodeInput$meshName' => '

The name of the service mesh to delete the virtual node in.

', 'DeleteVirtualNodeInput$virtualNodeName' => '

The name of the virtual node to delete.

', ], ], 'DeleteVirtualNodeOutput' => [ 'base' => '', 'refs' => [ 'DeleteVirtualNodeOutput$virtualNode' => '

The virtual node that was deleted.

', ], ], 'DeleteVirtualRouterInput' => [ 'base' => '', 'refs' => [ 'DeleteVirtualRouterInput$meshName' => '

The name of the service mesh to delete the virtual router in.

', 'DeleteVirtualRouterInput$virtualRouterName' => '

The name of the virtual router to delete.

', ], ], 'DeleteVirtualRouterOutput' => [ 'base' => '', 'refs' => [ 'DeleteVirtualRouterOutput$virtualRouter' => '

The virtual router that was deleted.

', ], ], 'DeleteVirtualServiceInput' => [ 'base' => '', 'refs' => [ 'DeleteVirtualServiceInput$meshName' => '

The name of the service mesh to delete the virtual service in.

', 'DeleteVirtualServiceInput$virtualServiceName' => '

The name of the virtual service to delete.

', ], ], 'DeleteVirtualServiceOutput' => [ 'base' => '', 'refs' => [ 'DeleteVirtualServiceOutput$virtualService' => '

The virtual service that was deleted.

', ], ], 'DescribeMeshInput' => [ 'base' => '', 'refs' => [ 'DescribeMeshInput$meshName' => '

The name of the service mesh to describe.

', ], ], 'DescribeMeshOutput' => [ 'base' => '', 'refs' => [ 'DescribeMeshOutput$mesh' => '

The full description of your service mesh.

', ], ], 'DescribeRouteInput' => [ 'base' => '', 'refs' => [ 'DescribeRouteInput$meshName' => '

The name of the service mesh that the route resides in.

', 'DescribeRouteInput$routeName' => '

The name of the route to describe.

', 'DescribeRouteInput$virtualRouterName' => '

The name of the virtual router that the route is associated with.

', ], ], 'DescribeRouteOutput' => [ 'base' => '', 'refs' => [ 'DescribeRouteOutput$route' => '

The full description of your route.

', ], ], 'DescribeVirtualNodeInput' => [ 'base' => '', 'refs' => [ 'DescribeVirtualNodeInput$meshName' => '

The name of the service mesh that the virtual node resides in.

', 'DescribeVirtualNodeInput$virtualNodeName' => '

The name of the virtual node to describe.

', ], ], 'DescribeVirtualNodeOutput' => [ 'base' => '', 'refs' => [ 'DescribeVirtualNodeOutput$virtualNode' => '

The full description of your virtual node.

', ], ], 'DescribeVirtualRouterInput' => [ 'base' => '', 'refs' => [ 'DescribeVirtualRouterInput$meshName' => '

The name of the service mesh that the virtual router resides in.

', 'DescribeVirtualRouterInput$virtualRouterName' => '

The name of the virtual router to describe.

', ], ], 'DescribeVirtualRouterOutput' => [ 'base' => '', 'refs' => [ 'DescribeVirtualRouterOutput$virtualRouter' => '

The full description of your virtual router.

', ], ], 'DescribeVirtualServiceInput' => [ 'base' => '', 'refs' => [ 'DescribeVirtualServiceInput$meshName' => '

The name of the service mesh that the virtual service resides in.

', 'DescribeVirtualServiceInput$virtualServiceName' => '

The name of the virtual service to describe.

', ], ], 'DescribeVirtualServiceOutput' => [ 'base' => '', 'refs' => [ 'DescribeVirtualServiceOutput$virtualService' => '

The full description of your virtual service.

', ], ], 'DnsServiceDiscovery' => [ 'base' => '

An object representing the DNS service discovery information for your virtual node.

', 'refs' => [ 'DnsServiceDiscovery$hostname' => '

Specifies the DNS service discovery hostname for the virtual node.

', ], ], 'ForbiddenException' => [ 'base' => '

You don\'t have permissions to perform this action.

', 'refs' => [], ], 'HealthCheckIntervalMillis' => [ 'base' => NULL, 'refs' => [], ], 'HealthCheckPolicy' => [ 'base' => '

An object representing the health check policy for a virtual node\'s listener.

', 'refs' => [ 'HealthCheckPolicy$healthyThreshold' => '

The number of consecutive successful health checks that must occur before declaring listener healthy.

', 'HealthCheckPolicy$intervalMillis' => '

The time period in milliseconds between each health check execution.

', 'HealthCheckPolicy$path' => '

The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

', 'HealthCheckPolicy$port' => '

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

', 'HealthCheckPolicy$protocol' => '

The protocol for the health check request.

', 'HealthCheckPolicy$timeoutMillis' => '

The amount of time to wait when receiving a response from the health check, in milliseconds.

', 'HealthCheckPolicy$unhealthyThreshold' => '

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

', ], ], 'HealthCheckThreshold' => [ 'base' => NULL, 'refs' => [], ], 'HealthCheckTimeoutMillis' => [ 'base' => NULL, 'refs' => [], ], 'Hostname' => [ 'base' => NULL, 'refs' => [], ], 'HttpRoute' => [ 'base' => '

An object representing the HTTP routing specification for a route.

', 'refs' => [ 'HttpRoute$action' => '

The action to take if a match is determined.

', 'HttpRoute$match' => '

The criteria for determining an HTTP request match.

', ], ], 'HttpRouteAction' => [ 'base' => '

An object representing the traffic distribution requirements for matched HTTP requests.

', 'refs' => [ 'HttpRouteAction$weightedTargets' => '

The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

', ], ], 'HttpRouteMatch' => [ 'base' => '

An object representing the requirements for a route to match HTTP requests for a virtual router.

', 'refs' => [ 'HttpRouteMatch$prefix' => '

Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

', ], ], 'InternalServerErrorException' => [ 'base' => '

The request processing has failed because of an unknown error, exception, or failure.

', 'refs' => [], ], 'LimitExceededException' => [ 'base' => '

You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.

', 'refs' => [], ], 'ListMeshesInput' => [ 'base' => '', 'refs' => [ 'ListMeshesInput$limit' => '

The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.

', 'ListMeshesInput$nextToken' => '

The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', ], ], 'ListMeshesLimit' => [ 'base' => NULL, 'refs' => [], ], 'ListMeshesOutput' => [ 'base' => '', 'refs' => [ 'ListMeshesOutput$meshes' => '

The list of existing service meshes.

', 'ListMeshesOutput$nextToken' => '

The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

', ], ], 'ListRoutesInput' => [ 'base' => '', 'refs' => [ 'ListRoutesInput$limit' => '

The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

', 'ListRoutesInput$meshName' => '

The name of the service mesh in which to list routes.

', 'ListRoutesInput$nextToken' => '

The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

', 'ListRoutesInput$virtualRouterName' => '

The name of the virtual router to list routes in.

', ], ], 'ListRoutesLimit' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutesOutput' => [ 'base' => '', 'refs' => [ 'ListRoutesOutput$nextToken' => '

The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListRoutesOutput$routes' => '

The list of existing routes for the specified service mesh and virtual router.

', ], ], 'ListVirtualNodesInput' => [ 'base' => '', 'refs' => [ 'ListVirtualNodesInput$limit' => '

The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.

', 'ListVirtualNodesInput$meshName' => '

The name of the service mesh to list virtual nodes in.

', 'ListVirtualNodesInput$nextToken' => '

The nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

', ], ], 'ListVirtualNodesLimit' => [ 'base' => NULL, 'refs' => [], ], 'ListVirtualNodesOutput' => [ 'base' => '', 'refs' => [ 'ListVirtualNodesOutput$nextToken' => '

The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListVirtualNodesOutput$virtualNodes' => '

The list of existing virtual nodes for the specified service mesh.

', ], ], 'ListVirtualRoutersInput' => [ 'base' => '', 'refs' => [ 'ListVirtualRoutersInput$limit' => '

The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

', 'ListVirtualRoutersInput$meshName' => '

The name of the service mesh to list virtual routers in.

', 'ListVirtualRoutersInput$nextToken' => '

The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

', ], ], 'ListVirtualRoutersLimit' => [ 'base' => NULL, 'refs' => [], ], 'ListVirtualRoutersOutput' => [ 'base' => '', 'refs' => [ 'ListVirtualRoutersOutput$nextToken' => '

The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListVirtualRoutersOutput$virtualRouters' => '

The list of existing virtual routers for the specified service mesh.

', ], ], 'ListVirtualServicesInput' => [ 'base' => '', 'refs' => [ 'ListVirtualServicesInput$limit' => '

The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.

', 'ListVirtualServicesInput$meshName' => '

The name of the service mesh to list virtual services in.

', 'ListVirtualServicesInput$nextToken' => '

The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

', ], ], 'ListVirtualServicesLimit' => [ 'base' => NULL, 'refs' => [], ], 'ListVirtualServicesOutput' => [ 'base' => '', 'refs' => [ 'ListVirtualServicesOutput$nextToken' => '

The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListVirtualServicesOutput$virtualServices' => '

The list of existing virtual services for the specified service mesh.

', ], ], 'Listener' => [ 'base' => '

An object representing a listener for a virtual node.

', 'refs' => [ 'Listener$healthCheck' => '

The health check information for the listener.

', 'Listener$portMapping' => '

The port mapping information for the listener.

', ], ], 'Listeners' => [ 'base' => NULL, 'refs' => [ 'Listeners$member' => NULL, ], ], 'Long' => [ 'base' => NULL, 'refs' => [], ], 'MeshData' => [ 'base' => '

An object representing a service mesh returned by a describe operation.

', 'refs' => [ 'MeshData$meshName' => '

The name of the service mesh.

', 'MeshData$metadata' => '

The associated metadata for the service mesh.

', 'MeshData$status' => '

The status of the service mesh.

', ], ], 'MeshList' => [ 'base' => NULL, 'refs' => [ 'MeshList$member' => NULL, ], ], 'MeshRef' => [ 'base' => '

An object representing a service mesh returned by a list operation.

', 'refs' => [ 'MeshRef$arn' => '

The full Amazon Resource Name (ARN) of the service mesh.

', 'MeshRef$meshName' => '

The name of the service mesh.

', ], ], 'MeshStatus' => [ 'base' => '

An object representing the status of a service mesh.

', 'refs' => [ 'MeshStatus$status' => '

The current mesh status.

', ], ], 'MeshStatusCode' => [ 'base' => NULL, 'refs' => [], ], 'NotFoundException' => [ 'base' => '

The specified resource doesn\'t exist. Check your request syntax and try again.

', 'refs' => [], ], 'PercentInt' => [ 'base' => NULL, 'refs' => [], ], 'PortMapping' => [ 'base' => '

An object representing a virtual node or virtual router listener port mapping.

', 'refs' => [ 'PortMapping$port' => '

The port used for the port mapping.

', 'PortMapping$protocol' => '

The protocol used for the port mapping.

', ], ], 'PortNumber' => [ 'base' => NULL, 'refs' => [], ], 'PortProtocol' => [ 'base' => NULL, 'refs' => [], ], 'ResourceInUseException' => [ 'base' => '

You can\'t delete the specified resource because it\'s in use or required by another resource.

', 'refs' => [], ], 'ResourceMetadata' => [ 'base' => '

An object representing metadata for a resource.

', 'refs' => [ 'ResourceMetadata$arn' => '

The full Amazon Resource Name (ARN) for the resource.

After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group\'s Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

', 'ResourceMetadata$createdAt' => '

The Unix epoch timestamp in seconds for when the resource was created.

', 'ResourceMetadata$lastUpdatedAt' => '

The Unix epoch timestamp in seconds for when the resource was last updated.

', 'ResourceMetadata$uid' => '

The unique identifier for the resource.

', 'ResourceMetadata$version' => '

The version of the resource. Resources are created at version 1, and this version is incremented each time that they\'re updated.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [], ], 'RouteData' => [ 'base' => '

An object representing a route returned by a describe operation.

', 'refs' => [ 'RouteData$meshName' => '

The name of the service mesh that the route resides in.

', 'RouteData$metadata' => '

The associated metadata for the route.

', 'RouteData$routeName' => '

The name of the route.

', 'RouteData$spec' => '

The specifications of the route.

', 'RouteData$status' => '

The status of the route.

', 'RouteData$virtualRouterName' => '

The virtual router that the route is associated with.

', ], ], 'RouteList' => [ 'base' => NULL, 'refs' => [ 'RouteList$member' => NULL, ], ], 'RouteRef' => [ 'base' => '

An object representing a route returned by a list operation.

', 'refs' => [ 'RouteRef$arn' => '

The full Amazon Resource Name (ARN) for the route.

', 'RouteRef$meshName' => '

The name of the service mesh that the route resides in.

', 'RouteRef$routeName' => '

The name of the route.

', 'RouteRef$virtualRouterName' => '

The virtual router that the route is associated with.

', ], ], 'RouteSpec' => [ 'base' => '

An object representing the specification of a route.

', 'refs' => [ 'RouteSpec$httpRoute' => '

The HTTP routing information for the route.

', ], ], 'RouteStatus' => [ 'base' => '

An object representing the current status of a route.

', 'refs' => [ 'RouteStatus$status' => '

The current status for the route.

', ], ], 'RouteStatusCode' => [ 'base' => NULL, 'refs' => [], ], 'ServiceDiscovery' => [ 'base' => '

An object representing the service discovery information for a virtual node.

', 'refs' => [ 'ServiceDiscovery$dns' => '

Specifies the DNS information for the virtual node.

', ], ], 'ServiceName' => [ 'base' => NULL, 'refs' => [], ], 'ServiceUnavailableException' => [ 'base' => '

The request has failed due to a temporary failure of the service.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [], ], 'TooManyRequestsException' => [ 'base' => '

The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.

', 'refs' => [], ], 'UpdateRouteInput' => [ 'base' => '', 'refs' => [ 'UpdateRouteInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'UpdateRouteInput$meshName' => '

The name of the service mesh that the route resides in.

', 'UpdateRouteInput$routeName' => '

The name of the route to update.

', 'UpdateRouteInput$spec' => '

The new route specification to apply. This overwrites the existing data.

', 'UpdateRouteInput$virtualRouterName' => '

The name of the virtual router that the route is associated with.

', ], ], 'UpdateRouteOutput' => [ 'base' => '', 'refs' => [ 'UpdateRouteOutput$route' => '

A full description of the route that was updated.

', ], ], 'UpdateVirtualNodeInput' => [ 'base' => '', 'refs' => [ 'UpdateVirtualNodeInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'UpdateVirtualNodeInput$meshName' => '

The name of the service mesh that the virtual node resides in.

', 'UpdateVirtualNodeInput$spec' => '

The new virtual node specification to apply. This overwrites the existing data.

', 'UpdateVirtualNodeInput$virtualNodeName' => '

The name of the virtual node to update.

', ], ], 'UpdateVirtualNodeOutput' => [ 'base' => '', 'refs' => [ 'UpdateVirtualNodeOutput$virtualNode' => '

A full description of the virtual node that was updated.

', ], ], 'UpdateVirtualRouterInput' => [ 'base' => '', 'refs' => [ 'UpdateVirtualRouterInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'UpdateVirtualRouterInput$meshName' => '

The name of the service mesh that the virtual router resides in.

', 'UpdateVirtualRouterInput$spec' => '

The new virtual router specification to apply. This overwrites the existing data.

', 'UpdateVirtualRouterInput$virtualRouterName' => '

The name of the virtual router to update.

', ], ], 'UpdateVirtualRouterOutput' => [ 'base' => '', 'refs' => [ 'UpdateVirtualRouterOutput$virtualRouter' => '

A full description of the virtual router that was updated.

', ], ], 'UpdateVirtualServiceInput' => [ 'base' => '', 'refs' => [ 'UpdateVirtualServiceInput$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

', 'UpdateVirtualServiceInput$meshName' => '

The name of the service mesh that the virtual service resides in.

', 'UpdateVirtualServiceInput$spec' => '

The new virtual service specification to apply. This overwrites the existing data.

', 'UpdateVirtualServiceInput$virtualServiceName' => '

The name of the virtual service to update.

', ], ], 'UpdateVirtualServiceOutput' => [ 'base' => '', 'refs' => [ 'UpdateVirtualServiceOutput$virtualService' => '

A full description of the virtual service that was updated.

', ], ], 'VirtualNodeData' => [ 'base' => '

An object representing a virtual node returned by a describe operation.

', 'refs' => [ 'VirtualNodeData$meshName' => '

The name of the service mesh that the virtual node resides in.

', 'VirtualNodeData$metadata' => '

The associated metadata for the virtual node.

', 'VirtualNodeData$spec' => '

The specifications of the virtual node.

', 'VirtualNodeData$status' => '

The current status for the virtual node.

', 'VirtualNodeData$virtualNodeName' => '

The name of the virtual node.

', ], ], 'VirtualNodeList' => [ 'base' => NULL, 'refs' => [ 'VirtualNodeList$member' => NULL, ], ], 'VirtualNodeRef' => [ 'base' => '

An object representing a virtual node returned by a list operation.

', 'refs' => [ 'VirtualNodeRef$arn' => '

The full Amazon Resource Name (ARN) for the virtual node.

', 'VirtualNodeRef$meshName' => '

The name of the service mesh that the virtual node resides in.

', 'VirtualNodeRef$virtualNodeName' => '

The name of the virtual node.

', ], ], 'VirtualNodeServiceProvider' => [ 'base' => '

An object representing a virtual node service provider.

', 'refs' => [ 'VirtualNodeServiceProvider$virtualNodeName' => '

The name of the virtual node that is acting as a service provider.

', ], ], 'VirtualNodeSpec' => [ 'base' => '

An object representing the specification of a virtual node.

', 'refs' => [ 'VirtualNodeSpec$backends' => '

The backends that the virtual node is expected to send outbound traffic to.

', 'VirtualNodeSpec$listeners' => '

The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

', 'VirtualNodeSpec$serviceDiscovery' => '

The service discovery information for the virtual node.

', ], ], 'VirtualNodeStatus' => [ 'base' => '

An object representing the current status of the virtual node.

', 'refs' => [ 'VirtualNodeStatus$status' => '

The current status of the virtual node.

', ], ], 'VirtualNodeStatusCode' => [ 'base' => NULL, 'refs' => [], ], 'VirtualRouterData' => [ 'base' => '

An object representing a virtual router returned by a describe operation.

', 'refs' => [ 'VirtualRouterData$meshName' => '

The name of the service mesh that the virtual router resides in.

', 'VirtualRouterData$metadata' => '

The associated metadata for the virtual router.

', 'VirtualRouterData$spec' => '

The specifications of the virtual router.

', 'VirtualRouterData$status' => '

The current status of the virtual router.

', 'VirtualRouterData$virtualRouterName' => '

The name of the virtual router.

', ], ], 'VirtualRouterList' => [ 'base' => NULL, 'refs' => [ 'VirtualRouterList$member' => NULL, ], ], 'VirtualRouterListener' => [ 'base' => '

An object representing a virtual router listener.

', 'refs' => [], ], 'VirtualRouterListeners' => [ 'base' => NULL, 'refs' => [ 'VirtualRouterListeners$member' => NULL, ], ], 'VirtualRouterRef' => [ 'base' => '

An object representing a virtual router returned by a list operation.

', 'refs' => [ 'VirtualRouterRef$arn' => '

The full Amazon Resource Name (ARN) for the virtual router.

', 'VirtualRouterRef$meshName' => '

The name of the service mesh that the virtual router resides in.

', 'VirtualRouterRef$virtualRouterName' => '

The name of the virtual router.

', ], ], 'VirtualRouterServiceProvider' => [ 'base' => '

An object representing a virtual node service provider.

', 'refs' => [ 'VirtualRouterServiceProvider$virtualRouterName' => '

The name of the virtual router that is acting as a service provider.

', ], ], 'VirtualRouterSpec' => [ 'base' => '

An object representing the specification of a virtual router.

', 'refs' => [ 'VirtualRouterSpec$listeners' => '

The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.

', ], ], 'VirtualRouterStatus' => [ 'base' => '

An object representing the status of a virtual router.

', 'refs' => [ 'VirtualRouterStatus$status' => '

The current status of the virtual router.

', ], ], 'VirtualRouterStatusCode' => [ 'base' => NULL, 'refs' => [], ], 'VirtualServiceBackend' => [ 'base' => '

An object representing a virtual service backend for a virtual node.

', 'refs' => [ 'VirtualServiceBackend$virtualServiceName' => '

The name of the virtual service that is acting as a virtual node backend.

', ], ], 'VirtualServiceData' => [ 'base' => '

An object representing a virtual service returned by a describe operation.

', 'refs' => [ 'VirtualServiceData$meshName' => '

The name of the service mesh that the virtual service resides in.

', 'VirtualServiceData$spec' => '

The specifications of the virtual service.

', 'VirtualServiceData$status' => '

The current status of the virtual service.

', 'VirtualServiceData$virtualServiceName' => '

The name of the virtual service.

', ], ], 'VirtualServiceList' => [ 'base' => NULL, 'refs' => [ 'VirtualServiceList$member' => NULL, ], ], 'VirtualServiceProvider' => [ 'base' => '

An object representing the provider for a virtual service.

', 'refs' => [ 'VirtualServiceProvider$virtualNode' => '

The virtual node associated with a virtual service.

', 'VirtualServiceProvider$virtualRouter' => '

The virtual router associated with a virtual service.

', ], ], 'VirtualServiceRef' => [ 'base' => '

An object representing a virtual service returned by a list operation.

', 'refs' => [ 'VirtualServiceRef$arn' => '

The full Amazon Resource Name (ARN) for the virtual service.

', 'VirtualServiceRef$meshName' => '

The name of the service mesh that the virtual service resides in.

', 'VirtualServiceRef$virtualServiceName' => '

The name of the virtual service.

', ], ], 'VirtualServiceSpec' => [ 'base' => '

An object representing the specification of a virtual service.

', 'refs' => [ 'VirtualServiceSpec$provider' => '

The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

', ], ], 'VirtualServiceStatus' => [ 'base' => '

An object representing the status of a virtual service.

', 'refs' => [ 'VirtualServiceStatus$status' => '

The current status of the virtual service.

', ], ], 'VirtualServiceStatusCode' => [ 'base' => NULL, 'refs' => [], ], 'WeightedTarget' => [ 'base' => '

An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

', 'refs' => [ 'WeightedTarget$virtualNode' => '

The virtual node to associate with the weighted target.

', 'WeightedTarget$weight' => '

The relative weight of the weighted target.

', ], ], 'WeightedTargets' => [ 'base' => NULL, 'refs' => [ 'WeightedTargets$member' => NULL, ], ], ],]; diff --git a/src/data/appmesh/2019-01-25/examples-1.json b/src/data/appmesh/2019-01-25/examples-1.json new file mode 100644 index 0000000000..752e89e032 --- /dev/null +++ b/src/data/appmesh/2019-01-25/examples-1.json @@ -0,0 +1,4 @@ +{ + "version": "1.0", + "examples": { } +} \ No newline at end of file diff --git a/src/data/appmesh/2019-01-25/examples-1.json.php b/src/data/appmesh/2019-01-25/examples-1.json.php new file mode 100644 index 0000000000..f622f0f00a --- /dev/null +++ b/src/data/appmesh/2019-01-25/examples-1.json.php @@ -0,0 +1,3 @@ + '1.0', 'examples' => [],]; diff --git a/src/data/appmesh/2019-01-25/paginators-1.json b/src/data/appmesh/2019-01-25/paginators-1.json new file mode 100644 index 0000000000..e1394e8fb6 --- /dev/null +++ b/src/data/appmesh/2019-01-25/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListMeshes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "meshes" + }, + "ListRoutes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "routes" + }, + "ListVirtualNodes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualNodes" + }, + "ListVirtualRouters": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualRouters" + }, + "ListVirtualServices": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualServices" + } + } +} \ No newline at end of file diff --git a/src/data/appmesh/2019-01-25/paginators-1.json.php b/src/data/appmesh/2019-01-25/paginators-1.json.php new file mode 100644 index 0000000000..2af19fb918 --- /dev/null +++ b/src/data/appmesh/2019-01-25/paginators-1.json.php @@ -0,0 +1,3 @@ + [ 'ListMeshes' => [ 'input_token' => 'nextToken', 'limit_key' => 'limit', 'output_token' => 'nextToken', 'result_key' => 'meshes', ], 'ListRoutes' => [ 'input_token' => 'nextToken', 'limit_key' => 'limit', 'output_token' => 'nextToken', 'result_key' => 'routes', ], 'ListVirtualNodes' => [ 'input_token' => 'nextToken', 'limit_key' => 'limit', 'output_token' => 'nextToken', 'result_key' => 'virtualNodes', ], 'ListVirtualRouters' => [ 'input_token' => 'nextToken', 'limit_key' => 'limit', 'output_token' => 'nextToken', 'result_key' => 'virtualRouters', ], 'ListVirtualServices' => [ 'input_token' => 'nextToken', 'limit_key' => 'limit', 'output_token' => 'nextToken', 'result_key' => 'virtualServices', ], ],]; diff --git a/src/data/autoscaling/2011-01-01/docs-2.json b/src/data/autoscaling/2011-01-01/docs-2.json index 6536dc4d44..28b6576757 100644 --- a/src/data/autoscaling/2011-01-01/docs-2.json +++ b/src/data/autoscaling/2011-01-01/docs-2.json @@ -1,24 +1,24 @@ { "version": "2.0", - "service": "Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.

For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.

", + "service": "Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.

For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.

", "operations": { - "AttachInstances": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", - "AttachLoadBalancerTargetGroups": "

Attaches one or more target groups to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", - "AttachLoadBalancers": "

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "AttachInstances": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "AttachLoadBalancerTargetGroups": "

Attaches one or more target groups to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "AttachLoadBalancers": "

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", "BatchDeleteScheduledAction": "

Deletes one or more scheduled actions for the specified Auto Scaling group.

", "BatchPutScheduledUpdateGroupAction": "

Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

", - "CompleteLifecycleAction": "

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

", - "CreateAutoScalingGroup": "

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

For more information, see Auto Scaling Groups in the Amazon EC2 Auto Scaling User Guide.

", - "CreateLaunchConfiguration": "

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.

", - "CreateOrUpdateTags": "

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

", + "CompleteLifecycleAction": "

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroup": "

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

", + "CreateLaunchConfiguration": "

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.

", + "CreateOrUpdateTags": "

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

", "DeleteAutoScalingGroup": "

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.

", "DeleteLaunchConfiguration": "

Deletes the specified launch configuration.

The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

", "DeleteLifecycleHook": "

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

", "DeleteNotificationConfiguration": "

Deletes the specified notification.

", - "DeletePolicy": "

Deletes the specified Auto Scaling policy.

Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

", + "DeletePolicy": "

Deletes the specified scaling policy.

Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

", "DeleteScheduledAction": "

Deletes the specified scheduled action.

", "DeleteTags": "

Deletes the specified tags.

", - "DescribeAccountLimits": "

Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

", + "DescribeAccountLimits": "

Describes the current Amazon EC2 Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

", "DescribeAdjustmentTypes": "

Describes the policy adjustment types for use with PutScalingPolicy.

", "DescribeAutoScalingGroups": "

Describes one or more Auto Scaling groups.

", "DescribeAutoScalingInstances": "

Describes one or more Auto Scaling instances.

", @@ -35,25 +35,25 @@ "DescribeScalingProcessTypes": "

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

", "DescribeScheduledActions": "

Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.

", "DescribeTags": "

Describes the specified tags.

You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.

", - "DescribeTerminationPolicyTypes": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

", - "DetachInstances": "

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "DescribeTerminationPolicyTypes": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

", + "DetachInstances": "

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", "DetachLoadBalancerTargetGroups": "

Detaches one or more target groups from the specified Auto Scaling group.

", "DetachLoadBalancers": "

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead.

When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.

", "DisableMetricsCollection": "

Disables group metrics for the specified Auto Scaling group.

", - "EnableMetricsCollection": "

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

", - "EnterStandby": "

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "EnableMetricsCollection": "

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

", + "EnterStandby": "

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", "ExecutePolicy": "

Executes the specified policy.

", - "ExitStandby": "

Moves the specified instances out of the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", - "PutLifecycleHook": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

", - "PutNotificationConfiguration": "

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.

", + "ExitStandby": "

Moves the specified instances out of the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "PutLifecycleHook": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat.

  5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

", + "PutNotificationConfiguration": "

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.

", "PutScalingPolicy": "

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

", - "PutScheduledUpdateGroupAction": "

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.

", - "RecordLifecycleActionHeartbeat": "

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

", - "ResumeProcesses": "

Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

", - "SetDesiredCapacity": "

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.

", - "SetInstanceHealth": "

Sets the health status of the specified instance.

For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

", - "SetInstanceProtection": "

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

", - "SuspendProcesses": "

Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

", + "PutScheduledUpdateGroupAction": "

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "RecordLifecycleActionHeartbeat": "

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

", + "ResumeProcesses": "

Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

", + "SetDesiredCapacity": "

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.

", + "SetInstanceHealth": "

Sets the health status of the specified instance.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

", + "SetInstanceProtection": "

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

", + "SuspendProcesses": "

Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

", "TerminateInstanceInAutoScalingGroup": "

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instance is not terminated immediately.

", "UpdateAutoScalingGroup": "

Updates the configuration for the specified Auto Scaling group.

The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

Note the following:

" }, @@ -111,7 +111,7 @@ "Alarms": { "base": null, "refs": { - "PolicyARNType$Alarms": "

The CloudWatch alarms created for the target tracking policy.

", + "PolicyARNType$Alarms": "

The CloudWatch alarms created for the target tracking scaling policy.

", "ScalingPolicy$Alarms": "

The CloudWatch alarms related to the policy.

" } }, @@ -135,7 +135,7 @@ "AssociatePublicIpAddress": { "base": null, "refs": { - "CreateLaunchConfigurationType$AssociatePublicIpAddress": "

Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.

", + "CreateLaunchConfigurationType$AssociatePublicIpAddress": "

Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.

", "LaunchConfiguration$AssociatePublicIpAddress": "

[EC2-VPC] Indicates whether to assign a public IP address to each instance.

" } }, @@ -256,7 +256,7 @@ "base": null, "refs": { "AutoScalingGroup$AvailabilityZones": "

One or more Availability Zones for the group.

", - "CreateAutoScalingGroupType$AvailabilityZones": "

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

", + "CreateAutoScalingGroupType$AvailabilityZones": "

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.

", "UpdateAutoScalingGroupType$AvailabilityZones": "

One or more Availability Zones for the group.

" } }, @@ -283,31 +283,31 @@ "BlockDeviceEbsDeleteOnTermination": { "base": null, "refs": { - "Ebs$DeleteOnTermination": "

Indicates whether the volume is deleted on instance termination. The default is true.

" + "Ebs$DeleteOnTermination": "

Indicates whether the volume is deleted on instance termination. The default value is true.

" } }, "BlockDeviceEbsEncrypted": { "base": null, "refs": { - "Ebs$Encrypted": "

Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

" + "Ebs$Encrypted": "

Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

" } }, "BlockDeviceEbsIops": { "base": null, "refs": { - "Ebs$Iops": "

The number of I/O operations per second (IOPS) to provision for the volume.

Constraint: Required when the volume type is io1.

" + "Ebs$Iops": "

The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

" } }, "BlockDeviceEbsVolumeSize": { "base": null, "refs": { - "Ebs$VolumeSize": "

The volume size, in GiB. For standard volumes, specify a value from 1 to 1,024. For io1 volumes, specify a value from 4 to 16,384. For gp2 volumes, specify a value from 1 to 16,384. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.

" + "Ebs$VolumeSize": "

The volume size, in GiB.

Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.

At least one of VolumeSize or SnapshotId is required.

" } }, "BlockDeviceEbsVolumeType": { "base": null, "refs": { - "Ebs$VolumeType": "

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2

" + "Ebs$VolumeType": "

The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1

" } }, "BlockDeviceMapping": { @@ -319,15 +319,15 @@ "BlockDeviceMappings": { "base": null, "refs": { - "CreateLaunchConfigurationType$BlockDeviceMappings": "

One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

", + "CreateLaunchConfigurationType$BlockDeviceMappings": "

One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

", "LaunchConfiguration$BlockDeviceMappings": "

A block device mapping, which specifies the block devices for the instance.

" } }, "ClassicLinkVPCSecurityGroups": { "base": null, "refs": { - "CreateLaunchConfigurationType$ClassicLinkVPCSecurityGroups": "

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

", - "LaunchConfiguration$ClassicLinkVPCSecurityGroups": "

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" + "CreateLaunchConfigurationType$ClassicLinkVPCSecurityGroups": "

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise.

", + "LaunchConfiguration$ClassicLinkVPCSecurityGroups": "

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise.

" } }, "CompleteLifecycleActionAnswer": { @@ -344,10 +344,10 @@ "base": null, "refs": { "AutoScalingGroup$DefaultCooldown": "

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

", - "CreateAutoScalingGroupType$DefaultCooldown": "

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

", - "PutScalingPolicyType$Cooldown": "

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is supported if the policy type is SimpleScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroupType$DefaultCooldown": "

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

", + "PutScalingPolicyType$Cooldown": "

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is supported if the policy type is SimpleScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

", "ScalingPolicy$Cooldown": "

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

", - "UpdateAutoScalingGroupType$DefaultCooldown": "

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + "UpdateAutoScalingGroupType$DefaultCooldown": "

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" } }, "CreateAutoScalingGroupType": { @@ -366,9 +366,9 @@ } }, "CustomizedMetricSpecification": { - "base": "

Configures a customized metric for a target tracking policy to use with Amazon EC2 Auto Scaling.

", + "base": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized metric specification:

For more information about CloudWatch, see Amazon CloudWatch Concepts.

", "refs": { - "TargetTrackingConfiguration$CustomizedMetricSpecification": "

A customized metric.

" + "TargetTrackingConfiguration$CustomizedMetricSpecification": "

A customized metric. You can specify either a predefined metric or a customized metric.

" } }, "DeleteAutoScalingGroupType": { @@ -539,11 +539,11 @@ "DisableScaleIn": { "base": null, "refs": { - "TargetTrackingConfiguration$DisableScaleIn": "

Indicates whether scaling in by the target tracking policy is disabled. If scaling in is disabled, the target tracking policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking policy can remove instances from the Auto Scaling group. The default is disabled.

" + "TargetTrackingConfiguration$DisableScaleIn": "

Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is disabled.

" } }, "Ebs": { - "base": "

Describes an Amazon EBS volume.

", + "base": "

Describes an Amazon EBS volume. Used in combination with BlockDeviceMapping.

", "refs": { "BlockDeviceMapping$Ebs": "

The information about the Amazon EBS volume.

" } @@ -551,7 +551,7 @@ "EbsOptimized": { "base": null, "refs": { - "CreateLaunchConfigurationType$EbsOptimized": "

Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

", + "CreateLaunchConfigurationType$EbsOptimized": "

Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

", "LaunchConfiguration$EbsOptimized": "

Controls whether the instance is optimized for EBS I/O (true) or not (false).

" } }, @@ -645,22 +645,22 @@ "base": null, "refs": { "AutoScalingGroup$HealthCheckGracePeriod": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.

", - "CreateAutoScalingGroupType$HealthCheckGracePeriod": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.

This parameter is required if you are adding an ELB health check.

For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

", - "UpdateAutoScalingGroupType$HealthCheckGracePeriod": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.

For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

" + "CreateAutoScalingGroupType$HealthCheckGracePeriod": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is 0.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

", + "UpdateAutoScalingGroupType$HealthCheckGracePeriod": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

" } }, "HeartbeatTimeout": { "base": null, "refs": { - "LifecycleHook$HeartbeatTimeout": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

", - "LifecycleHookSpecification$HeartbeatTimeout": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

", - "PutLifecycleHookType$HeartbeatTimeout": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

" + "LifecycleHook$HeartbeatTimeout": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.

", + "LifecycleHookSpecification$HeartbeatTimeout": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out.

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

", + "PutLifecycleHookType$HeartbeatTimeout": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

" } }, "HonorCooldown": { "base": null, "refs": { - "ExecutePolicyType$HonorCooldown": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

", + "ExecutePolicyType$HonorCooldown": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

", "SetDesiredCapacityType$HonorCooldown": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

" } }, @@ -684,18 +684,18 @@ "InstanceMonitoring": { "base": "

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

", "refs": { - "CreateLaunchConfigurationType$InstanceMonitoring": "

Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default is true.

", + "CreateLaunchConfigurationType$InstanceMonitoring": "

Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default value is true.

", "LaunchConfiguration$InstanceMonitoring": "

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

" } }, "InstanceProtected": { "base": null, "refs": { - "AutoScalingGroup$NewInstancesProtectedFromScaleIn": "

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

For more information, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

", - "AutoScalingInstanceDetails$ProtectedFromScaleIn": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

", - "CreateAutoScalingGroupType$NewInstancesProtectedFromScaleIn": "

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

", - "Instance$ProtectedFromScaleIn": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

", - "UpdateAutoScalingGroupType$NewInstancesProtectedFromScaleIn": "

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" + "AutoScalingGroup$NewInstancesProtectedFromScaleIn": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

", + "AutoScalingInstanceDetails$ProtectedFromScaleIn": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

", + "CreateAutoScalingGroupType$NewInstancesProtectedFromScaleIn": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

", + "Instance$ProtectedFromScaleIn": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

", + "UpdateAutoScalingGroupType$NewInstancesProtectedFromScaleIn": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" } }, "Instances": { @@ -767,11 +767,11 @@ } }, "LaunchTemplateSpecification": { - "base": "

Describes a launch template and the launch template version.

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a Launch Template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

", + "base": "

Describes a launch template and the launch template version.

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", "refs": { "AutoScalingGroup$LaunchTemplate": "

The launch template for the group.

", "AutoScalingInstanceDetails$LaunchTemplate": "

The launch template for the instance.

", - "CreateAutoScalingGroupType$LaunchTemplate": "

The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified.

", + "CreateAutoScalingGroupType$LaunchTemplate": "

The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified.

For more information, see Creating an Auto Scaling Group Using a Launch Template in the Amazon EC2 Auto Scaling User Guide.

", "Instance$LaunchTemplate": "

The launch template for the instance.

", "LaunchTemplate$LaunchTemplateSpecification": "

The launch template to use. You must specify either the launch template ID or launch template name in the request.

", "UpdateAutoScalingGroupType$LaunchTemplate": "

The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy.

" @@ -781,8 +781,8 @@ "base": null, "refs": { "CompleteLifecycleActionType$LifecycleActionResult": "

The action for the group to take. This parameter can be either CONTINUE or ABANDON.

", - "LifecycleHook$DefaultResult": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is CONTINUE.

", - "LifecycleHookSpecification$DefaultResult": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON.

", + "LifecycleHook$DefaultResult": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.

", + "LifecycleHookSpecification$DefaultResult": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is ABANDON.

", "PutLifecycleHookType$DefaultResult": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

" } }, @@ -794,7 +794,7 @@ } }, "LifecycleHook": { - "base": "

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

", + "base": "

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances. Used in response to DescribeLifecycleHooks.

", "refs": { "LifecycleHooks$member": null } @@ -806,7 +806,7 @@ } }, "LifecycleHookSpecification": { - "base": "

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

", + "base": "

Describes a lifecycle hook. Used in combination with CreateAutoScalingGroup.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat.

  5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. You can modify an existing lifecycle hook or create new lifecycle hooks using PutLifecycleHook. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

", "refs": { "LifecycleHookSpecifications$member": null } @@ -833,12 +833,12 @@ "base": null, "refs": { "LifecycleHook$LifecycleTransition": "

The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

", - "LifecycleHookSpecification$LifecycleTransition": "

The state of the EC2 instance to which you want to attach the lifecycle hook. The possible values are:

", - "PutLifecycleHookType$LifecycleTransition": "

The instance state to which you want to attach the lifecycle hook. The possible values are:

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" + "LifecycleHookSpecification$LifecycleTransition": "

The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:

", + "PutLifecycleHookType$LifecycleTransition": "

The instance state to which you want to attach the lifecycle hook. The valid values are:

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" } }, "LimitExceededFault": { - "base": "

You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

", + "base": "

You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

", "refs": { } }, @@ -847,7 +847,7 @@ "refs": { "AttachLoadBalancersType$LoadBalancerNames": "

The names of the load balancers. You can specify up to 10 load balancers.

", "AutoScalingGroup$LoadBalancerNames": "

One or more load balancers associated with the group.

", - "CreateAutoScalingGroupType$LoadBalancerNames": "

One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroupType$LoadBalancerNames": "

One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", "DetachLoadBalancersType$LoadBalancerNames": "

The names of the load balancers. You can specify up to 10 load balancers.

" } }, @@ -890,16 +890,16 @@ "MaxRecords": { "base": null, "refs": { - "AutoScalingGroupNamesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", - "DescribeAutoScalingInstancesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

", - "DescribeLoadBalancerTargetGroupsRequest$MaxRecords": "

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

", - "DescribeLoadBalancersRequest$MaxRecords": "

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

", - "DescribeNotificationConfigurationsType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", - "DescribePoliciesType$MaxRecords": "

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

", - "DescribeScalingActivitiesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

", - "DescribeScheduledActionsType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", - "DescribeTagsType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", - "LaunchConfigurationNamesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

" + "AutoScalingGroupNamesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", + "DescribeAutoScalingInstancesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

", + "DescribeLoadBalancerTargetGroupsRequest$MaxRecords": "

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

", + "DescribeLoadBalancersRequest$MaxRecords": "

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

", + "DescribeNotificationConfigurationsType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", + "DescribePoliciesType$MaxRecords": "

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

", + "DescribeScalingActivitiesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

", + "DescribeScheduledActionsType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", + "DescribeTagsType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

", + "LaunchConfigurationNamesType$MaxRecords": "

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

" } }, "MetricCollectionType": { @@ -935,7 +935,7 @@ "MetricDimensions": { "base": null, "refs": { - "CustomizedMetricSpecification$Dimensions": "

The dimensions of the metric.

" + "CustomizedMetricSpecification$Dimensions": "

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

" } }, "MetricGranularityType": { @@ -965,8 +965,8 @@ "MetricScale": { "base": null, "refs": { - "ExecutePolicyType$MetricValue": "

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

This parameter is required if the policy type is StepScaling and not supported otherwise.

", - "ExecutePolicyType$BreachThreshold": "

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

", + "ExecutePolicyType$MetricValue": "

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

", + "ExecutePolicyType$BreachThreshold": "

The breach threshold for the alarm.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

", "StepAdjustment$MetricIntervalLowerBound": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

", "StepAdjustment$MetricIntervalUpperBound": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

", "TargetTrackingConfiguration$TargetValue": "

The target value for the metric.

" @@ -1018,11 +1018,11 @@ } }, "MixedInstancesPolicy": { - "base": "

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

When you create your Auto Scaling group, you can specify a launch configuration or template as a parameter for the top-level object, or you can specify a mixed instances policy, but not both at the same time.

", + "base": "

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. Used in combination with CreateAutoScalingGroup. For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

When you create your Auto Scaling group, you can specify a launch configuration or template as a parameter for the top-level object, or you can specify a mixed instances policy, but not both at the same time.

", "refs": { "AutoScalingGroup$MixedInstancesPolicy": "

The mixed instances policy for the group.

", - "CreateAutoScalingGroupType$MixedInstancesPolicy": "

The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.

", - "UpdateAutoScalingGroupType$MixedInstancesPolicy": "

The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template.

" + "CreateAutoScalingGroupType$MixedInstancesPolicy": "

The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.

For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

", + "UpdateAutoScalingGroupType$MixedInstancesPolicy": "

The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template.

For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

" } }, "MonitoringEnabled": { @@ -1053,7 +1053,7 @@ "base": null, "refs": { "LifecycleHookSpecification$NotificationTargetARN": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

", - "PutLifecycleHookType$NotificationTargetARN": "

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: \"Event\": \"autoscaling:TEST_NOTIFICATION\".

" + "PutLifecycleHookType$NotificationTargetARN": "

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: \"Event\": \"autoscaling:TEST_NOTIFICATION\".

" } }, "NumberOfAutoScalingGroups": { @@ -1071,13 +1071,13 @@ "OnDemandBaseCapacity": { "base": null, "refs": { - "InstancesDistribution$OnDemandBaseCapacity": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

" + "InstancesDistribution$OnDemandBaseCapacity": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

" } }, "OnDemandPercentageAboveBaseCapacity": { "base": null, "refs": { - "InstancesDistribution$OnDemandPercentageAboveBaseCapacity": "

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

" + "InstancesDistribution$OnDemandPercentageAboveBaseCapacity": "

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

" } }, "Overrides": { @@ -1099,7 +1099,7 @@ "PolicyIncrement": { "base": null, "refs": { - "PutScalingPolicyType$ScalingAdjustment": "

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

This parameter is required if the policy type is SimpleScaling and not supported otherwise.

", + "PutScalingPolicyType$ScalingAdjustment": "

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Conditional: This parameter is required if the policy type is SimpleScaling and not supported otherwise.

", "ScalingPolicy$ScalingAdjustment": "

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

", "StepAdjustment$ScalingAdjustment": "

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

" } @@ -1113,11 +1113,11 @@ "PolicyTypes": { "base": null, "refs": { - "DescribePoliciesType$PolicyTypes": "

One or more policy types. Valid values are SimpleScaling and StepScaling.

" + "DescribePoliciesType$PolicyTypes": "

One or more policy types. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.

" } }, "PredefinedMetricSpecification": { - "base": "

Configures a predefined metric for a target tracking policy.

", + "base": "

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

", "refs": { "TargetTrackingConfiguration$PredefinedMetricSpecification": "

A predefined metric. You can specify either a predefined metric or a customized metric.

" } @@ -1129,7 +1129,7 @@ } }, "ProcessType": { - "base": "

Describes a process type.

For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

", + "base": "

Describes a process type.

For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

", "refs": { "Processes$member": null } @@ -1200,7 +1200,7 @@ } }, "ResourceContentionFault": { - "base": "

You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

", + "base": "

You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

", "refs": { } }, @@ -1222,8 +1222,8 @@ "BatchDeleteScheduledActionType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "BatchPutScheduledUpdateGroupActionType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "CompleteLifecycleActionType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", - "CreateAutoScalingGroupType$LaunchConfigurationName": "

The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified.

", - "CreateAutoScalingGroupType$ServiceLinkedRoleARN": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist.

", + "CreateAutoScalingGroupType$LaunchConfigurationName": "

The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified.

For more information, see Creating an Auto Scaling Group Using a Launch Configuration in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroupType$ServiceLinkedRoleARN": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.

", "DeleteAutoScalingGroupType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "DeleteLifecycleHookType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "DeleteNotificationConfigurationType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", @@ -1253,13 +1253,13 @@ "LifecycleHook$AutoScalingGroupName": "

The name of the Auto Scaling group for the lifecycle hook.

", "LifecycleHook$NotificationTargetARN": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

", "LifecycleHook$RoleARN": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

", - "LifecycleHookSpecification$RoleARN": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

", + "LifecycleHookSpecification$RoleARN": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

", "NotificationConfiguration$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "NotificationConfiguration$TopicARN": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

", "PolicyARNType$PolicyARN": "

The Amazon Resource Name (ARN) of the policy.

", "PolicyNames$member": null, "PutLifecycleHookType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", - "PutLifecycleHookType$RoleARN": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

", + "PutLifecycleHookType$RoleARN": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

", "PutNotificationConfigurationType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "PutNotificationConfigurationType$TopicARN": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

", "PutScalingPolicyType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", @@ -1273,7 +1273,7 @@ "SetInstanceProtectionQuery$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "UpdateAutoScalingGroupType$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "UpdateAutoScalingGroupType$LaunchConfigurationName": "

The name of the launch configuration. If you specify this parameter, you can't specify a launch template or a mixed instances policy.

", - "UpdateAutoScalingGroupType$ServiceLinkedRoleARN": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

" + "UpdateAutoScalingGroupType$ServiceLinkedRoleARN": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.

" } }, "ScalingActivityInProgressFault": { @@ -1323,7 +1323,7 @@ } }, "ScheduledUpdateGroupActionRequest": { - "base": "

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

", + "base": "

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

", "refs": { "ScheduledUpdateGroupActionRequests$member": null } @@ -1343,7 +1343,7 @@ "SecurityGroups": { "base": null, "refs": { - "CreateLaunchConfigurationType$SecurityGroups": "

One or more security groups with which to associate the instances.

If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.

If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

", + "CreateLaunchConfigurationType$SecurityGroups": "

One or more security groups with which to associate the instances.

If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.

If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

", "LaunchConfiguration$SecurityGroups": "

The security groups to associate with the instances.

" } }, @@ -1389,18 +1389,18 @@ "SpotInstancePools": { "base": null, "refs": { - "InstancesDistribution$SpotInstancePools": "

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

" + "InstancesDistribution$SpotInstancePools": "

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

" } }, "SpotPrice": { "base": null, "refs": { - "CreateLaunchConfigurationType$SpotPrice": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", + "CreateLaunchConfigurationType$SpotPrice": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

", "LaunchConfiguration$SpotPrice": "

The price to bid when launching Spot Instances.

" } }, "StepAdjustment": { - "base": "

Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

There are a few rules for the step adjustments for your step policy:

", + "base": "

Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. Used in combination with PutScalingPolicy.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

There are a few rules for the step adjustments for your step policy:

", "refs": { "StepAdjustments$member": null } @@ -1408,7 +1408,7 @@ "StepAdjustments": { "base": null, "refs": { - "PutScalingPolicyType$StepAdjustments": "

A set of adjustments that enable you to scale based on the size of the alarm breach.

This parameter is required if the policy type is StepScaling and not supported otherwise.

", + "PutScalingPolicyType$StepAdjustments": "

A set of adjustments that enable you to scale based on the size of the alarm breach.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

", "ScalingPolicy$StepAdjustments": "

A set of adjustments that enable you to scale based on the size of the alarm breach.

" } }, @@ -1460,7 +1460,7 @@ "Tags": { "base": null, "refs": { - "CreateAutoScalingGroupType$Tags": "

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroupType$Tags": "

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

", "CreateOrUpdateTagsType$Tags": "

One or more tags.

", "DeleteTagsType$Tags": "

One or more tags.

" } @@ -1480,10 +1480,10 @@ } }, "TargetTrackingConfiguration": { - "base": "

Represents a target tracking policy configuration to use with Amazon EC2 Auto Scaling.

", + "base": "

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

", "refs": { - "PutScalingPolicyType$TargetTrackingConfiguration": "

A target tracking policy.

This parameter is required if the policy type is TargetTrackingScaling and not supported otherwise.

", - "ScalingPolicy$TargetTrackingConfiguration": "

A target tracking policy.

" + "PutScalingPolicyType$TargetTrackingConfiguration": "

A target tracking scaling policy. Includes support for predefined or customized metrics.

Conditional: This parameter is required if the policy type is TargetTrackingScaling and not supported otherwise.

", + "ScalingPolicy$TargetTrackingConfiguration": "

A target tracking scaling policy.

" } }, "TerminateInstanceInAutoScalingGroupType": { @@ -1495,9 +1495,9 @@ "base": null, "refs": { "AutoScalingGroup$TerminationPolicies": "

The termination policies for the group.

", - "CreateAutoScalingGroupType$TerminationPolicies": "

One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroupType$TerminationPolicies": "

One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

", "DescribeTerminationPolicyTypesAnswer$TerminationPolicyTypes": "

The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy. Currently, the OldestLaunchTemplate and AllocationStrategy policies are only supported for Auto Scaling groups with MixedInstancesPolicy.

", - "UpdateAutoScalingGroupType$TerminationPolicies": "

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

" + "UpdateAutoScalingGroupType$TerminationPolicies": "

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

" } }, "TimestampType": { @@ -1510,12 +1510,12 @@ "DescribeScheduledActionsType$EndTime": "

The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

", "LaunchConfiguration$CreatedTime": "

The creation date and time for the launch configuration.

", "PutScheduledUpdateGroupActionType$Time": "

This parameter is deprecated.

", - "PutScheduledUpdateGroupActionType$StartTime": "

The time for this action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, 2014-06-01T00:00:00Z).

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

", + "PutScheduledUpdateGroupActionType$StartTime": "

The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, \"2019-06-01T00:00:00Z\").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

", "PutScheduledUpdateGroupActionType$EndTime": "

The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

", "ScheduledUpdateGroupAction$Time": "

This parameter is deprecated.

", - "ScheduledUpdateGroupAction$StartTime": "

The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

", - "ScheduledUpdateGroupAction$EndTime": "

The date and time that the action is scheduled to end. This date and time can be up to one month in the future.

", - "ScheduledUpdateGroupActionRequest$StartTime": "

The time for the action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, 2014-06-01T00:00:00Z).

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

", + "ScheduledUpdateGroupAction$StartTime": "

The date and time that the action is scheduled to begin.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

", + "ScheduledUpdateGroupAction$EndTime": "

The date and time that the action is scheduled to end.

", + "ScheduledUpdateGroupActionRequest$StartTime": "

The time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, \"2019-06-01T00:00:00Z\").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

", "ScheduledUpdateGroupActionRequest$EndTime": "

The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

" } }, @@ -1533,20 +1533,20 @@ "XmlString": { "base": null, "refs": { - "ActivitiesType$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "ActivitiesType$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", "Activity$ActivityId": "

The ID of the activity.

", "Activity$Description": "

A friendly, more verbose description of the activity.

", "Activity$Details": "

The details about the activity.

", "ActivityIds$member": null, "AutoScalingGroupNamesType$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", - "AutoScalingGroupsType$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", - "AutoScalingInstancesType$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "AutoScalingGroupsType$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", + "AutoScalingInstancesType$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", "DescribeAutoScalingInstancesType$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", "DescribeLoadBalancerTargetGroupsRequest$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", - "DescribeLoadBalancerTargetGroupsResponse$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "DescribeLoadBalancerTargetGroupsResponse$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", "DescribeLoadBalancersRequest$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", - "DescribeLoadBalancersResponse$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", - "DescribeNotificationConfigurationsAnswer$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "DescribeLoadBalancersResponse$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", + "DescribeNotificationConfigurationsAnswer$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", "DescribeNotificationConfigurationsType$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", "DescribePoliciesType$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", "DescribeScalingActivitiesType$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", @@ -1554,18 +1554,18 @@ "DescribeTagsType$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", "FailedScheduledUpdateGroupActionRequest$ErrorMessage": "

The error message accompanying the error code.

", "Filter$Name": "

The name of the filter. The valid values are: \"auto-scaling-group\", \"key\", \"value\", and \"propagate-at-launch\".

", - "InstancesDistribution$OnDemandAllocationStrategy": "

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance types in the Overrides array of LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

", + "InstancesDistribution$OnDemandAllocationStrategy": "

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

", "InstancesDistribution$SpotAllocationStrategy": "

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

", "LaunchConfigurationNamesType$NextToken": "

The token for the next set of items to return. (You received this token from a previous call.)

", - "LaunchConfigurationsType$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", - "PoliciesType$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", - "ScheduledActionsType$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "LaunchConfigurationsType$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", + "PoliciesType$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", + "ScheduledActionsType$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", "SecurityGroups$member": null, "Tag$ResourceId": "

The name of the group.

", "Tag$ResourceType": "

The type of resource. The only supported value is auto-scaling-group.

", "TagDescription$ResourceId": "

The name of the group.

", "TagDescription$ResourceType": "

The type of resource. The only supported value is auto-scaling-group.

", - "TagsType$NextToken": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "TagsType$NextToken": "

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

", "Values$member": null } }, @@ -1573,16 +1573,16 @@ "base": null, "refs": { "Activity$Cause": "

The reason the activity began.

", - "LifecycleHook$NotificationMetadata": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

", + "LifecycleHook$NotificationMetadata": "

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

", "LifecycleHookSpecification$NotificationMetadata": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

", "PredefinedMetricSpecification$ResourceLabel": "

Identifies the resource associated with the metric type. The following predefined metrics are available:

For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.

", - "PutLifecycleHookType$NotificationMetadata": "

Contains additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

" + "PutLifecycleHookType$NotificationMetadata": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

" } }, "XmlStringMaxLen1600": { "base": null, "refs": { - "CreateLaunchConfigurationType$IamInstanceProfile": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

", + "CreateLaunchConfigurationType$IamInstanceProfile": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

", "LaunchConfiguration$IamInstanceProfile": "

The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

", "TerminationPolicies$member": null } @@ -1592,8 +1592,8 @@ "refs": { "AutoScalingInstanceDetails$InstanceId": "

The ID of the instance.

", "CompleteLifecycleActionType$InstanceId": "

The ID of the instance.

", - "CreateAutoScalingGroupType$InstanceId": "

The ID of the instance used to create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified.

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

", - "CreateLaunchConfigurationType$InstanceId": "

The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

If you do not specify InstanceId, you must specify both ImageId and InstanceType.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroupType$InstanceId": "

The ID of the instance used to create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified.

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

", + "CreateLaunchConfigurationType$InstanceId": "

The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

If you do not specify InstanceId, you must specify both ImageId and InstanceType.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

", "Instance$InstanceId": "

The ID of the instance.

", "InstanceIds$member": null, "RecordLifecycleActionHeartbeatType$InstanceId": "

The ID of the instance.

", @@ -1604,9 +1604,9 @@ "XmlStringMaxLen2047": { "base": null, "refs": { - "AutoScalingGroup$VPCZoneIdentifier": "

One or more subnet IDs, if applicable, separated by commas.

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

", - "CreateAutoScalingGroupType$VPCZoneIdentifier": "

A comma-separated list of subnet identifiers for your virtual private cloud (VPC).

If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

", - "UpdateAutoScalingGroupType$VPCZoneIdentifier": "

The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

" + "AutoScalingGroup$VPCZoneIdentifier": "

One or more subnet IDs, if applicable, separated by commas.

", + "CreateAutoScalingGroupType$VPCZoneIdentifier": "

A comma-separated list of subnet IDs for your virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.

", + "UpdateAutoScalingGroupType$VPCZoneIdentifier": "

A comma-separated list of subnet IDs, if you are launching into a VPC.

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

" } }, "XmlStringMaxLen255": { @@ -1619,7 +1619,7 @@ "AlreadyExistsFault$message": "

", "AutoScalingGroup$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "AutoScalingGroup$LaunchConfigurationName": "

The name of the associated launch configuration.

", - "AutoScalingGroup$PlacementGroup": "

The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

", + "AutoScalingGroup$PlacementGroup": "

The name of the placement group into which to launch your instances, if any.

", "AutoScalingGroup$Status": "

The current state of the group when DeleteAutoScalingGroup is in progress.

", "AutoScalingInstanceDetails$AutoScalingGroupName": "

The name of the Auto Scaling group for the instance.

", "AutoScalingInstanceDetails$AvailabilityZone": "

The Availability Zone for the instance.

", @@ -1627,18 +1627,18 @@ "AutoScalingNotificationTypes$member": null, "AvailabilityZones$member": null, "BlockDeviceMapping$VirtualName": "

The name of the virtual device (for example, ephemeral0).

", - "BlockDeviceMapping$DeviceName": "

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

", + "BlockDeviceMapping$DeviceName": "

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.

", "ClassicLinkVPCSecurityGroups$member": null, "CreateAutoScalingGroupType$AutoScalingGroupName": "

The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.

", - "CreateAutoScalingGroupType$PlacementGroup": "

The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

", + "CreateAutoScalingGroupType$PlacementGroup": "

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

", "CreateLaunchConfigurationType$LaunchConfigurationName": "

The name of the launch configuration. This name must be unique within the scope of your AWS account.

", - "CreateLaunchConfigurationType$ImageId": "

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.

If you do not specify InstanceId, you must specify ImageId.

For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.

", - "CreateLaunchConfigurationType$KeyName": "

The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

", - "CreateLaunchConfigurationType$ClassicLinkVPCId": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

", - "CreateLaunchConfigurationType$InstanceType": "

The instance type of the EC2 instance.

If you do not specify InstanceId, you must specify InstanceType.

For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

", + "CreateLaunchConfigurationType$ImageId": "

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.

If you do not specify InstanceId, you must specify ImageId.

For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.

", + "CreateLaunchConfigurationType$KeyName": "

The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

", + "CreateLaunchConfigurationType$ClassicLinkVPCId": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

", + "CreateLaunchConfigurationType$InstanceType": "

The instance type of the EC2 instance.

If you do not specify InstanceId, you must specify InstanceType.

For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

", "CreateLaunchConfigurationType$KernelId": "

The ID of the kernel associated with the AMI.

", "CreateLaunchConfigurationType$RamdiskId": "

The ID of the RAM disk associated with the AMI.

", - "Ebs$SnapshotId": "

The ID of the snapshot.

", + "Ebs$SnapshotId": "

The ID of the snapshot. This parameter is optional if you specify a volume size.

", "EnableMetricsCollectionQuery$Granularity": "

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

", "EnabledMetric$Metric": "

One of the following metrics:

", "EnabledMetric$Granularity": "

The granularity of the metric. The only valid value is 1Minute.

", @@ -1649,11 +1649,11 @@ "LaunchConfiguration$LaunchConfigurationName": "

The name of the launch configuration.

", "LaunchConfiguration$ImageId": "

The ID of the Amazon Machine Image (AMI).

", "LaunchConfiguration$KeyName": "

The name of the key pair.

", - "LaunchConfiguration$ClassicLinkVPCId": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

", + "LaunchConfiguration$ClassicLinkVPCId": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

", "LaunchConfiguration$InstanceType": "

The instance type for the instances.

", "LaunchConfiguration$KernelId": "

The ID of the kernel associated with the AMI.

", "LaunchConfiguration$RamdiskId": "

The ID of the RAM disk associated with the AMI.

", - "LaunchTemplateOverrides$InstanceType": "

The instance type.

For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

", + "LaunchTemplateOverrides$InstanceType": "

The instance type.

For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

", "LaunchTemplateSpecification$LaunchTemplateId": "

The ID of the launch template. You must specify either a template ID or a template name.

", "LaunchTemplateSpecification$Version": "

The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

", "LimitExceededFault$message": "

", @@ -1668,36 +1668,36 @@ "ProcessNames$member": null, "ProcessType$ProcessName": "

One of the following processes:

", "PutScalingPolicyType$PolicyName": "

The name of the policy.

", - "PutScalingPolicyType$AdjustmentType": "

The adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

This parameter is supported if the policy type is SimpleScaling or StepScaling.

For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "PutScalingPolicyType$AdjustmentType": "

The adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

This parameter is supported if the policy type is SimpleScaling or StepScaling.

For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

", "PutScheduledUpdateGroupActionType$ScheduledActionName": "

The name of this scaling action.

", - "PutScheduledUpdateGroupActionType$Recurrence": "

The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see Crontab.

", + "PutScheduledUpdateGroupActionType$Recurrence": "

The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information about this format, see Crontab.

", "ResourceContentionFault$message": "

", "ResourceInUseFault$message": "

", "ScalingActivityInProgressFault$message": "

", "ScalingPolicy$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "ScalingPolicy$PolicyName": "

The name of the scaling policy.

", - "ScalingPolicy$AdjustmentType": "

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

", + "ScalingPolicy$AdjustmentType": "

The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

", "ScheduledUpdateGroupAction$AutoScalingGroupName": "

The name of the Auto Scaling group.

", "ScheduledUpdateGroupAction$ScheduledActionName": "

The name of the scheduled action.

", "ScheduledUpdateGroupAction$Recurrence": "

The recurring schedule for the action.

", "ScheduledUpdateGroupActionRequest$ScheduledActionName": "

The name of the scaling action.

", - "ScheduledUpdateGroupActionRequest$Recurrence": "

The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see Crontab.

", + "ScheduledUpdateGroupActionRequest$Recurrence": "

The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information about this format, see Crontab.

", "ServiceLinkedRoleFailure$message": null, "SuspendedProcess$ProcessName": "

The name of the suspended process.

", "SuspendedProcess$SuspensionReason": "

The reason that the process was suspended.

", - "UpdateAutoScalingGroupType$PlacementGroup": "

The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

" + "UpdateAutoScalingGroupType$PlacementGroup": "

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

" } }, "XmlStringMaxLen32": { "base": null, "refs": { "AutoScalingGroup$HealthCheckType": "

The service to use for the health checks. The valid values are EC2 and ELB.

", - "AutoScalingInstanceDetails$LifecycleState": "

The lifecycle state for the instance. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

", + "AutoScalingInstanceDetails$LifecycleState": "

The lifecycle state for the instance.

", "AutoScalingInstanceDetails$HealthStatus": "

The last reported health status of this instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

", - "CreateAutoScalingGroupType$HealthCheckType": "

The service to use for the health checks. The valid values are EC2 and ELB.

By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

", + "CreateAutoScalingGroupType$HealthCheckType": "

The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

", "Instance$HealthStatus": "

The last reported health status of the instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

", "PutScalingPolicyType$MetricAggregationType": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

This parameter is supported if the policy type is StepScaling.

", - "ScalingPolicy$MetricAggregationType": "

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

", + "ScalingPolicy$MetricAggregationType": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

", "SetInstanceHealthQuery$HealthStatus": "

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

", "UpdateAutoScalingGroupType$HealthCheckType": "

The service to use for the health checks. The valid values are EC2 and ELB.

" } @@ -1712,18 +1712,18 @@ "XmlStringMaxLen64": { "base": null, "refs": { - "CreateLaunchConfigurationType$PlacementTenancy": "

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.

To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

Valid values: default | dedicated

", + "CreateLaunchConfigurationType$PlacementTenancy": "

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.

To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

Valid values: default | dedicated

", "FailedScheduledUpdateGroupActionRequest$ErrorCode": "

The error code.

", "LaunchConfiguration$PlacementTenancy": "

The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.

", "PolicyTypes$member": null, "PutScalingPolicyType$PolicyType": "

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.

", - "ScalingPolicy$PolicyType": "

The policy type. Valid values are SimpleScaling and StepScaling.

" + "ScalingPolicy$PolicyType": "

The policy type. The valid values are SimpleScaling and StepScaling.

" } }, "XmlStringUserData": { "base": null, "refs": { - "CreateLaunchConfigurationType$UserData": "

The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.

", + "CreateLaunchConfigurationType$UserData": "

The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.

", "LaunchConfiguration$UserData": "

The user data available to the instances.

" } } diff --git a/src/data/autoscaling/2011-01-01/docs-2.json.php b/src/data/autoscaling/2011-01-01/docs-2.json.php index 39030c5ac4..752ab0e55f 100644 --- a/src/data/autoscaling/2011-01-01/docs-2.json.php +++ b/src/data/autoscaling/2011-01-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.

For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.

', 'operations' => [ 'AttachInstances' => '

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'AttachLoadBalancerTargetGroups' => '

Attaches one or more target groups to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'AttachLoadBalancers' => '

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'BatchDeleteScheduledAction' => '

Deletes one or more scheduled actions for the specified Auto Scaling group.

', 'BatchPutScheduledUpdateGroupAction' => '

Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

', 'CompleteLifecycleAction' => '

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

', 'CreateAutoScalingGroup' => '

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

For more information, see Auto Scaling Groups in the Amazon EC2 Auto Scaling User Guide.

', 'CreateLaunchConfiguration' => '

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.

', 'CreateOrUpdateTags' => '

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

', 'DeleteAutoScalingGroup' => '

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.

', 'DeleteLaunchConfiguration' => '

Deletes the specified launch configuration.

The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

', 'DeleteLifecycleHook' => '

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

', 'DeleteNotificationConfiguration' => '

Deletes the specified notification.

', 'DeletePolicy' => '

Deletes the specified Auto Scaling policy.

Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

', 'DeleteScheduledAction' => '

Deletes the specified scheduled action.

', 'DeleteTags' => '

Deletes the specified tags.

', 'DescribeAccountLimits' => '

Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

', 'DescribeAdjustmentTypes' => '

Describes the policy adjustment types for use with PutScalingPolicy.

', 'DescribeAutoScalingGroups' => '

Describes one or more Auto Scaling groups.

', 'DescribeAutoScalingInstances' => '

Describes one or more Auto Scaling instances.

', 'DescribeAutoScalingNotificationTypes' => '

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

', 'DescribeLaunchConfigurations' => '

Describes one or more launch configurations.

', 'DescribeLifecycleHookTypes' => '

Describes the available types of lifecycle hooks.

The following hook types are supported:

', 'DescribeLifecycleHooks' => '

Describes the lifecycle hooks for the specified Auto Scaling group.

', 'DescribeLoadBalancerTargetGroups' => '

Describes the target groups for the specified Auto Scaling group.

', 'DescribeLoadBalancers' => '

Describes the load balancers for the specified Auto Scaling group.

This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.

', 'DescribeMetricCollectionTypes' => '

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

', 'DescribeNotificationConfigurations' => '

Describes the notification actions associated with the specified Auto Scaling group.

', 'DescribePolicies' => '

Describes the policies for the specified Auto Scaling group.

', 'DescribeScalingActivities' => '

Describes one or more scaling activities for the specified Auto Scaling group.

', 'DescribeScalingProcessTypes' => '

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

', 'DescribeScheduledActions' => '

Describes the actions scheduled for your Auto Scaling group that haven\'t run. To describe the actions that have already run, use DescribeScalingActivities.

', 'DescribeTags' => '

Describes the specified tags.

You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there\'s no match, no special message is returned.

', 'DescribeTerminationPolicyTypes' => '

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

', 'DetachInstances' => '

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'DetachLoadBalancerTargetGroups' => '

Detaches one or more target groups from the specified Auto Scaling group.

', 'DetachLoadBalancers' => '

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead.

When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.

', 'DisableMetricsCollection' => '

Disables group metrics for the specified Auto Scaling group.

', 'EnableMetricsCollection' => '

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

', 'EnterStandby' => '

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'ExecutePolicy' => '

Executes the specified policy.

', 'ExitStandby' => '

Moves the specified instances out of the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'PutLifecycleHook' => '

Creates or updates a lifecycle hook for the specified Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

', 'PutNotificationConfiguration' => '

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.

', 'PutScalingPolicy' => '

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

', 'PutScheduledUpdateGroupAction' => '

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.

', 'RecordLifecycleActionHeartbeat' => '

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

', 'ResumeProcesses' => '

Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

', 'SetDesiredCapacity' => '

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.

', 'SetInstanceHealth' => '

Sets the health status of the specified instance.

For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

', 'SetInstanceProtection' => '

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', 'SuspendProcesses' => '

Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

', 'TerminateInstanceInAutoScalingGroup' => '

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instance is not terminated immediately.

', 'UpdateAutoScalingGroup' => '

Updates the configuration for the specified Auto Scaling group.

The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren\'t affected.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

Note the following:

', ], 'shapes' => [ 'Activities' => [ 'base' => NULL, 'refs' => [ 'ActivitiesType$Activities' => '

The scaling activities. Activities are sorted by start time. Activities still in progress are described first.

', 'DetachInstancesAnswer$Activities' => '

The activities related to detaching the instances from the Auto Scaling group.

', 'EnterStandbyAnswer$Activities' => '

The activities related to moving instances into Standby mode.

', 'ExitStandbyAnswer$Activities' => '

The activities related to moving instances out of Standby mode.

', ], ], 'ActivitiesType' => [ 'base' => NULL, 'refs' => [], ], 'Activity' => [ 'base' => '

Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.

', 'refs' => [ 'Activities$member' => NULL, 'ActivityType$Activity' => '

A scaling activity.

', ], ], 'ActivityIds' => [ 'base' => NULL, 'refs' => [ 'DescribeScalingActivitiesType$ActivityIds' => '

The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

', ], ], 'ActivityType' => [ 'base' => NULL, 'refs' => [], ], 'AdjustmentType' => [ 'base' => '

Describes a policy adjustment type.

', 'refs' => [ 'AdjustmentTypes$member' => NULL, ], ], 'AdjustmentTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeAdjustmentTypesAnswer$AdjustmentTypes' => '

The policy adjustment types.

', ], ], 'Alarm' => [ 'base' => '

Describes an alarm.

', 'refs' => [ 'Alarms$member' => NULL, ], ], 'Alarms' => [ 'base' => NULL, 'refs' => [ 'PolicyARNType$Alarms' => '

The CloudWatch alarms created for the target tracking policy.

', 'ScalingPolicy$Alarms' => '

The CloudWatch alarms related to the policy.

', ], ], 'AlreadyExistsFault' => [ 'base' => '

You already have an Auto Scaling group or launch configuration with this name.

', 'refs' => [], ], 'AsciiStringMaxLen255' => [ 'base' => NULL, 'refs' => [ 'CompleteLifecycleActionType$LifecycleHookName' => '

The name of the lifecycle hook.

', 'DeleteLifecycleHookType$LifecycleHookName' => '

The name of the lifecycle hook.

', 'LifecycleHook$LifecycleHookName' => '

The name of the lifecycle hook.

', 'LifecycleHookNames$member' => NULL, 'LifecycleHookSpecification$LifecycleHookName' => '

The name of the lifecycle hook.

', 'PutLifecycleHookType$LifecycleHookName' => '

The name of the lifecycle hook.

', 'RecordLifecycleActionHeartbeatType$LifecycleHookName' => '

The name of the lifecycle hook.

', ], ], 'AssociatePublicIpAddress' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$AssociatePublicIpAddress' => '

Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.

', 'LaunchConfiguration$AssociatePublicIpAddress' => '

[EC2-VPC] Indicates whether to assign a public IP address to each instance.

', ], ], 'AttachInstancesQuery' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTargetGroupsResultType' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTargetGroupsType' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancersResultType' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancersType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingGroup' => [ 'base' => '

Describes an Auto Scaling group.

', 'refs' => [ 'AutoScalingGroups$member' => NULL, ], ], 'AutoScalingGroupDesiredCapacity' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$DesiredCapacity' => '

The desired size of the group.

', 'CreateAutoScalingGroupType$DesiredCapacity' => '

The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.

', 'PutScheduledUpdateGroupActionType$DesiredCapacity' => '

The number of EC2 instances that should be running in the group.

', 'ScheduledUpdateGroupAction$DesiredCapacity' => '

The number of instances you prefer to maintain in the group.

', 'ScheduledUpdateGroupActionRequest$DesiredCapacity' => '

The number of EC2 instances that should be running in the group.

', 'SetDesiredCapacityType$DesiredCapacity' => '

The number of EC2 instances that should be running in the Auto Scaling group.

', 'UpdateAutoScalingGroupType$DesiredCapacity' => '

The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

', ], ], 'AutoScalingGroupMaxSize' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$MaxSize' => '

The maximum size of the group.

', 'CreateAutoScalingGroupType$MaxSize' => '

The maximum size of the group.

', 'PutScheduledUpdateGroupActionType$MaxSize' => '

The maximum size for the Auto Scaling group.

', 'ScheduledUpdateGroupAction$MaxSize' => '

The maximum size of the group.

', 'ScheduledUpdateGroupActionRequest$MaxSize' => '

The maximum size of the group.

', 'UpdateAutoScalingGroupType$MaxSize' => '

The maximum size of the Auto Scaling group.

', ], ], 'AutoScalingGroupMinSize' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$MinSize' => '

The minimum size of the group.

', 'CreateAutoScalingGroupType$MinSize' => '

The minimum size of the group.

', 'PutScheduledUpdateGroupActionType$MinSize' => '

The minimum size for the Auto Scaling group.

', 'ScheduledUpdateGroupAction$MinSize' => '

The minimum size of the group.

', 'ScheduledUpdateGroupActionRequest$MinSize' => '

The minimum size of the group.

', 'UpdateAutoScalingGroupType$MinSize' => '

The minimum size of the Auto Scaling group.

', ], ], 'AutoScalingGroupNames' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupNamesType$AutoScalingGroupNames' => '

The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

', 'DescribeNotificationConfigurationsType$AutoScalingGroupNames' => '

The name of the Auto Scaling group.

', ], ], 'AutoScalingGroupNamesType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingGroups' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupsType$AutoScalingGroups' => '

The groups.

', ], ], 'AutoScalingGroupsType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingInstanceDetails' => [ 'base' => '

Describes an EC2 instance associated with an Auto Scaling group.

', 'refs' => [ 'AutoScalingInstances$member' => NULL, ], ], 'AutoScalingInstances' => [ 'base' => NULL, 'refs' => [ 'AutoScalingInstancesType$AutoScalingInstances' => '

The instances.

', ], ], 'AutoScalingInstancesType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingNotificationTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoScalingNotificationTypesAnswer$AutoScalingNotificationTypes' => '

The notification types.

', 'DescribeLifecycleHookTypesAnswer$LifecycleHookTypes' => '

The lifecycle hook types.

', 'PutNotificationConfigurationType$NotificationTypes' => '

The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.

', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$AvailabilityZones' => '

One or more Availability Zones for the group.

', 'CreateAutoScalingGroupType$AvailabilityZones' => '

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

', 'UpdateAutoScalingGroupType$AvailabilityZones' => '

One or more Availability Zones for the group.

', ], ], 'BatchDeleteScheduledActionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteScheduledActionType' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutScheduledUpdateGroupActionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutScheduledUpdateGroupActionType' => [ 'base' => NULL, 'refs' => [], ], 'BlockDeviceEbsDeleteOnTermination' => [ 'base' => NULL, 'refs' => [ 'Ebs$DeleteOnTermination' => '

Indicates whether the volume is deleted on instance termination. The default is true.

', ], ], 'BlockDeviceEbsEncrypted' => [ 'base' => NULL, 'refs' => [ 'Ebs$Encrypted' => '

Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

', ], ], 'BlockDeviceEbsIops' => [ 'base' => NULL, 'refs' => [ 'Ebs$Iops' => '

The number of I/O operations per second (IOPS) to provision for the volume.

Constraint: Required when the volume type is io1.

', ], ], 'BlockDeviceEbsVolumeSize' => [ 'base' => NULL, 'refs' => [ 'Ebs$VolumeSize' => '

The volume size, in GiB. For standard volumes, specify a value from 1 to 1,024. For io1 volumes, specify a value from 4 to 16,384. For gp2 volumes, specify a value from 1 to 16,384. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don\'t specify a volume size, the default is the snapshot size.

', ], ], 'BlockDeviceEbsVolumeType' => [ 'base' => NULL, 'refs' => [ 'Ebs$VolumeType' => '

The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2

', ], ], 'BlockDeviceMapping' => [ 'base' => '

Describes a block device mapping.

', 'refs' => [ 'BlockDeviceMappings$member' => NULL, ], ], 'BlockDeviceMappings' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$BlockDeviceMappings' => '

One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

', 'LaunchConfiguration$BlockDeviceMappings' => '

A block device mapping, which specifies the block devices for the instance.

', ], ], 'ClassicLinkVPCSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$ClassicLinkVPCSecurityGroups' => '

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

', 'LaunchConfiguration$ClassicLinkVPCSecurityGroups' => '

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'CompleteLifecycleActionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'CompleteLifecycleActionType' => [ 'base' => NULL, 'refs' => [], ], 'Cooldown' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$DefaultCooldown' => '

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

', 'CreateAutoScalingGroupType$DefaultCooldown' => '

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', 'PutScalingPolicyType$Cooldown' => '

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is supported if the policy type is SimpleScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', 'ScalingPolicy$Cooldown' => '

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

', 'UpdateAutoScalingGroupType$DefaultCooldown' => '

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'CreateAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'CreateLaunchConfigurationType' => [ 'base' => NULL, 'refs' => [], ], 'CreateOrUpdateTagsType' => [ 'base' => NULL, 'refs' => [], ], 'CustomizedMetricSpecification' => [ 'base' => '

Configures a customized metric for a target tracking policy to use with Amazon EC2 Auto Scaling.

', 'refs' => [ 'TargetTrackingConfiguration$CustomizedMetricSpecification' => '

A customized metric.

', ], ], 'DeleteAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLifecycleHookAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLifecycleHookType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotificationConfigurationType' => [ 'base' => NULL, 'refs' => [], ], 'DeletePolicyType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteScheduledActionType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountLimitsAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAdjustmentTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoScalingInstancesType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoScalingNotificationTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLifecycleHookTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLifecycleHooksAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLifecycleHooksType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancerTargetGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancerTargetGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricCollectionTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotificationConfigurationsAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotificationConfigurationsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribePoliciesType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeScalingActivitiesType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeScheduledActionsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTerminationPolicyTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesQuery' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancerTargetGroupsResultType' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancerTargetGroupsType' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancersResultType' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancersType' => [ 'base' => NULL, 'refs' => [], ], 'DisableMetricsCollectionQuery' => [ 'base' => NULL, 'refs' => [], ], 'DisableScaleIn' => [ 'base' => NULL, 'refs' => [ 'TargetTrackingConfiguration$DisableScaleIn' => '

Indicates whether scaling in by the target tracking policy is disabled. If scaling in is disabled, the target tracking policy doesn\'t remove instances from the Auto Scaling group. Otherwise, the target tracking policy can remove instances from the Auto Scaling group. The default is disabled.

', ], ], 'Ebs' => [ 'base' => '

Describes an Amazon EBS volume.

', 'refs' => [ 'BlockDeviceMapping$Ebs' => '

The information about the Amazon EBS volume.

', ], ], 'EbsOptimized' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$EbsOptimized' => '

Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

', 'LaunchConfiguration$EbsOptimized' => '

Controls whether the instance is optimized for EBS I/O (true) or not (false).

', ], ], 'EnableMetricsCollectionQuery' => [ 'base' => NULL, 'refs' => [], ], 'EnabledMetric' => [ 'base' => '

Describes an enabled metric.

', 'refs' => [ 'EnabledMetrics$member' => NULL, ], ], 'EnabledMetrics' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$EnabledMetrics' => '

The metrics enabled for the group.

', ], ], 'EnterStandbyAnswer' => [ 'base' => NULL, 'refs' => [], ], 'EnterStandbyQuery' => [ 'base' => NULL, 'refs' => [], ], 'EstimatedInstanceWarmup' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$EstimatedInstanceWarmup' => '

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

This parameter is supported if the policy type is StepScaling or TargetTrackingScaling.

', 'ScalingPolicy$EstimatedInstanceWarmup' => '

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

', ], ], 'ExecutePolicyType' => [ 'base' => NULL, 'refs' => [], ], 'ExitStandbyAnswer' => [ 'base' => NULL, 'refs' => [], ], 'ExitStandbyQuery' => [ 'base' => NULL, 'refs' => [], ], 'FailedScheduledUpdateGroupActionRequest' => [ 'base' => '

Describes a scheduled action that could not be created, updated, or deleted.

', 'refs' => [ 'FailedScheduledUpdateGroupActionRequests$member' => NULL, ], ], 'FailedScheduledUpdateGroupActionRequests' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteScheduledActionAnswer$FailedScheduledActions' => '

The names of the scheduled actions that could not be deleted, including an error message.

', 'BatchPutScheduledUpdateGroupActionAnswer$FailedScheduledUpdateGroupActions' => '

The names of the scheduled actions that could not be created or updated, including an error message.

', ], ], 'Filter' => [ 'base' => '

Describes a filter.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'DescribeTagsType$Filters' => '

One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.

', ], ], 'ForceDelete' => [ 'base' => NULL, 'refs' => [ 'DeleteAutoScalingGroupType$ForceDelete' => '

Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

', ], ], 'GlobalTimeout' => [ 'base' => NULL, 'refs' => [ 'LifecycleHook$GlobalTimeout' => '

The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

', ], ], 'HealthCheckGracePeriod' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$HealthCheckGracePeriod' => '

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.

', 'CreateAutoScalingGroupType$HealthCheckGracePeriod' => '

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.

This parameter is required if you are adding an ELB health check.

For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

', 'UpdateAutoScalingGroupType$HealthCheckGracePeriod' => '

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.

For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'HeartbeatTimeout' => [ 'base' => NULL, 'refs' => [ 'LifecycleHook$HeartbeatTimeout' => '

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

', 'LifecycleHookSpecification$HeartbeatTimeout' => '

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

', 'PutLifecycleHookType$HeartbeatTimeout' => '

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

', ], ], 'HonorCooldown' => [ 'base' => NULL, 'refs' => [ 'ExecutePolicyType$HonorCooldown' => '

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', 'SetDesiredCapacityType$HonorCooldown' => '

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

', ], ], 'Instance' => [ 'base' => '

Describes an EC2 instance.

', 'refs' => [ 'Instances$member' => NULL, ], ], 'InstanceIds' => [ 'base' => NULL, 'refs' => [ 'AttachInstancesQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'DescribeAutoScalingInstancesType$InstanceIds' => '

The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

', 'DetachInstancesQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'EnterStandbyQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'ExitStandbyQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'SetInstanceProtectionQuery$InstanceIds' => '

One or more instance IDs.

', ], ], 'InstanceMonitoring' => [ 'base' => '

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

', 'refs' => [ 'CreateLaunchConfigurationType$InstanceMonitoring' => '

Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default is true.

', 'LaunchConfiguration$InstanceMonitoring' => '

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

', ], ], 'InstanceProtected' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$NewInstancesProtectedFromScaleIn' => '

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

For more information, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', 'AutoScalingInstanceDetails$ProtectedFromScaleIn' => '

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', 'CreateAutoScalingGroupType$NewInstancesProtectedFromScaleIn' => '

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', 'Instance$ProtectedFromScaleIn' => '

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', 'UpdateAutoScalingGroupType$NewInstancesProtectedFromScaleIn' => '

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'Instances' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$Instances' => '

The EC2 instances associated with the group.

', ], ], 'InstancesDistribution' => [ 'base' => '

Describes an instances distribution for an Auto Scaling group with MixedInstancesPolicy.

The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types.

', 'refs' => [ 'MixedInstancesPolicy$InstancesDistribution' => '

The instances distribution to use.

If you leave this parameter unspecified when creating the group, the default values are used.

', ], ], 'InvalidNextToken' => [ 'base' => '

The NextToken value is not valid.

', 'refs' => [], ], 'LaunchConfiguration' => [ 'base' => '

Describes a launch configuration.

', 'refs' => [ 'LaunchConfigurations$member' => NULL, ], ], 'LaunchConfigurationNameType' => [ 'base' => NULL, 'refs' => [], ], 'LaunchConfigurationNames' => [ 'base' => NULL, 'refs' => [ 'LaunchConfigurationNamesType$LaunchConfigurationNames' => '

The launch configuration names. If you omit this parameter, all launch configurations are described.

', ], ], 'LaunchConfigurationNamesType' => [ 'base' => NULL, 'refs' => [], ], 'LaunchConfigurations' => [ 'base' => NULL, 'refs' => [ 'LaunchConfigurationsType$LaunchConfigurations' => '

The launch configurations.

', ], ], 'LaunchConfigurationsType' => [ 'base' => NULL, 'refs' => [], ], 'LaunchTemplate' => [ 'base' => '

Describes a launch template and overrides.

The overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

', 'refs' => [ 'MixedInstancesPolicy$LaunchTemplate' => '

The launch template and overrides.

This parameter is required when creating an Auto Scaling group with a mixed instances policy, but is not required when updating the group.

', ], ], 'LaunchTemplateName' => [ 'base' => NULL, 'refs' => [ 'LaunchTemplateSpecification$LaunchTemplateName' => '

The name of the launch template. You must specify either a template name or a template ID.

', ], ], 'LaunchTemplateOverrides' => [ 'base' => '

Describes an override for a launch template.

', 'refs' => [ 'Overrides$member' => NULL, ], ], 'LaunchTemplateSpecification' => [ 'base' => '

Describes a launch template and the launch template version.

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a Launch Template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

', 'refs' => [ 'AutoScalingGroup$LaunchTemplate' => '

The launch template for the group.

', 'AutoScalingInstanceDetails$LaunchTemplate' => '

The launch template for the instance.

', 'CreateAutoScalingGroupType$LaunchTemplate' => '

The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified.

', 'Instance$LaunchTemplate' => '

The launch template for the instance.

', 'LaunchTemplate$LaunchTemplateSpecification' => '

The launch template to use. You must specify either the launch template ID or launch template name in the request.

', 'UpdateAutoScalingGroupType$LaunchTemplate' => '

The launch template and version to use to specify the updates. If you specify this parameter, you can\'t specify a launch configuration or a mixed instances policy.

', ], ], 'LifecycleActionResult' => [ 'base' => NULL, 'refs' => [ 'CompleteLifecycleActionType$LifecycleActionResult' => '

The action for the group to take. This parameter can be either CONTINUE or ABANDON.

', 'LifecycleHook$DefaultResult' => '

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is CONTINUE.

', 'LifecycleHookSpecification$DefaultResult' => '

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON.

', 'PutLifecycleHookType$DefaultResult' => '

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

', ], ], 'LifecycleActionToken' => [ 'base' => NULL, 'refs' => [ 'CompleteLifecycleActionType$LifecycleActionToken' => '

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

', 'RecordLifecycleActionHeartbeatType$LifecycleActionToken' => '

A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.

', ], ], 'LifecycleHook' => [ 'base' => '

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

', 'refs' => [ 'LifecycleHooks$member' => NULL, ], ], 'LifecycleHookNames' => [ 'base' => NULL, 'refs' => [ 'DescribeLifecycleHooksType$LifecycleHookNames' => '

The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.

', ], ], 'LifecycleHookSpecification' => [ 'base' => '

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

', 'refs' => [ 'LifecycleHookSpecifications$member' => NULL, ], ], 'LifecycleHookSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateAutoScalingGroupType$LifecycleHookSpecificationList' => '

One or more lifecycle hooks.

', ], ], 'LifecycleHooks' => [ 'base' => NULL, 'refs' => [ 'DescribeLifecycleHooksAnswer$LifecycleHooks' => '

The lifecycle hooks for the specified group.

', ], ], 'LifecycleState' => [ 'base' => NULL, 'refs' => [ 'Instance$LifecycleState' => '

A description of the current lifecycle state. The Quarantined state is not used.

', ], ], 'LifecycleTransition' => [ 'base' => NULL, 'refs' => [ 'LifecycleHook$LifecycleTransition' => '

The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

', 'LifecycleHookSpecification$LifecycleTransition' => '

The state of the EC2 instance to which you want to attach the lifecycle hook. The possible values are:

', 'PutLifecycleHookType$LifecycleTransition' => '

The instance state to which you want to attach the lifecycle hook. The possible values are:

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

', ], ], 'LimitExceededFault' => [ 'base' => '

You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

', 'refs' => [], ], 'LoadBalancerNames' => [ 'base' => NULL, 'refs' => [ 'AttachLoadBalancersType$LoadBalancerNames' => '

The names of the load balancers. You can specify up to 10 load balancers.

', 'AutoScalingGroup$LoadBalancerNames' => '

One or more load balancers associated with the group.

', 'CreateAutoScalingGroupType$LoadBalancerNames' => '

One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'DetachLoadBalancersType$LoadBalancerNames' => '

The names of the load balancers. You can specify up to 10 load balancers.

', ], ], 'LoadBalancerState' => [ 'base' => '

Describes the state of a Classic Load Balancer.

If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService.

If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all instances in the group are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.

', 'refs' => [ 'LoadBalancerStates$member' => NULL, ], ], 'LoadBalancerStates' => [ 'base' => NULL, 'refs' => [ 'DescribeLoadBalancersResponse$LoadBalancers' => '

The load balancers.

', ], ], 'LoadBalancerTargetGroupState' => [ 'base' => '

Describes the state of a target group.

If you attach a target group to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.

', 'refs' => [ 'LoadBalancerTargetGroupStates$member' => NULL, ], ], 'LoadBalancerTargetGroupStates' => [ 'base' => NULL, 'refs' => [ 'DescribeLoadBalancerTargetGroupsResponse$LoadBalancerTargetGroups' => '

Information about the target groups.

', ], ], 'MaxNumberOfAutoScalingGroups' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$MaxNumberOfAutoScalingGroups' => '

The maximum number of groups allowed for your AWS account. The default limit is 200 per region.

', ], ], 'MaxNumberOfLaunchConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$MaxNumberOfLaunchConfigurations' => '

The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per region.

', ], ], 'MaxRecords' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupNamesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'DescribeAutoScalingInstancesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

', 'DescribeLoadBalancerTargetGroupsRequest$MaxRecords' => '

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

', 'DescribeLoadBalancersRequest$MaxRecords' => '

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

', 'DescribeNotificationConfigurationsType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'DescribePoliciesType$MaxRecords' => '

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

', 'DescribeScalingActivitiesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

', 'DescribeScheduledActionsType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'DescribeTagsType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'LaunchConfigurationNamesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', ], ], 'MetricCollectionType' => [ 'base' => '

Describes a metric.

', 'refs' => [ 'MetricCollectionTypes$member' => NULL, ], ], 'MetricCollectionTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeMetricCollectionTypesAnswer$Metrics' => '

One or more metrics.

', ], ], 'MetricDimension' => [ 'base' => '

Describes the dimension of a metric.

', 'refs' => [ 'MetricDimensions$member' => NULL, ], ], 'MetricDimensionName' => [ 'base' => NULL, 'refs' => [ 'MetricDimension$Name' => '

The name of the dimension.

', ], ], 'MetricDimensionValue' => [ 'base' => NULL, 'refs' => [ 'MetricDimension$Value' => '

The value of the dimension.

', ], ], 'MetricDimensions' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Dimensions' => '

The dimensions of the metric.

', ], ], 'MetricGranularityType' => [ 'base' => '

Describes a granularity of a metric.

', 'refs' => [ 'MetricGranularityTypes$member' => NULL, ], ], 'MetricGranularityTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeMetricCollectionTypesAnswer$Granularities' => '

The granularities for the metrics.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$MetricName' => '

The name of the metric.

', ], ], 'MetricNamespace' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Namespace' => '

The namespace of the metric.

', ], ], 'MetricScale' => [ 'base' => NULL, 'refs' => [ 'ExecutePolicyType$MetricValue' => '

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn\'t correspond to a step adjustment for the policy, the call returns an error.

This parameter is required if the policy type is StepScaling and not supported otherwise.

', 'ExecutePolicyType$BreachThreshold' => '

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

', 'StepAdjustment$MetricIntervalLowerBound' => '

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

', 'StepAdjustment$MetricIntervalUpperBound' => '

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

', 'TargetTrackingConfiguration$TargetValue' => '

The target value for the metric.

', ], ], 'MetricStatistic' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Statistic' => '

The statistic of the metric.

', ], ], 'MetricType' => [ 'base' => NULL, 'refs' => [ 'PredefinedMetricSpecification$PredefinedMetricType' => '

The metric type.

', ], ], 'MetricUnit' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Unit' => '

The unit of the metric.

', ], ], 'Metrics' => [ 'base' => NULL, 'refs' => [ 'DisableMetricsCollectionQuery$Metrics' => '

One or more of the following metrics. If you omit this parameter, all metrics are disabled.

', 'EnableMetricsCollectionQuery$Metrics' => '

One or more of the following metrics. If you omit this parameter, all metrics are enabled.

', ], ], 'MinAdjustmentMagnitude' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$MinAdjustmentMagnitude' => '

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

This parameter is supported if the policy type is SimpleScaling or StepScaling.

', 'ScalingPolicy$MinAdjustmentMagnitude' => '

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

', ], ], 'MinAdjustmentStep' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$MinAdjustmentStep' => '

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

', 'ScalingPolicy$MinAdjustmentStep' => '

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

', ], ], 'MixedInstanceSpotPrice' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$SpotMaxPrice' => '

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

', ], ], 'MixedInstancesPolicy' => [ 'base' => '

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

When you create your Auto Scaling group, you can specify a launch configuration or template as a parameter for the top-level object, or you can specify a mixed instances policy, but not both at the same time.

', 'refs' => [ 'AutoScalingGroup$MixedInstancesPolicy' => '

The mixed instances policy for the group.

', 'CreateAutoScalingGroupType$MixedInstancesPolicy' => '

The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.

', 'UpdateAutoScalingGroupType$MixedInstancesPolicy' => '

The mixed instances policy to use to specify the updates. If you specify this parameter, you can\'t specify a launch configuration or a launch template.

', ], ], 'MonitoringEnabled' => [ 'base' => NULL, 'refs' => [ 'InstanceMonitoring$Enabled' => '

If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

', ], ], 'NoDevice' => [ 'base' => NULL, 'refs' => [ 'BlockDeviceMapping$NoDevice' => '

Suppresses a device mapping.

If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.

', ], ], 'NotificationConfiguration' => [ 'base' => '

Describes a notification.

', 'refs' => [ 'NotificationConfigurations$member' => NULL, ], ], 'NotificationConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeNotificationConfigurationsAnswer$NotificationConfigurations' => '

The notification configurations.

', ], ], 'NotificationTargetResourceName' => [ 'base' => NULL, 'refs' => [ 'LifecycleHookSpecification$NotificationTargetARN' => '

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

', 'PutLifecycleHookType$NotificationTargetARN' => '

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

', ], ], 'NumberOfAutoScalingGroups' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$NumberOfAutoScalingGroups' => '

The current number of groups for your AWS account.

', ], ], 'NumberOfLaunchConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$NumberOfLaunchConfigurations' => '

The current number of launch configurations for your AWS account.

', ], ], 'OnDemandBaseCapacity' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$OnDemandBaseCapacity' => '

The minimum amount of the Auto Scaling group\'s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group\'s desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

', ], ], 'OnDemandPercentageAboveBaseCapacity' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$OnDemandPercentageAboveBaseCapacity' => '

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

', ], ], 'Overrides' => [ 'base' => NULL, 'refs' => [ 'LaunchTemplate$Overrides' => '

Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type.

You must specify between 2 and 20 overrides.

', ], ], 'PoliciesType' => [ 'base' => NULL, 'refs' => [], ], 'PolicyARNType' => [ 'base' => '

Contains the output of PutScalingPolicy.

', 'refs' => [], ], 'PolicyIncrement' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$ScalingAdjustment' => '

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

This parameter is required if the policy type is SimpleScaling and not supported otherwise.

', 'ScalingPolicy$ScalingAdjustment' => '

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

', 'StepAdjustment$ScalingAdjustment' => '

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

', ], ], 'PolicyNames' => [ 'base' => NULL, 'refs' => [ 'DescribePoliciesType$PolicyNames' => '

The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

', ], ], 'PolicyTypes' => [ 'base' => NULL, 'refs' => [ 'DescribePoliciesType$PolicyTypes' => '

One or more policy types. Valid values are SimpleScaling and StepScaling.

', ], ], 'PredefinedMetricSpecification' => [ 'base' => '

Configures a predefined metric for a target tracking policy.

', 'refs' => [ 'TargetTrackingConfiguration$PredefinedMetricSpecification' => '

A predefined metric. You can specify either a predefined metric or a customized metric.

', ], ], 'ProcessNames' => [ 'base' => NULL, 'refs' => [ 'ScalingProcessQuery$ScalingProcesses' => '

One or more of the following processes. If you omit this parameter, all processes are specified.

', ], ], 'ProcessType' => [ 'base' => '

Describes a process type.

For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

', 'refs' => [ 'Processes$member' => NULL, ], ], 'Processes' => [ 'base' => NULL, 'refs' => [ 'ProcessesType$Processes' => '

The names of the process types.

', ], ], 'ProcessesType' => [ 'base' => NULL, 'refs' => [], ], 'Progress' => [ 'base' => NULL, 'refs' => [ 'Activity$Progress' => '

A value between 0 and 100 that indicates the progress of the activity.

', ], ], 'PropagateAtLaunch' => [ 'base' => NULL, 'refs' => [ 'Tag$PropagateAtLaunch' => '

Determines whether the tag is added to new instances as they are launched in the group.

', 'TagDescription$PropagateAtLaunch' => '

Determines whether the tag is added to new instances as they are launched in the group.

', ], ], 'ProtectedFromScaleIn' => [ 'base' => NULL, 'refs' => [ 'SetInstanceProtectionQuery$ProtectedFromScaleIn' => '

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

', ], ], 'PutLifecycleHookAnswer' => [ 'base' => NULL, 'refs' => [], ], 'PutLifecycleHookType' => [ 'base' => NULL, 'refs' => [], ], 'PutNotificationConfigurationType' => [ 'base' => NULL, 'refs' => [], ], 'PutScalingPolicyType' => [ 'base' => NULL, 'refs' => [], ], 'PutScheduledUpdateGroupActionType' => [ 'base' => NULL, 'refs' => [], ], 'RecordLifecycleActionHeartbeatAnswer' => [ 'base' => NULL, 'refs' => [], ], 'RecordLifecycleActionHeartbeatType' => [ 'base' => NULL, 'refs' => [], ], 'ResourceContentionFault' => [ 'base' => '

You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

', 'refs' => [], ], 'ResourceInUseFault' => [ 'base' => '

The operation can\'t be performed because the resource is in use.

', 'refs' => [], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmARN' => '

The Amazon Resource Name (ARN) of the alarm.

', 'AttachInstancesQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AttachLoadBalancerTargetGroupsType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AttachLoadBalancersType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AutoScalingGroup$AutoScalingGroupARN' => '

The Amazon Resource Name (ARN) of the Auto Scaling group.

', 'AutoScalingGroup$ServiceLinkedRoleARN' => '

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

', 'AutoScalingGroupNames$member' => NULL, 'BatchDeleteScheduledActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'BatchPutScheduledUpdateGroupActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'CompleteLifecycleActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'CreateAutoScalingGroupType$LaunchConfigurationName' => '

The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified.

', 'CreateAutoScalingGroupType$ServiceLinkedRoleARN' => '

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist.

', 'DeleteAutoScalingGroupType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteLifecycleHookType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteNotificationConfigurationType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteNotificationConfigurationType$TopicARN' => '

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

', 'DeletePolicyType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeletePolicyType$PolicyName' => '

The name or Amazon Resource Name (ARN) of the policy.

', 'DeleteScheduledActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteScheduledActionType$ScheduledActionName' => '

The name of the action to delete.

', 'DescribeLifecycleHooksType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeLoadBalancerTargetGroupsRequest$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeLoadBalancersRequest$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribePoliciesType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeScalingActivitiesType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeScheduledActionsType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DetachInstancesQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DetachLoadBalancerTargetGroupsType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DetachLoadBalancersType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DisableMetricsCollectionQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'EnableMetricsCollectionQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'EnterStandbyQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ExecutePolicyType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ExecutePolicyType$PolicyName' => '

The name or ARN of the policy.

', 'ExitStandbyQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'LaunchConfiguration$LaunchConfigurationARN' => '

The Amazon Resource Name (ARN) of the launch configuration.

', 'LaunchConfigurationNameType$LaunchConfigurationName' => '

The name of the launch configuration.

', 'LaunchConfigurationNames$member' => NULL, 'LifecycleHook$AutoScalingGroupName' => '

The name of the Auto Scaling group for the lifecycle hook.

', 'LifecycleHook$NotificationTargetARN' => '

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

', 'LifecycleHook$RoleARN' => '

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

', 'LifecycleHookSpecification$RoleARN' => '

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

', 'NotificationConfiguration$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'NotificationConfiguration$TopicARN' => '

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

', 'PolicyARNType$PolicyARN' => '

The Amazon Resource Name (ARN) of the policy.

', 'PolicyNames$member' => NULL, 'PutLifecycleHookType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'PutLifecycleHookType$RoleARN' => '

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

', 'PutNotificationConfigurationType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'PutNotificationConfigurationType$TopicARN' => '

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

', 'PutScalingPolicyType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'PutScheduledUpdateGroupActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'RecordLifecycleActionHeartbeatType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScalingPolicy$PolicyARN' => '

The Amazon Resource Name (ARN) of the policy.

', 'ScalingProcessQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScheduledActionNames$member' => NULL, 'ScheduledUpdateGroupAction$ScheduledActionARN' => '

The Amazon Resource Name (ARN) of the scheduled action.

', 'SetDesiredCapacityType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'SetInstanceProtectionQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'UpdateAutoScalingGroupType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'UpdateAutoScalingGroupType$LaunchConfigurationName' => '

The name of the launch configuration. If you specify this parameter, you can\'t specify a launch template or a mixed instances policy.

', 'UpdateAutoScalingGroupType$ServiceLinkedRoleARN' => '

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

', ], ], 'ScalingActivityInProgressFault' => [ 'base' => '

The operation can\'t be performed because there are scaling activities in progress.

', 'refs' => [], ], 'ScalingActivityStatusCode' => [ 'base' => NULL, 'refs' => [ 'Activity$StatusCode' => '

The current status of the activity.

', ], ], 'ScalingPolicies' => [ 'base' => NULL, 'refs' => [ 'PoliciesType$ScalingPolicies' => '

The scaling policies.

', ], ], 'ScalingPolicy' => [ 'base' => '

Describes a scaling policy.

', 'refs' => [ 'ScalingPolicies$member' => NULL, ], ], 'ScalingProcessQuery' => [ 'base' => NULL, 'refs' => [], ], 'ScheduledActionNames' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteScheduledActionType$ScheduledActionNames' => '

The names of the scheduled actions to delete. The maximum number allowed is 50.

', 'DescribeScheduledActionsType$ScheduledActionNames' => '

The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

', ], ], 'ScheduledActionsType' => [ 'base' => NULL, 'refs' => [], ], 'ScheduledUpdateGroupAction' => [ 'base' => '

Describes a scheduled scaling action. Used in response to DescribeScheduledActions.

', 'refs' => [ 'ScheduledUpdateGroupActions$member' => NULL, ], ], 'ScheduledUpdateGroupActionRequest' => [ 'base' => '

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

', 'refs' => [ 'ScheduledUpdateGroupActionRequests$member' => NULL, ], ], 'ScheduledUpdateGroupActionRequests' => [ 'base' => NULL, 'refs' => [ 'BatchPutScheduledUpdateGroupActionType$ScheduledUpdateGroupActions' => '

One or more scheduled actions. The maximum number allowed is 50.

', ], ], 'ScheduledUpdateGroupActions' => [ 'base' => NULL, 'refs' => [ 'ScheduledActionsType$ScheduledUpdateGroupActions' => '

The scheduled actions.

', ], ], 'SecurityGroups' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$SecurityGroups' => '

One or more security groups with which to associate the instances.

If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.

If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

', 'LaunchConfiguration$SecurityGroups' => '

The security groups to associate with the instances.

', ], ], 'ServiceLinkedRoleFailure' => [ 'base' => '

The service-linked role is not yet ready for use.

', 'refs' => [], ], 'SetDesiredCapacityType' => [ 'base' => NULL, 'refs' => [], ], 'SetInstanceHealthQuery' => [ 'base' => NULL, 'refs' => [], ], 'SetInstanceProtectionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'SetInstanceProtectionQuery' => [ 'base' => NULL, 'refs' => [], ], 'ShouldDecrementDesiredCapacity' => [ 'base' => NULL, 'refs' => [ 'DetachInstancesQuery$ShouldDecrementDesiredCapacity' => '

Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

', 'EnterStandbyQuery$ShouldDecrementDesiredCapacity' => '

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

', 'TerminateInstanceInAutoScalingGroupType$ShouldDecrementDesiredCapacity' => '

Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

', ], ], 'ShouldRespectGracePeriod' => [ 'base' => NULL, 'refs' => [ 'SetInstanceHealthQuery$ShouldRespectGracePeriod' => '

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup.

', ], ], 'SpotInstancePools' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$SpotInstancePools' => '

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

', ], ], 'SpotPrice' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$SpotPrice' => '

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'LaunchConfiguration$SpotPrice' => '

The price to bid when launching Spot Instances.

', ], ], 'StepAdjustment' => [ 'base' => '

Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you\'ve defined for the alarm.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

There are a few rules for the step adjustments for your step policy:

', 'refs' => [ 'StepAdjustments$member' => NULL, ], ], 'StepAdjustments' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$StepAdjustments' => '

A set of adjustments that enable you to scale based on the size of the alarm breach.

This parameter is required if the policy type is StepScaling and not supported otherwise.

', 'ScalingPolicy$StepAdjustments' => '

A set of adjustments that enable you to scale based on the size of the alarm breach.

', ], ], 'SuspendedProcess' => [ 'base' => '

Describes an automatic scaling process that has been suspended. For more information, see ProcessType.

', 'refs' => [ 'SuspendedProcesses$member' => NULL, ], ], 'SuspendedProcesses' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$SuspendedProcesses' => '

The suspended processes associated with the group.

', ], ], 'Tag' => [ 'base' => '

Describes a tag for an Auto Scaling group.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagDescription' => [ 'base' => '

Describes a tag for an Auto Scaling group.

', 'refs' => [ 'TagDescriptionList$member' => NULL, ], ], 'TagDescriptionList' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$Tags' => '

The tags for the group.

', 'TagsType$Tags' => '

One or more tags.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag key.

', 'TagDescription$Key' => '

The tag key.

', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag value.

', 'TagDescription$Value' => '

The tag value.

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateAutoScalingGroupType$Tags' => '

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

', 'CreateOrUpdateTagsType$Tags' => '

One or more tags.

', 'DeleteTagsType$Tags' => '

One or more tags.

', ], ], 'TagsType' => [ 'base' => NULL, 'refs' => [], ], 'TargetGroupARNs' => [ 'base' => NULL, 'refs' => [ 'AttachLoadBalancerTargetGroupsType$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.

', 'AutoScalingGroup$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups for your load balancer.

', 'CreateAutoScalingGroupType$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups.

', 'DetachLoadBalancerTargetGroupsType$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.

', ], ], 'TargetTrackingConfiguration' => [ 'base' => '

Represents a target tracking policy configuration to use with Amazon EC2 Auto Scaling.

', 'refs' => [ 'PutScalingPolicyType$TargetTrackingConfiguration' => '

A target tracking policy.

This parameter is required if the policy type is TargetTrackingScaling and not supported otherwise.

', 'ScalingPolicy$TargetTrackingConfiguration' => '

A target tracking policy.

', ], ], 'TerminateInstanceInAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'TerminationPolicies' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$TerminationPolicies' => '

The termination policies for the group.

', 'CreateAutoScalingGroupType$TerminationPolicies' => '

One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

', 'DescribeTerminationPolicyTypesAnswer$TerminationPolicyTypes' => '

The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy. Currently, the OldestLaunchTemplate and AllocationStrategy policies are only supported for Auto Scaling groups with MixedInstancesPolicy.

', 'UpdateAutoScalingGroupType$TerminationPolicies' => '

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'TimestampType' => [ 'base' => NULL, 'refs' => [ 'Activity$StartTime' => '

The start time of the activity.

', 'Activity$EndTime' => '

The end time of the activity.

', 'AutoScalingGroup$CreatedTime' => '

The date and time the group was created.

', 'DescribeScheduledActionsType$StartTime' => '

The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

', 'DescribeScheduledActionsType$EndTime' => '

The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

', 'LaunchConfiguration$CreatedTime' => '

The creation date and time for the launch configuration.

', 'PutScheduledUpdateGroupActionType$Time' => '

This parameter is deprecated.

', 'PutScheduledUpdateGroupActionType$StartTime' => '

The time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only (for example, 2014-06-01T00:00:00Z).

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

', 'PutScheduledUpdateGroupActionType$EndTime' => '

The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

', 'ScheduledUpdateGroupAction$Time' => '

This parameter is deprecated.

', 'ScheduledUpdateGroupAction$StartTime' => '

The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

', 'ScheduledUpdateGroupAction$EndTime' => '

The date and time that the action is scheduled to end. This date and time can be up to one month in the future.

', 'ScheduledUpdateGroupActionRequest$StartTime' => '

The time for the action to start, in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only (for example, 2014-06-01T00:00:00Z).

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

', 'ScheduledUpdateGroupActionRequest$EndTime' => '

The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

', ], ], 'UpdateAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'Values' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

The value of the filter.

', ], ], 'XmlString' => [ 'base' => NULL, 'refs' => [ 'ActivitiesType$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'Activity$ActivityId' => '

The ID of the activity.

', 'Activity$Description' => '

A friendly, more verbose description of the activity.

', 'Activity$Details' => '

The details about the activity.

', 'ActivityIds$member' => NULL, 'AutoScalingGroupNamesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'AutoScalingGroupsType$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'AutoScalingInstancesType$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'DescribeAutoScalingInstancesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLoadBalancerTargetGroupsRequest$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLoadBalancerTargetGroupsResponse$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'DescribeLoadBalancersRequest$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLoadBalancersResponse$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'DescribeNotificationConfigurationsAnswer$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'DescribeNotificationConfigurationsType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribePoliciesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeScalingActivitiesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeScheduledActionsType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeTagsType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'FailedScheduledUpdateGroupActionRequest$ErrorMessage' => '

The error message accompanying the error code.

', 'Filter$Name' => '

The name of the filter. The valid values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".

', 'InstancesDistribution$OnDemandAllocationStrategy' => '

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance types in the Overrides array of LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

', 'InstancesDistribution$SpotAllocationStrategy' => '

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

', 'LaunchConfigurationNamesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'LaunchConfigurationsType$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'PoliciesType$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'ScheduledActionsType$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'SecurityGroups$member' => NULL, 'Tag$ResourceId' => '

The name of the group.

', 'Tag$ResourceType' => '

The type of resource. The only supported value is auto-scaling-group.

', 'TagDescription$ResourceId' => '

The name of the group.

', 'TagDescription$ResourceType' => '

The type of resource. The only supported value is auto-scaling-group.

', 'TagsType$NextToken' => '

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

', 'Values$member' => NULL, ], ], 'XmlStringMaxLen1023' => [ 'base' => NULL, 'refs' => [ 'Activity$Cause' => '

The reason the activity began.

', 'LifecycleHook$NotificationMetadata' => '

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

', 'LifecycleHookSpecification$NotificationMetadata' => '

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

', 'PredefinedMetricSpecification$ResourceLabel' => '

Identifies the resource associated with the metric type. The following predefined metrics are available:

For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.

', 'PutLifecycleHookType$NotificationMetadata' => '

Contains additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

', ], ], 'XmlStringMaxLen1600' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$IamInstanceProfile' => '

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

', 'LaunchConfiguration$IamInstanceProfile' => '

The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

', 'TerminationPolicies$member' => NULL, ], ], 'XmlStringMaxLen19' => [ 'base' => NULL, 'refs' => [ 'AutoScalingInstanceDetails$InstanceId' => '

The ID of the instance.

', 'CompleteLifecycleActionType$InstanceId' => '

The ID of the instance.

', 'CreateAutoScalingGroupType$InstanceId' => '

The ID of the instance used to create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified.

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

', 'CreateLaunchConfigurationType$InstanceId' => '

The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

If you do not specify InstanceId, you must specify both ImageId and InstanceType.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

', 'Instance$InstanceId' => '

The ID of the instance.

', 'InstanceIds$member' => NULL, 'RecordLifecycleActionHeartbeatType$InstanceId' => '

The ID of the instance.

', 'SetInstanceHealthQuery$InstanceId' => '

The ID of the instance.

', 'TerminateInstanceInAutoScalingGroupType$InstanceId' => '

The ID of the instance.

', ], ], 'XmlStringMaxLen2047' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$VPCZoneIdentifier' => '

One or more subnet IDs, if applicable, separated by commas.

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

', 'CreateAutoScalingGroupType$VPCZoneIdentifier' => '

A comma-separated list of subnet identifiers for your virtual private cloud (VPC).

If you specify subnets and Availability Zones with this call, ensure that the subnets\' Availability Zones match the Availability Zones specified.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

', 'UpdateAutoScalingGroupType$VPCZoneIdentifier' => '

The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets\' Availability Zones match the values you specify for AvailabilityZones.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'XmlStringMaxLen255' => [ 'base' => NULL, 'refs' => [ 'Activity$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'Activity$StatusMessage' => '

A friendly, more verbose description of the activity status.

', 'AdjustmentType$AdjustmentType' => '

The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

', 'Alarm$AlarmName' => '

The name of the alarm.

', 'AlreadyExistsFault$message' => '

', 'AutoScalingGroup$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AutoScalingGroup$LaunchConfigurationName' => '

The name of the associated launch configuration.

', 'AutoScalingGroup$PlacementGroup' => '

The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

', 'AutoScalingGroup$Status' => '

The current state of the group when DeleteAutoScalingGroup is in progress.

', 'AutoScalingInstanceDetails$AutoScalingGroupName' => '

The name of the Auto Scaling group for the instance.

', 'AutoScalingInstanceDetails$AvailabilityZone' => '

The Availability Zone for the instance.

', 'AutoScalingInstanceDetails$LaunchConfigurationName' => '

The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

', 'AutoScalingNotificationTypes$member' => NULL, 'AvailabilityZones$member' => NULL, 'BlockDeviceMapping$VirtualName' => '

The name of the virtual device (for example, ephemeral0).

', 'BlockDeviceMapping$DeviceName' => '

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

', 'ClassicLinkVPCSecurityGroups$member' => NULL, 'CreateAutoScalingGroupType$AutoScalingGroupName' => '

The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.

', 'CreateAutoScalingGroupType$PlacementGroup' => '

The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$LaunchConfigurationName' => '

The name of the launch configuration. This name must be unique within the scope of your AWS account.

', 'CreateLaunchConfigurationType$ImageId' => '

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.

If you do not specify InstanceId, you must specify ImageId.

For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$KeyName' => '

The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$ClassicLinkVPCId' => '

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

', 'CreateLaunchConfigurationType$InstanceType' => '

The instance type of the EC2 instance.

If you do not specify InstanceId, you must specify InstanceType.

For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$KernelId' => '

The ID of the kernel associated with the AMI.

', 'CreateLaunchConfigurationType$RamdiskId' => '

The ID of the RAM disk associated with the AMI.

', 'Ebs$SnapshotId' => '

The ID of the snapshot.

', 'EnableMetricsCollectionQuery$Granularity' => '

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

', 'EnabledMetric$Metric' => '

One of the following metrics:

', 'EnabledMetric$Granularity' => '

The granularity of the metric. The only valid value is 1Minute.

', 'FailedScheduledUpdateGroupActionRequest$ScheduledActionName' => '

The name of the scheduled action.

', 'Instance$AvailabilityZone' => '

The Availability Zone in which the instance is running.

', 'Instance$LaunchConfigurationName' => '

The launch configuration associated with the instance.

', 'InvalidNextToken$message' => '

', 'LaunchConfiguration$LaunchConfigurationName' => '

The name of the launch configuration.

', 'LaunchConfiguration$ImageId' => '

The ID of the Amazon Machine Image (AMI).

', 'LaunchConfiguration$KeyName' => '

The name of the key pair.

', 'LaunchConfiguration$ClassicLinkVPCId' => '

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

', 'LaunchConfiguration$InstanceType' => '

The instance type for the instances.

', 'LaunchConfiguration$KernelId' => '

The ID of the kernel associated with the AMI.

', 'LaunchConfiguration$RamdiskId' => '

The ID of the RAM disk associated with the AMI.

', 'LaunchTemplateOverrides$InstanceType' => '

The instance type.

For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

', 'LaunchTemplateSpecification$LaunchTemplateId' => '

The ID of the launch template. You must specify either a template ID or a template name.

', 'LaunchTemplateSpecification$Version' => '

The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

', 'LimitExceededFault$message' => '

', 'LoadBalancerNames$member' => NULL, 'LoadBalancerState$LoadBalancerName' => '

The name of the load balancer.

', 'LoadBalancerState$State' => '

One of the following load balancer states:

', 'LoadBalancerTargetGroupState$State' => '

The state of the target group.

', 'MetricCollectionType$Metric' => '

One of the following metrics:

', 'MetricGranularityType$Granularity' => '

The granularity. The only valid value is 1Minute.

', 'Metrics$member' => NULL, 'NotificationConfiguration$NotificationType' => '

One of the following event notification types:

', 'ProcessNames$member' => NULL, 'ProcessType$ProcessName' => '

One of the following processes:

', 'PutScalingPolicyType$PolicyName' => '

The name of the policy.

', 'PutScalingPolicyType$AdjustmentType' => '

The adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

This parameter is supported if the policy type is SimpleScaling or StepScaling.

For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

', 'PutScheduledUpdateGroupActionType$ScheduledActionName' => '

The name of this scaling action.

', 'PutScheduledUpdateGroupActionType$Recurrence' => '

The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see Crontab.

', 'ResourceContentionFault$message' => '

', 'ResourceInUseFault$message' => '

', 'ScalingActivityInProgressFault$message' => '

', 'ScalingPolicy$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScalingPolicy$PolicyName' => '

The name of the scaling policy.

', 'ScalingPolicy$AdjustmentType' => '

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

', 'ScheduledUpdateGroupAction$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScheduledUpdateGroupAction$ScheduledActionName' => '

The name of the scheduled action.

', 'ScheduledUpdateGroupAction$Recurrence' => '

The recurring schedule for the action.

', 'ScheduledUpdateGroupActionRequest$ScheduledActionName' => '

The name of the scaling action.

', 'ScheduledUpdateGroupActionRequest$Recurrence' => '

The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see Crontab.

', 'ServiceLinkedRoleFailure$message' => NULL, 'SuspendedProcess$ProcessName' => '

The name of the suspended process.

', 'SuspendedProcess$SuspensionReason' => '

The reason that the process was suspended.

', 'UpdateAutoScalingGroupType$PlacementGroup' => '

The name of the placement group into which to launch your instances, if any. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

', ], ], 'XmlStringMaxLen32' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$HealthCheckType' => '

The service to use for the health checks. The valid values are EC2 and ELB.

', 'AutoScalingInstanceDetails$LifecycleState' => '

The lifecycle state for the instance. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

', 'AutoScalingInstanceDetails$HealthStatus' => '

The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

', 'CreateAutoScalingGroupType$HealthCheckType' => '

The service to use for the health checks. The valid values are EC2 and ELB.

By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.

', 'Instance$HealthStatus' => '

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

', 'PutScalingPolicyType$MetricAggregationType' => '

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

This parameter is supported if the policy type is StepScaling.

', 'ScalingPolicy$MetricAggregationType' => '

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

', 'SetInstanceHealthQuery$HealthStatus' => '

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

', 'UpdateAutoScalingGroupType$HealthCheckType' => '

The service to use for the health checks. The valid values are EC2 and ELB.

', ], ], 'XmlStringMaxLen511' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTargetGroupState$LoadBalancerTargetGroupARN' => '

The Amazon Resource Name (ARN) of the target group.

', 'TargetGroupARNs$member' => NULL, ], ], 'XmlStringMaxLen64' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$PlacementTenancy' => '

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.

To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

Valid values: default | dedicated

', 'FailedScheduledUpdateGroupActionRequest$ErrorCode' => '

The error code.

', 'LaunchConfiguration$PlacementTenancy' => '

The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.

', 'PolicyTypes$member' => NULL, 'PutScalingPolicyType$PolicyType' => '

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.

', 'ScalingPolicy$PolicyType' => '

The policy type. Valid values are SimpleScaling and StepScaling.

', ], ], 'XmlStringUserData' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$UserData' => '

The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.

', 'LaunchConfiguration$UserData' => '

The user data available to the instances.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.

For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.

', 'operations' => [ 'AttachInstances' => '

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'AttachLoadBalancerTargetGroups' => '

Attaches one or more target groups to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'AttachLoadBalancers' => '

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'BatchDeleteScheduledAction' => '

Deletes one or more scheduled actions for the specified Auto Scaling group.

', 'BatchPutScheduledUpdateGroupAction' => '

Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

', 'CompleteLifecycleAction' => '

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

', 'CreateAutoScalingGroup' => '

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

', 'CreateLaunchConfiguration' => '

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.

', 'CreateOrUpdateTags' => '

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

', 'DeleteAutoScalingGroup' => '

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.

', 'DeleteLaunchConfiguration' => '

Deletes the specified launch configuration.

The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

', 'DeleteLifecycleHook' => '

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

', 'DeleteNotificationConfiguration' => '

Deletes the specified notification.

', 'DeletePolicy' => '

Deletes the specified scaling policy.

Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

', 'DeleteScheduledAction' => '

Deletes the specified scheduled action.

', 'DeleteTags' => '

Deletes the specified tags.

', 'DescribeAccountLimits' => '

Describes the current Amazon EC2 Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

', 'DescribeAdjustmentTypes' => '

Describes the policy adjustment types for use with PutScalingPolicy.

', 'DescribeAutoScalingGroups' => '

Describes one or more Auto Scaling groups.

', 'DescribeAutoScalingInstances' => '

Describes one or more Auto Scaling instances.

', 'DescribeAutoScalingNotificationTypes' => '

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

', 'DescribeLaunchConfigurations' => '

Describes one or more launch configurations.

', 'DescribeLifecycleHookTypes' => '

Describes the available types of lifecycle hooks.

The following hook types are supported:

', 'DescribeLifecycleHooks' => '

Describes the lifecycle hooks for the specified Auto Scaling group.

', 'DescribeLoadBalancerTargetGroups' => '

Describes the target groups for the specified Auto Scaling group.

', 'DescribeLoadBalancers' => '

Describes the load balancers for the specified Auto Scaling group.

This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.

', 'DescribeMetricCollectionTypes' => '

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

', 'DescribeNotificationConfigurations' => '

Describes the notification actions associated with the specified Auto Scaling group.

', 'DescribePolicies' => '

Describes the policies for the specified Auto Scaling group.

', 'DescribeScalingActivities' => '

Describes one or more scaling activities for the specified Auto Scaling group.

', 'DescribeScalingProcessTypes' => '

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

', 'DescribeScheduledActions' => '

Describes the actions scheduled for your Auto Scaling group that haven\'t run. To describe the actions that have already run, use DescribeScalingActivities.

', 'DescribeTags' => '

Describes the specified tags.

You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there\'s no match, no special message is returned.

', 'DescribeTerminationPolicyTypes' => '

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

', 'DetachInstances' => '

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'DetachLoadBalancerTargetGroups' => '

Detaches one or more target groups from the specified Auto Scaling group.

', 'DetachLoadBalancers' => '

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead.

When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.

', 'DisableMetricsCollection' => '

Disables group metrics for the specified Auto Scaling group.

', 'EnableMetricsCollection' => '

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

', 'EnterStandby' => '

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'ExecutePolicy' => '

Executes the specified policy.

', 'ExitStandby' => '

Moves the specified instances out of the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'PutLifecycleHook' => '

Creates or updates a lifecycle hook for the specified Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat.

  5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

', 'PutNotificationConfiguration' => '

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.

', 'PutScalingPolicy' => '

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

', 'PutScheduledUpdateGroupAction' => '

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.

', 'RecordLifecycleActionHeartbeat' => '

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

', 'ResumeProcesses' => '

Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

', 'SetDesiredCapacity' => '

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.

', 'SetInstanceHealth' => '

Sets the health status of the specified instance.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

', 'SetInstanceProtection' => '

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', 'SuspendProcesses' => '

Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

', 'TerminateInstanceInAutoScalingGroup' => '

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instance is not terminated immediately.

', 'UpdateAutoScalingGroup' => '

Updates the configuration for the specified Auto Scaling group.

The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren\'t affected.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

Note the following:

', ], 'shapes' => [ 'Activities' => [ 'base' => NULL, 'refs' => [ 'ActivitiesType$Activities' => '

The scaling activities. Activities are sorted by start time. Activities still in progress are described first.

', 'DetachInstancesAnswer$Activities' => '

The activities related to detaching the instances from the Auto Scaling group.

', 'EnterStandbyAnswer$Activities' => '

The activities related to moving instances into Standby mode.

', 'ExitStandbyAnswer$Activities' => '

The activities related to moving instances out of Standby mode.

', ], ], 'ActivitiesType' => [ 'base' => NULL, 'refs' => [], ], 'Activity' => [ 'base' => '

Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.

', 'refs' => [ 'Activities$member' => NULL, 'ActivityType$Activity' => '

A scaling activity.

', ], ], 'ActivityIds' => [ 'base' => NULL, 'refs' => [ 'DescribeScalingActivitiesType$ActivityIds' => '

The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

', ], ], 'ActivityType' => [ 'base' => NULL, 'refs' => [], ], 'AdjustmentType' => [ 'base' => '

Describes a policy adjustment type.

', 'refs' => [ 'AdjustmentTypes$member' => NULL, ], ], 'AdjustmentTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeAdjustmentTypesAnswer$AdjustmentTypes' => '

The policy adjustment types.

', ], ], 'Alarm' => [ 'base' => '

Describes an alarm.

', 'refs' => [ 'Alarms$member' => NULL, ], ], 'Alarms' => [ 'base' => NULL, 'refs' => [ 'PolicyARNType$Alarms' => '

The CloudWatch alarms created for the target tracking scaling policy.

', 'ScalingPolicy$Alarms' => '

The CloudWatch alarms related to the policy.

', ], ], 'AlreadyExistsFault' => [ 'base' => '

You already have an Auto Scaling group or launch configuration with this name.

', 'refs' => [], ], 'AsciiStringMaxLen255' => [ 'base' => NULL, 'refs' => [ 'CompleteLifecycleActionType$LifecycleHookName' => '

The name of the lifecycle hook.

', 'DeleteLifecycleHookType$LifecycleHookName' => '

The name of the lifecycle hook.

', 'LifecycleHook$LifecycleHookName' => '

The name of the lifecycle hook.

', 'LifecycleHookNames$member' => NULL, 'LifecycleHookSpecification$LifecycleHookName' => '

The name of the lifecycle hook.

', 'PutLifecycleHookType$LifecycleHookName' => '

The name of the lifecycle hook.

', 'RecordLifecycleActionHeartbeatType$LifecycleHookName' => '

The name of the lifecycle hook.

', ], ], 'AssociatePublicIpAddress' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$AssociatePublicIpAddress' => '

Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.

', 'LaunchConfiguration$AssociatePublicIpAddress' => '

[EC2-VPC] Indicates whether to assign a public IP address to each instance.

', ], ], 'AttachInstancesQuery' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTargetGroupsResultType' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTargetGroupsType' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancersResultType' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancersType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingGroup' => [ 'base' => '

Describes an Auto Scaling group.

', 'refs' => [ 'AutoScalingGroups$member' => NULL, ], ], 'AutoScalingGroupDesiredCapacity' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$DesiredCapacity' => '

The desired size of the group.

', 'CreateAutoScalingGroupType$DesiredCapacity' => '

The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.

', 'PutScheduledUpdateGroupActionType$DesiredCapacity' => '

The number of EC2 instances that should be running in the group.

', 'ScheduledUpdateGroupAction$DesiredCapacity' => '

The number of instances you prefer to maintain in the group.

', 'ScheduledUpdateGroupActionRequest$DesiredCapacity' => '

The number of EC2 instances that should be running in the group.

', 'SetDesiredCapacityType$DesiredCapacity' => '

The number of EC2 instances that should be running in the Auto Scaling group.

', 'UpdateAutoScalingGroupType$DesiredCapacity' => '

The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

', ], ], 'AutoScalingGroupMaxSize' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$MaxSize' => '

The maximum size of the group.

', 'CreateAutoScalingGroupType$MaxSize' => '

The maximum size of the group.

', 'PutScheduledUpdateGroupActionType$MaxSize' => '

The maximum size for the Auto Scaling group.

', 'ScheduledUpdateGroupAction$MaxSize' => '

The maximum size of the group.

', 'ScheduledUpdateGroupActionRequest$MaxSize' => '

The maximum size of the group.

', 'UpdateAutoScalingGroupType$MaxSize' => '

The maximum size of the Auto Scaling group.

', ], ], 'AutoScalingGroupMinSize' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$MinSize' => '

The minimum size of the group.

', 'CreateAutoScalingGroupType$MinSize' => '

The minimum size of the group.

', 'PutScheduledUpdateGroupActionType$MinSize' => '

The minimum size for the Auto Scaling group.

', 'ScheduledUpdateGroupAction$MinSize' => '

The minimum size of the group.

', 'ScheduledUpdateGroupActionRequest$MinSize' => '

The minimum size of the group.

', 'UpdateAutoScalingGroupType$MinSize' => '

The minimum size of the Auto Scaling group.

', ], ], 'AutoScalingGroupNames' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupNamesType$AutoScalingGroupNames' => '

The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

', 'DescribeNotificationConfigurationsType$AutoScalingGroupNames' => '

The name of the Auto Scaling group.

', ], ], 'AutoScalingGroupNamesType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingGroups' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupsType$AutoScalingGroups' => '

The groups.

', ], ], 'AutoScalingGroupsType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingInstanceDetails' => [ 'base' => '

Describes an EC2 instance associated with an Auto Scaling group.

', 'refs' => [ 'AutoScalingInstances$member' => NULL, ], ], 'AutoScalingInstances' => [ 'base' => NULL, 'refs' => [ 'AutoScalingInstancesType$AutoScalingInstances' => '

The instances.

', ], ], 'AutoScalingInstancesType' => [ 'base' => NULL, 'refs' => [], ], 'AutoScalingNotificationTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoScalingNotificationTypesAnswer$AutoScalingNotificationTypes' => '

The notification types.

', 'DescribeLifecycleHookTypesAnswer$LifecycleHookTypes' => '

The lifecycle hook types.

', 'PutNotificationConfigurationType$NotificationTypes' => '

The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.

', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$AvailabilityZones' => '

One or more Availability Zones for the group.

', 'CreateAutoScalingGroupType$AvailabilityZones' => '

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.

', 'UpdateAutoScalingGroupType$AvailabilityZones' => '

One or more Availability Zones for the group.

', ], ], 'BatchDeleteScheduledActionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteScheduledActionType' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutScheduledUpdateGroupActionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutScheduledUpdateGroupActionType' => [ 'base' => NULL, 'refs' => [], ], 'BlockDeviceEbsDeleteOnTermination' => [ 'base' => NULL, 'refs' => [ 'Ebs$DeleteOnTermination' => '

Indicates whether the volume is deleted on instance termination. The default value is true.

', ], ], 'BlockDeviceEbsEncrypted' => [ 'base' => NULL, 'refs' => [ 'Ebs$Encrypted' => '

Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

', ], ], 'BlockDeviceEbsIops' => [ 'base' => NULL, 'refs' => [ 'Ebs$Iops' => '

The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

', ], ], 'BlockDeviceEbsVolumeSize' => [ 'base' => NULL, 'refs' => [ 'Ebs$VolumeSize' => '

The volume size, in GiB.

Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don\'t specify a volume size, the default is the snapshot size.

At least one of VolumeSize or SnapshotId is required.

', ], ], 'BlockDeviceEbsVolumeType' => [ 'base' => NULL, 'refs' => [ 'Ebs$VolumeType' => '

The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1

', ], ], 'BlockDeviceMapping' => [ 'base' => '

Describes a block device mapping.

', 'refs' => [ 'BlockDeviceMappings$member' => NULL, ], ], 'BlockDeviceMappings' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$BlockDeviceMappings' => '

One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

', 'LaunchConfiguration$BlockDeviceMappings' => '

A block device mapping, which specifies the block devices for the instance.

', ], ], 'ClassicLinkVPCSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$ClassicLinkVPCSecurityGroups' => '

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise.

', 'LaunchConfiguration$ClassicLinkVPCSecurityGroups' => '

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise.

', ], ], 'CompleteLifecycleActionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'CompleteLifecycleActionType' => [ 'base' => NULL, 'refs' => [], ], 'Cooldown' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$DefaultCooldown' => '

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

', 'CreateAutoScalingGroupType$DefaultCooldown' => '

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', 'PutScalingPolicyType$Cooldown' => '

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is supported if the policy type is SimpleScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', 'ScalingPolicy$Cooldown' => '

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

', 'UpdateAutoScalingGroupType$DefaultCooldown' => '

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'CreateAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'CreateLaunchConfigurationType' => [ 'base' => NULL, 'refs' => [], ], 'CreateOrUpdateTagsType' => [ 'base' => NULL, 'refs' => [], ], 'CustomizedMetricSpecification' => [ 'base' => '

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized metric specification:

For more information about CloudWatch, see Amazon CloudWatch Concepts.

', 'refs' => [ 'TargetTrackingConfiguration$CustomizedMetricSpecification' => '

A customized metric. You can specify either a predefined metric or a customized metric.

', ], ], 'DeleteAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLifecycleHookAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLifecycleHookType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotificationConfigurationType' => [ 'base' => NULL, 'refs' => [], ], 'DeletePolicyType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteScheduledActionType' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountLimitsAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAdjustmentTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoScalingInstancesType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoScalingNotificationTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLifecycleHookTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLifecycleHooksAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLifecycleHooksType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancerTargetGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancerTargetGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoadBalancersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMetricCollectionTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotificationConfigurationsAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotificationConfigurationsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribePoliciesType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeScalingActivitiesType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeScheduledActionsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagsType' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTerminationPolicyTypesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesAnswer' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesQuery' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancerTargetGroupsResultType' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancerTargetGroupsType' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancersResultType' => [ 'base' => NULL, 'refs' => [], ], 'DetachLoadBalancersType' => [ 'base' => NULL, 'refs' => [], ], 'DisableMetricsCollectionQuery' => [ 'base' => NULL, 'refs' => [], ], 'DisableScaleIn' => [ 'base' => NULL, 'refs' => [ 'TargetTrackingConfiguration$DisableScaleIn' => '

Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn\'t remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is disabled.

', ], ], 'Ebs' => [ 'base' => '

Describes an Amazon EBS volume. Used in combination with BlockDeviceMapping.

', 'refs' => [ 'BlockDeviceMapping$Ebs' => '

The information about the Amazon EBS volume.

', ], ], 'EbsOptimized' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$EbsOptimized' => '

Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

', 'LaunchConfiguration$EbsOptimized' => '

Controls whether the instance is optimized for EBS I/O (true) or not (false).

', ], ], 'EnableMetricsCollectionQuery' => [ 'base' => NULL, 'refs' => [], ], 'EnabledMetric' => [ 'base' => '

Describes an enabled metric.

', 'refs' => [ 'EnabledMetrics$member' => NULL, ], ], 'EnabledMetrics' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$EnabledMetrics' => '

The metrics enabled for the group.

', ], ], 'EnterStandbyAnswer' => [ 'base' => NULL, 'refs' => [], ], 'EnterStandbyQuery' => [ 'base' => NULL, 'refs' => [], ], 'EstimatedInstanceWarmup' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$EstimatedInstanceWarmup' => '

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

This parameter is supported if the policy type is StepScaling or TargetTrackingScaling.

', 'ScalingPolicy$EstimatedInstanceWarmup' => '

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

', ], ], 'ExecutePolicyType' => [ 'base' => NULL, 'refs' => [], ], 'ExitStandbyAnswer' => [ 'base' => NULL, 'refs' => [], ], 'ExitStandbyQuery' => [ 'base' => NULL, 'refs' => [], ], 'FailedScheduledUpdateGroupActionRequest' => [ 'base' => '

Describes a scheduled action that could not be created, updated, or deleted.

', 'refs' => [ 'FailedScheduledUpdateGroupActionRequests$member' => NULL, ], ], 'FailedScheduledUpdateGroupActionRequests' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteScheduledActionAnswer$FailedScheduledActions' => '

The names of the scheduled actions that could not be deleted, including an error message.

', 'BatchPutScheduledUpdateGroupActionAnswer$FailedScheduledUpdateGroupActions' => '

The names of the scheduled actions that could not be created or updated, including an error message.

', ], ], 'Filter' => [ 'base' => '

Describes a filter.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'DescribeTagsType$Filters' => '

One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.

', ], ], 'ForceDelete' => [ 'base' => NULL, 'refs' => [ 'DeleteAutoScalingGroupType$ForceDelete' => '

Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

', ], ], 'GlobalTimeout' => [ 'base' => NULL, 'refs' => [ 'LifecycleHook$GlobalTimeout' => '

The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

', ], ], 'HealthCheckGracePeriod' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$HealthCheckGracePeriod' => '

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.

', 'CreateAutoScalingGroupType$HealthCheckGracePeriod' => '

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is 0.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

', 'UpdateAutoScalingGroupType$HealthCheckGracePeriod' => '

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

', ], ], 'HeartbeatTimeout' => [ 'base' => NULL, 'refs' => [ 'LifecycleHook$HeartbeatTimeout' => '

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.

', 'LifecycleHookSpecification$HeartbeatTimeout' => '

The maximum time, in seconds, that can elapse before the lifecycle hook times out.

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

', 'PutLifecycleHookType$HeartbeatTimeout' => '

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

', ], ], 'HonorCooldown' => [ 'base' => NULL, 'refs' => [ 'ExecutePolicyType$HonorCooldown' => '

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

', 'SetDesiredCapacityType$HonorCooldown' => '

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

', ], ], 'Instance' => [ 'base' => '

Describes an EC2 instance.

', 'refs' => [ 'Instances$member' => NULL, ], ], 'InstanceIds' => [ 'base' => NULL, 'refs' => [ 'AttachInstancesQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'DescribeAutoScalingInstancesType$InstanceIds' => '

The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

', 'DetachInstancesQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'EnterStandbyQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'ExitStandbyQuery$InstanceIds' => '

The IDs of the instances. You can specify up to 20 instances.

', 'SetInstanceProtectionQuery$InstanceIds' => '

One or more instance IDs.

', ], ], 'InstanceMonitoring' => [ 'base' => '

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

', 'refs' => [ 'CreateLaunchConfigurationType$InstanceMonitoring' => '

Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default value is true.

', 'LaunchConfiguration$InstanceMonitoring' => '

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

', ], ], 'InstanceProtected' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$NewInstancesProtectedFromScaleIn' => '

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

', 'AutoScalingInstanceDetails$ProtectedFromScaleIn' => '

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

', 'CreateAutoScalingGroupType$NewInstancesProtectedFromScaleIn' => '

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', 'Instance$ProtectedFromScaleIn' => '

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

', 'UpdateAutoScalingGroupType$NewInstancesProtectedFromScaleIn' => '

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'Instances' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$Instances' => '

The EC2 instances associated with the group.

', ], ], 'InstancesDistribution' => [ 'base' => '

Describes an instances distribution for an Auto Scaling group with MixedInstancesPolicy.

The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types.

', 'refs' => [ 'MixedInstancesPolicy$InstancesDistribution' => '

The instances distribution to use.

If you leave this parameter unspecified when creating the group, the default values are used.

', ], ], 'InvalidNextToken' => [ 'base' => '

The NextToken value is not valid.

', 'refs' => [], ], 'LaunchConfiguration' => [ 'base' => '

Describes a launch configuration.

', 'refs' => [ 'LaunchConfigurations$member' => NULL, ], ], 'LaunchConfigurationNameType' => [ 'base' => NULL, 'refs' => [], ], 'LaunchConfigurationNames' => [ 'base' => NULL, 'refs' => [ 'LaunchConfigurationNamesType$LaunchConfigurationNames' => '

The launch configuration names. If you omit this parameter, all launch configurations are described.

', ], ], 'LaunchConfigurationNamesType' => [ 'base' => NULL, 'refs' => [], ], 'LaunchConfigurations' => [ 'base' => NULL, 'refs' => [ 'LaunchConfigurationsType$LaunchConfigurations' => '

The launch configurations.

', ], ], 'LaunchConfigurationsType' => [ 'base' => NULL, 'refs' => [], ], 'LaunchTemplate' => [ 'base' => '

Describes a launch template and overrides.

The overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

', 'refs' => [ 'MixedInstancesPolicy$LaunchTemplate' => '

The launch template and overrides.

This parameter is required when creating an Auto Scaling group with a mixed instances policy, but is not required when updating the group.

', ], ], 'LaunchTemplateName' => [ 'base' => NULL, 'refs' => [ 'LaunchTemplateSpecification$LaunchTemplateName' => '

The name of the launch template. You must specify either a template name or a template ID.

', ], ], 'LaunchTemplateOverrides' => [ 'base' => '

Describes an override for a launch template.

', 'refs' => [ 'Overrides$member' => NULL, ], ], 'LaunchTemplateSpecification' => [ 'base' => '

Describes a launch template and the launch template version.

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'refs' => [ 'AutoScalingGroup$LaunchTemplate' => '

The launch template for the group.

', 'AutoScalingInstanceDetails$LaunchTemplate' => '

The launch template for the instance.

', 'CreateAutoScalingGroupType$LaunchTemplate' => '

The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified.

For more information, see Creating an Auto Scaling Group Using a Launch Template in the Amazon EC2 Auto Scaling User Guide.

', 'Instance$LaunchTemplate' => '

The launch template for the instance.

', 'LaunchTemplate$LaunchTemplateSpecification' => '

The launch template to use. You must specify either the launch template ID or launch template name in the request.

', 'UpdateAutoScalingGroupType$LaunchTemplate' => '

The launch template and version to use to specify the updates. If you specify this parameter, you can\'t specify a launch configuration or a mixed instances policy.

', ], ], 'LifecycleActionResult' => [ 'base' => NULL, 'refs' => [ 'CompleteLifecycleActionType$LifecycleActionResult' => '

The action for the group to take. This parameter can be either CONTINUE or ABANDON.

', 'LifecycleHook$DefaultResult' => '

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.

', 'LifecycleHookSpecification$DefaultResult' => '

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is ABANDON.

', 'PutLifecycleHookType$DefaultResult' => '

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

', ], ], 'LifecycleActionToken' => [ 'base' => NULL, 'refs' => [ 'CompleteLifecycleActionType$LifecycleActionToken' => '

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

', 'RecordLifecycleActionHeartbeatType$LifecycleActionToken' => '

A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.

', ], ], 'LifecycleHook' => [ 'base' => '

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances. Used in response to DescribeLifecycleHooks.

', 'refs' => [ 'LifecycleHooks$member' => NULL, ], ], 'LifecycleHookNames' => [ 'base' => NULL, 'refs' => [ 'DescribeLifecycleHooksType$LifecycleHookNames' => '

The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.

', ], ], 'LifecycleHookSpecification' => [ 'base' => '

Describes a lifecycle hook. Used in combination with CreateAutoScalingGroup.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat.

  5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. You can modify an existing lifecycle hook or create new lifecycle hooks using PutLifecycleHook. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

', 'refs' => [ 'LifecycleHookSpecifications$member' => NULL, ], ], 'LifecycleHookSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateAutoScalingGroupType$LifecycleHookSpecificationList' => '

One or more lifecycle hooks.

', ], ], 'LifecycleHooks' => [ 'base' => NULL, 'refs' => [ 'DescribeLifecycleHooksAnswer$LifecycleHooks' => '

The lifecycle hooks for the specified group.

', ], ], 'LifecycleState' => [ 'base' => NULL, 'refs' => [ 'Instance$LifecycleState' => '

A description of the current lifecycle state. The Quarantined state is not used.

', ], ], 'LifecycleTransition' => [ 'base' => NULL, 'refs' => [ 'LifecycleHook$LifecycleTransition' => '

The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

', 'LifecycleHookSpecification$LifecycleTransition' => '

The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:

', 'PutLifecycleHookType$LifecycleTransition' => '

The instance state to which you want to attach the lifecycle hook. The valid values are:

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

', ], ], 'LimitExceededFault' => [ 'base' => '

You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

', 'refs' => [], ], 'LoadBalancerNames' => [ 'base' => NULL, 'refs' => [ 'AttachLoadBalancersType$LoadBalancerNames' => '

The names of the load balancers. You can specify up to 10 load balancers.

', 'AutoScalingGroup$LoadBalancerNames' => '

One or more load balancers associated with the group.

', 'CreateAutoScalingGroupType$LoadBalancerNames' => '

One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'DetachLoadBalancersType$LoadBalancerNames' => '

The names of the load balancers. You can specify up to 10 load balancers.

', ], ], 'LoadBalancerState' => [ 'base' => '

Describes the state of a Classic Load Balancer.

If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService.

If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all instances in the group are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.

', 'refs' => [ 'LoadBalancerStates$member' => NULL, ], ], 'LoadBalancerStates' => [ 'base' => NULL, 'refs' => [ 'DescribeLoadBalancersResponse$LoadBalancers' => '

The load balancers.

', ], ], 'LoadBalancerTargetGroupState' => [ 'base' => '

Describes the state of a target group.

If you attach a target group to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.

', 'refs' => [ 'LoadBalancerTargetGroupStates$member' => NULL, ], ], 'LoadBalancerTargetGroupStates' => [ 'base' => NULL, 'refs' => [ 'DescribeLoadBalancerTargetGroupsResponse$LoadBalancerTargetGroups' => '

Information about the target groups.

', ], ], 'MaxNumberOfAutoScalingGroups' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$MaxNumberOfAutoScalingGroups' => '

The maximum number of groups allowed for your AWS account. The default limit is 200 per region.

', ], ], 'MaxNumberOfLaunchConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$MaxNumberOfLaunchConfigurations' => '

The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per region.

', ], ], 'MaxRecords' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupNamesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'DescribeAutoScalingInstancesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

', 'DescribeLoadBalancerTargetGroupsRequest$MaxRecords' => '

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

', 'DescribeLoadBalancersRequest$MaxRecords' => '

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

', 'DescribeNotificationConfigurationsType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'DescribePoliciesType$MaxRecords' => '

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

', 'DescribeScalingActivitiesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

', 'DescribeScheduledActionsType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'DescribeTagsType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', 'LaunchConfigurationNamesType$MaxRecords' => '

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

', ], ], 'MetricCollectionType' => [ 'base' => '

Describes a metric.

', 'refs' => [ 'MetricCollectionTypes$member' => NULL, ], ], 'MetricCollectionTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeMetricCollectionTypesAnswer$Metrics' => '

One or more metrics.

', ], ], 'MetricDimension' => [ 'base' => '

Describes the dimension of a metric.

', 'refs' => [ 'MetricDimensions$member' => NULL, ], ], 'MetricDimensionName' => [ 'base' => NULL, 'refs' => [ 'MetricDimension$Name' => '

The name of the dimension.

', ], ], 'MetricDimensionValue' => [ 'base' => NULL, 'refs' => [ 'MetricDimension$Value' => '

The value of the dimension.

', ], ], 'MetricDimensions' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Dimensions' => '

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

', ], ], 'MetricGranularityType' => [ 'base' => '

Describes a granularity of a metric.

', 'refs' => [ 'MetricGranularityTypes$member' => NULL, ], ], 'MetricGranularityTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeMetricCollectionTypesAnswer$Granularities' => '

The granularities for the metrics.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$MetricName' => '

The name of the metric.

', ], ], 'MetricNamespace' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Namespace' => '

The namespace of the metric.

', ], ], 'MetricScale' => [ 'base' => NULL, 'refs' => [ 'ExecutePolicyType$MetricValue' => '

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn\'t correspond to a step adjustment for the policy, the call returns an error.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

', 'ExecutePolicyType$BreachThreshold' => '

The breach threshold for the alarm.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

', 'StepAdjustment$MetricIntervalLowerBound' => '

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

', 'StepAdjustment$MetricIntervalUpperBound' => '

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

', 'TargetTrackingConfiguration$TargetValue' => '

The target value for the metric.

', ], ], 'MetricStatistic' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Statistic' => '

The statistic of the metric.

', ], ], 'MetricType' => [ 'base' => NULL, 'refs' => [ 'PredefinedMetricSpecification$PredefinedMetricType' => '

The metric type.

', ], ], 'MetricUnit' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Unit' => '

The unit of the metric.

', ], ], 'Metrics' => [ 'base' => NULL, 'refs' => [ 'DisableMetricsCollectionQuery$Metrics' => '

One or more of the following metrics. If you omit this parameter, all metrics are disabled.

', 'EnableMetricsCollectionQuery$Metrics' => '

One or more of the following metrics. If you omit this parameter, all metrics are enabled.

', ], ], 'MinAdjustmentMagnitude' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$MinAdjustmentMagnitude' => '

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

This parameter is supported if the policy type is SimpleScaling or StepScaling.

', 'ScalingPolicy$MinAdjustmentMagnitude' => '

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

', ], ], 'MinAdjustmentStep' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$MinAdjustmentStep' => '

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

', 'ScalingPolicy$MinAdjustmentStep' => '

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

', ], ], 'MixedInstanceSpotPrice' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$SpotMaxPrice' => '

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

', ], ], 'MixedInstancesPolicy' => [ 'base' => '

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. Used in combination with CreateAutoScalingGroup. For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

When you create your Auto Scaling group, you can specify a launch configuration or template as a parameter for the top-level object, or you can specify a mixed instances policy, but not both at the same time.

', 'refs' => [ 'AutoScalingGroup$MixedInstancesPolicy' => '

The mixed instances policy for the group.

', 'CreateAutoScalingGroupType$MixedInstancesPolicy' => '

The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.

For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

', 'UpdateAutoScalingGroupType$MixedInstancesPolicy' => '

The mixed instances policy to use to specify the updates. If you specify this parameter, you can\'t specify a launch configuration or a launch template.

For more information, see Using Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'MonitoringEnabled' => [ 'base' => NULL, 'refs' => [ 'InstanceMonitoring$Enabled' => '

If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

', ], ], 'NoDevice' => [ 'base' => NULL, 'refs' => [ 'BlockDeviceMapping$NoDevice' => '

Suppresses a device mapping.

If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.

', ], ], 'NotificationConfiguration' => [ 'base' => '

Describes a notification.

', 'refs' => [ 'NotificationConfigurations$member' => NULL, ], ], 'NotificationConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeNotificationConfigurationsAnswer$NotificationConfigurations' => '

The notification configurations.

', ], ], 'NotificationTargetResourceName' => [ 'base' => NULL, 'refs' => [ 'LifecycleHookSpecification$NotificationTargetARN' => '

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

', 'PutLifecycleHookType$NotificationTargetARN' => '

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

', ], ], 'NumberOfAutoScalingGroups' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$NumberOfAutoScalingGroups' => '

The current number of groups for your AWS account.

', ], ], 'NumberOfLaunchConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsAnswer$NumberOfLaunchConfigurations' => '

The current number of launch configurations for your AWS account.

', ], ], 'OnDemandBaseCapacity' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$OnDemandBaseCapacity' => '

The minimum amount of the Auto Scaling group\'s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group\'s desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

', ], ], 'OnDemandPercentageAboveBaseCapacity' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$OnDemandPercentageAboveBaseCapacity' => '

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

', ], ], 'Overrides' => [ 'base' => NULL, 'refs' => [ 'LaunchTemplate$Overrides' => '

Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type.

You must specify between 2 and 20 overrides.

', ], ], 'PoliciesType' => [ 'base' => NULL, 'refs' => [], ], 'PolicyARNType' => [ 'base' => '

Contains the output of PutScalingPolicy.

', 'refs' => [], ], 'PolicyIncrement' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$ScalingAdjustment' => '

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Conditional: This parameter is required if the policy type is SimpleScaling and not supported otherwise.

', 'ScalingPolicy$ScalingAdjustment' => '

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

', 'StepAdjustment$ScalingAdjustment' => '

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

', ], ], 'PolicyNames' => [ 'base' => NULL, 'refs' => [ 'DescribePoliciesType$PolicyNames' => '

The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

', ], ], 'PolicyTypes' => [ 'base' => NULL, 'refs' => [ 'DescribePoliciesType$PolicyTypes' => '

One or more policy types. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.

', ], ], 'PredefinedMetricSpecification' => [ 'base' => '

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

', 'refs' => [ 'TargetTrackingConfiguration$PredefinedMetricSpecification' => '

A predefined metric. You can specify either a predefined metric or a customized metric.

', ], ], 'ProcessNames' => [ 'base' => NULL, 'refs' => [ 'ScalingProcessQuery$ScalingProcesses' => '

One or more of the following processes. If you omit this parameter, all processes are specified.

', ], ], 'ProcessType' => [ 'base' => '

Describes a process type.

For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

', 'refs' => [ 'Processes$member' => NULL, ], ], 'Processes' => [ 'base' => NULL, 'refs' => [ 'ProcessesType$Processes' => '

The names of the process types.

', ], ], 'ProcessesType' => [ 'base' => NULL, 'refs' => [], ], 'Progress' => [ 'base' => NULL, 'refs' => [ 'Activity$Progress' => '

A value between 0 and 100 that indicates the progress of the activity.

', ], ], 'PropagateAtLaunch' => [ 'base' => NULL, 'refs' => [ 'Tag$PropagateAtLaunch' => '

Determines whether the tag is added to new instances as they are launched in the group.

', 'TagDescription$PropagateAtLaunch' => '

Determines whether the tag is added to new instances as they are launched in the group.

', ], ], 'ProtectedFromScaleIn' => [ 'base' => NULL, 'refs' => [ 'SetInstanceProtectionQuery$ProtectedFromScaleIn' => '

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

', ], ], 'PutLifecycleHookAnswer' => [ 'base' => NULL, 'refs' => [], ], 'PutLifecycleHookType' => [ 'base' => NULL, 'refs' => [], ], 'PutNotificationConfigurationType' => [ 'base' => NULL, 'refs' => [], ], 'PutScalingPolicyType' => [ 'base' => NULL, 'refs' => [], ], 'PutScheduledUpdateGroupActionType' => [ 'base' => NULL, 'refs' => [], ], 'RecordLifecycleActionHeartbeatAnswer' => [ 'base' => NULL, 'refs' => [], ], 'RecordLifecycleActionHeartbeatType' => [ 'base' => NULL, 'refs' => [], ], 'ResourceContentionFault' => [ 'base' => '

You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

', 'refs' => [], ], 'ResourceInUseFault' => [ 'base' => '

The operation can\'t be performed because the resource is in use.

', 'refs' => [], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmARN' => '

The Amazon Resource Name (ARN) of the alarm.

', 'AttachInstancesQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AttachLoadBalancerTargetGroupsType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AttachLoadBalancersType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AutoScalingGroup$AutoScalingGroupARN' => '

The Amazon Resource Name (ARN) of the Auto Scaling group.

', 'AutoScalingGroup$ServiceLinkedRoleARN' => '

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

', 'AutoScalingGroupNames$member' => NULL, 'BatchDeleteScheduledActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'BatchPutScheduledUpdateGroupActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'CompleteLifecycleActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'CreateAutoScalingGroupType$LaunchConfigurationName' => '

The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified.

For more information, see Creating an Auto Scaling Group Using a Launch Configuration in the Amazon EC2 Auto Scaling User Guide.

', 'CreateAutoScalingGroupType$ServiceLinkedRoleARN' => '

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.

', 'DeleteAutoScalingGroupType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteLifecycleHookType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteNotificationConfigurationType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteNotificationConfigurationType$TopicARN' => '

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

', 'DeletePolicyType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeletePolicyType$PolicyName' => '

The name or Amazon Resource Name (ARN) of the policy.

', 'DeleteScheduledActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DeleteScheduledActionType$ScheduledActionName' => '

The name of the action to delete.

', 'DescribeLifecycleHooksType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeLoadBalancerTargetGroupsRequest$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeLoadBalancersRequest$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribePoliciesType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeScalingActivitiesType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DescribeScheduledActionsType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DetachInstancesQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DetachLoadBalancerTargetGroupsType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DetachLoadBalancersType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'DisableMetricsCollectionQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'EnableMetricsCollectionQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'EnterStandbyQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ExecutePolicyType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ExecutePolicyType$PolicyName' => '

The name or ARN of the policy.

', 'ExitStandbyQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'LaunchConfiguration$LaunchConfigurationARN' => '

The Amazon Resource Name (ARN) of the launch configuration.

', 'LaunchConfigurationNameType$LaunchConfigurationName' => '

The name of the launch configuration.

', 'LaunchConfigurationNames$member' => NULL, 'LifecycleHook$AutoScalingGroupName' => '

The name of the Auto Scaling group for the lifecycle hook.

', 'LifecycleHook$NotificationTargetARN' => '

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

', 'LifecycleHook$RoleARN' => '

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

', 'LifecycleHookSpecification$RoleARN' => '

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

', 'NotificationConfiguration$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'NotificationConfiguration$TopicARN' => '

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

', 'PolicyARNType$PolicyARN' => '

The Amazon Resource Name (ARN) of the policy.

', 'PolicyNames$member' => NULL, 'PutLifecycleHookType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'PutLifecycleHookType$RoleARN' => '

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

', 'PutNotificationConfigurationType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'PutNotificationConfigurationType$TopicARN' => '

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

', 'PutScalingPolicyType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'PutScheduledUpdateGroupActionType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'RecordLifecycleActionHeartbeatType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScalingPolicy$PolicyARN' => '

The Amazon Resource Name (ARN) of the policy.

', 'ScalingProcessQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScheduledActionNames$member' => NULL, 'ScheduledUpdateGroupAction$ScheduledActionARN' => '

The Amazon Resource Name (ARN) of the scheduled action.

', 'SetDesiredCapacityType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'SetInstanceProtectionQuery$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'UpdateAutoScalingGroupType$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'UpdateAutoScalingGroupType$LaunchConfigurationName' => '

The name of the launch configuration. If you specify this parameter, you can\'t specify a launch template or a mixed instances policy.

', 'UpdateAutoScalingGroupType$ServiceLinkedRoleARN' => '

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'ScalingActivityInProgressFault' => [ 'base' => '

The operation can\'t be performed because there are scaling activities in progress.

', 'refs' => [], ], 'ScalingActivityStatusCode' => [ 'base' => NULL, 'refs' => [ 'Activity$StatusCode' => '

The current status of the activity.

', ], ], 'ScalingPolicies' => [ 'base' => NULL, 'refs' => [ 'PoliciesType$ScalingPolicies' => '

The scaling policies.

', ], ], 'ScalingPolicy' => [ 'base' => '

Describes a scaling policy.

', 'refs' => [ 'ScalingPolicies$member' => NULL, ], ], 'ScalingProcessQuery' => [ 'base' => NULL, 'refs' => [], ], 'ScheduledActionNames' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteScheduledActionType$ScheduledActionNames' => '

The names of the scheduled actions to delete. The maximum number allowed is 50.

', 'DescribeScheduledActionsType$ScheduledActionNames' => '

The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

', ], ], 'ScheduledActionsType' => [ 'base' => NULL, 'refs' => [], ], 'ScheduledUpdateGroupAction' => [ 'base' => '

Describes a scheduled scaling action. Used in response to DescribeScheduledActions.

', 'refs' => [ 'ScheduledUpdateGroupActions$member' => NULL, ], ], 'ScheduledUpdateGroupActionRequest' => [ 'base' => '

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

', 'refs' => [ 'ScheduledUpdateGroupActionRequests$member' => NULL, ], ], 'ScheduledUpdateGroupActionRequests' => [ 'base' => NULL, 'refs' => [ 'BatchPutScheduledUpdateGroupActionType$ScheduledUpdateGroupActions' => '

One or more scheduled actions. The maximum number allowed is 50.

', ], ], 'ScheduledUpdateGroupActions' => [ 'base' => NULL, 'refs' => [ 'ScheduledActionsType$ScheduledUpdateGroupActions' => '

The scheduled actions.

', ], ], 'SecurityGroups' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$SecurityGroups' => '

One or more security groups with which to associate the instances.

If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.

If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

', 'LaunchConfiguration$SecurityGroups' => '

The security groups to associate with the instances.

', ], ], 'ServiceLinkedRoleFailure' => [ 'base' => '

The service-linked role is not yet ready for use.

', 'refs' => [], ], 'SetDesiredCapacityType' => [ 'base' => NULL, 'refs' => [], ], 'SetInstanceHealthQuery' => [ 'base' => NULL, 'refs' => [], ], 'SetInstanceProtectionAnswer' => [ 'base' => NULL, 'refs' => [], ], 'SetInstanceProtectionQuery' => [ 'base' => NULL, 'refs' => [], ], 'ShouldDecrementDesiredCapacity' => [ 'base' => NULL, 'refs' => [ 'DetachInstancesQuery$ShouldDecrementDesiredCapacity' => '

Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

', 'EnterStandbyQuery$ShouldDecrementDesiredCapacity' => '

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

', 'TerminateInstanceInAutoScalingGroupType$ShouldDecrementDesiredCapacity' => '

Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

', ], ], 'ShouldRespectGracePeriod' => [ 'base' => NULL, 'refs' => [ 'SetInstanceHealthQuery$ShouldRespectGracePeriod' => '

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup.

', ], ], 'SpotInstancePools' => [ 'base' => NULL, 'refs' => [ 'InstancesDistribution$SpotInstancePools' => '

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.

The range is 1–20 and the default is 2.

', ], ], 'SpotPrice' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$SpotPrice' => '

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

', 'LaunchConfiguration$SpotPrice' => '

The price to bid when launching Spot Instances.

', ], ], 'StepAdjustment' => [ 'base' => '

Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you\'ve defined for the alarm. Used in combination with PutScalingPolicy.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

There are a few rules for the step adjustments for your step policy:

', 'refs' => [ 'StepAdjustments$member' => NULL, ], ], 'StepAdjustments' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyType$StepAdjustments' => '

A set of adjustments that enable you to scale based on the size of the alarm breach.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

', 'ScalingPolicy$StepAdjustments' => '

A set of adjustments that enable you to scale based on the size of the alarm breach.

', ], ], 'SuspendedProcess' => [ 'base' => '

Describes an automatic scaling process that has been suspended. For more information, see ProcessType.

', 'refs' => [ 'SuspendedProcesses$member' => NULL, ], ], 'SuspendedProcesses' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$SuspendedProcesses' => '

The suspended processes associated with the group.

', ], ], 'Tag' => [ 'base' => '

Describes a tag for an Auto Scaling group.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagDescription' => [ 'base' => '

Describes a tag for an Auto Scaling group.

', 'refs' => [ 'TagDescriptionList$member' => NULL, ], ], 'TagDescriptionList' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$Tags' => '

The tags for the group.

', 'TagsType$Tags' => '

One or more tags.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag key.

', 'TagDescription$Key' => '

The tag key.

', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag value.

', 'TagDescription$Value' => '

The tag value.

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateAutoScalingGroupType$Tags' => '

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

', 'CreateOrUpdateTagsType$Tags' => '

One or more tags.

', 'DeleteTagsType$Tags' => '

One or more tags.

', ], ], 'TagsType' => [ 'base' => NULL, 'refs' => [], ], 'TargetGroupARNs' => [ 'base' => NULL, 'refs' => [ 'AttachLoadBalancerTargetGroupsType$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.

', 'AutoScalingGroup$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups for your load balancer.

', 'CreateAutoScalingGroupType$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups.

', 'DetachLoadBalancerTargetGroupsType$TargetGroupARNs' => '

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.

', ], ], 'TargetTrackingConfiguration' => [ 'base' => '

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

', 'refs' => [ 'PutScalingPolicyType$TargetTrackingConfiguration' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

Conditional: This parameter is required if the policy type is TargetTrackingScaling and not supported otherwise.

', 'ScalingPolicy$TargetTrackingConfiguration' => '

A target tracking scaling policy.

', ], ], 'TerminateInstanceInAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'TerminationPolicies' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$TerminationPolicies' => '

The termination policies for the group.

', 'CreateAutoScalingGroupType$TerminationPolicies' => '

One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

', 'DescribeTerminationPolicyTypesAnswer$TerminationPolicyTypes' => '

The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy. Currently, the OldestLaunchTemplate and AllocationStrategy policies are only supported for Auto Scaling groups with MixedInstancesPolicy.

', 'UpdateAutoScalingGroupType$TerminationPolicies' => '

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

', ], ], 'TimestampType' => [ 'base' => NULL, 'refs' => [ 'Activity$StartTime' => '

The start time of the activity.

', 'Activity$EndTime' => '

The end time of the activity.

', 'AutoScalingGroup$CreatedTime' => '

The date and time the group was created.

', 'DescribeScheduledActionsType$StartTime' => '

The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

', 'DescribeScheduledActionsType$EndTime' => '

The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

', 'LaunchConfiguration$CreatedTime' => '

The creation date and time for the launch configuration.

', 'PutScheduledUpdateGroupActionType$Time' => '

This parameter is deprecated.

', 'PutScheduledUpdateGroupActionType$StartTime' => '

The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

', 'PutScheduledUpdateGroupActionType$EndTime' => '

The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

', 'ScheduledUpdateGroupAction$Time' => '

This parameter is deprecated.

', 'ScheduledUpdateGroupAction$StartTime' => '

The date and time that the action is scheduled to begin.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

', 'ScheduledUpdateGroupAction$EndTime' => '

The date and time that the action is scheduled to end.

', 'ScheduledUpdateGroupActionRequest$StartTime' => '

The time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

', 'ScheduledUpdateGroupActionRequest$EndTime' => '

The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

', ], ], 'UpdateAutoScalingGroupType' => [ 'base' => NULL, 'refs' => [], ], 'Values' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

The value of the filter.

', ], ], 'XmlString' => [ 'base' => NULL, 'refs' => [ 'ActivitiesType$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'Activity$ActivityId' => '

The ID of the activity.

', 'Activity$Description' => '

A friendly, more verbose description of the activity.

', 'Activity$Details' => '

The details about the activity.

', 'ActivityIds$member' => NULL, 'AutoScalingGroupNamesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'AutoScalingGroupsType$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'AutoScalingInstancesType$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'DescribeAutoScalingInstancesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLoadBalancerTargetGroupsRequest$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLoadBalancerTargetGroupsResponse$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'DescribeLoadBalancersRequest$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeLoadBalancersResponse$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'DescribeNotificationConfigurationsAnswer$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'DescribeNotificationConfigurationsType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribePoliciesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeScalingActivitiesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeScheduledActionsType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'DescribeTagsType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'FailedScheduledUpdateGroupActionRequest$ErrorMessage' => '

The error message accompanying the error code.

', 'Filter$Name' => '

The name of the filter. The valid values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".

', 'InstancesDistribution$OnDemandAllocationStrategy' => '

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

', 'InstancesDistribution$SpotAllocationStrategy' => '

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

', 'LaunchConfigurationNamesType$NextToken' => '

The token for the next set of items to return. (You received this token from a previous call.)

', 'LaunchConfigurationsType$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'PoliciesType$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'ScheduledActionsType$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'SecurityGroups$member' => NULL, 'Tag$ResourceId' => '

The name of the group.

', 'Tag$ResourceType' => '

The type of resource. The only supported value is auto-scaling-group.

', 'TagDescription$ResourceId' => '

The name of the group.

', 'TagDescription$ResourceType' => '

The type of resource. The only supported value is auto-scaling-group.

', 'TagsType$NextToken' => '

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

', 'Values$member' => NULL, ], ], 'XmlStringMaxLen1023' => [ 'base' => NULL, 'refs' => [ 'Activity$Cause' => '

The reason the activity began.

', 'LifecycleHook$NotificationMetadata' => '

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

', 'LifecycleHookSpecification$NotificationMetadata' => '

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

', 'PredefinedMetricSpecification$ResourceLabel' => '

Identifies the resource associated with the metric type. The following predefined metrics are available:

For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.

', 'PutLifecycleHookType$NotificationMetadata' => '

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

', ], ], 'XmlStringMaxLen1600' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$IamInstanceProfile' => '

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

', 'LaunchConfiguration$IamInstanceProfile' => '

The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

', 'TerminationPolicies$member' => NULL, ], ], 'XmlStringMaxLen19' => [ 'base' => NULL, 'refs' => [ 'AutoScalingInstanceDetails$InstanceId' => '

The ID of the instance.

', 'CompleteLifecycleActionType$InstanceId' => '

The ID of the instance.

', 'CreateAutoScalingGroupType$InstanceId' => '

The ID of the instance used to create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified.

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

', 'CreateLaunchConfigurationType$InstanceId' => '

The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

If you do not specify InstanceId, you must specify both ImageId and InstanceType.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

', 'Instance$InstanceId' => '

The ID of the instance.

', 'InstanceIds$member' => NULL, 'RecordLifecycleActionHeartbeatType$InstanceId' => '

The ID of the instance.

', 'SetInstanceHealthQuery$InstanceId' => '

The ID of the instance.

', 'TerminateInstanceInAutoScalingGroupType$InstanceId' => '

The ID of the instance.

', ], ], 'XmlStringMaxLen2047' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$VPCZoneIdentifier' => '

One or more subnet IDs, if applicable, separated by commas.

', 'CreateAutoScalingGroupType$VPCZoneIdentifier' => '

A comma-separated list of subnet IDs for your virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.

', 'UpdateAutoScalingGroupType$VPCZoneIdentifier' => '

A comma-separated list of subnet IDs, if you are launching into a VPC.

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

', ], ], 'XmlStringMaxLen255' => [ 'base' => NULL, 'refs' => [ 'Activity$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'Activity$StatusMessage' => '

A friendly, more verbose description of the activity status.

', 'AdjustmentType$AdjustmentType' => '

The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

', 'Alarm$AlarmName' => '

The name of the alarm.

', 'AlreadyExistsFault$message' => '

', 'AutoScalingGroup$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'AutoScalingGroup$LaunchConfigurationName' => '

The name of the associated launch configuration.

', 'AutoScalingGroup$PlacementGroup' => '

The name of the placement group into which to launch your instances, if any.

', 'AutoScalingGroup$Status' => '

The current state of the group when DeleteAutoScalingGroup is in progress.

', 'AutoScalingInstanceDetails$AutoScalingGroupName' => '

The name of the Auto Scaling group for the instance.

', 'AutoScalingInstanceDetails$AvailabilityZone' => '

The Availability Zone for the instance.

', 'AutoScalingInstanceDetails$LaunchConfigurationName' => '

The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

', 'AutoScalingNotificationTypes$member' => NULL, 'AvailabilityZones$member' => NULL, 'BlockDeviceMapping$VirtualName' => '

The name of the virtual device (for example, ephemeral0).

', 'BlockDeviceMapping$DeviceName' => '

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.

', 'ClassicLinkVPCSecurityGroups$member' => NULL, 'CreateAutoScalingGroupType$AutoScalingGroupName' => '

The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.

', 'CreateAutoScalingGroupType$PlacementGroup' => '

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$LaunchConfigurationName' => '

The name of the launch configuration. This name must be unique within the scope of your AWS account.

', 'CreateLaunchConfigurationType$ImageId' => '

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.

If you do not specify InstanceId, you must specify ImageId.

For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$KeyName' => '

The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$ClassicLinkVPCId' => '

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

', 'CreateLaunchConfigurationType$InstanceType' => '

The instance type of the EC2 instance.

If you do not specify InstanceId, you must specify InstanceType.

For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

', 'CreateLaunchConfigurationType$KernelId' => '

The ID of the kernel associated with the AMI.

', 'CreateLaunchConfigurationType$RamdiskId' => '

The ID of the RAM disk associated with the AMI.

', 'Ebs$SnapshotId' => '

The ID of the snapshot. This parameter is optional if you specify a volume size.

', 'EnableMetricsCollectionQuery$Granularity' => '

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

', 'EnabledMetric$Metric' => '

One of the following metrics:

', 'EnabledMetric$Granularity' => '

The granularity of the metric. The only valid value is 1Minute.

', 'FailedScheduledUpdateGroupActionRequest$ScheduledActionName' => '

The name of the scheduled action.

', 'Instance$AvailabilityZone' => '

The Availability Zone in which the instance is running.

', 'Instance$LaunchConfigurationName' => '

The launch configuration associated with the instance.

', 'InvalidNextToken$message' => '

', 'LaunchConfiguration$LaunchConfigurationName' => '

The name of the launch configuration.

', 'LaunchConfiguration$ImageId' => '

The ID of the Amazon Machine Image (AMI).

', 'LaunchConfiguration$KeyName' => '

The name of the key pair.

', 'LaunchConfiguration$ClassicLinkVPCId' => '

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

', 'LaunchConfiguration$InstanceType' => '

The instance type for the instances.

', 'LaunchConfiguration$KernelId' => '

The ID of the kernel associated with the AMI.

', 'LaunchConfiguration$RamdiskId' => '

The ID of the RAM disk associated with the AMI.

', 'LaunchTemplateOverrides$InstanceType' => '

The instance type.

For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

', 'LaunchTemplateSpecification$LaunchTemplateId' => '

The ID of the launch template. You must specify either a template ID or a template name.

', 'LaunchTemplateSpecification$Version' => '

The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

', 'LimitExceededFault$message' => '

', 'LoadBalancerNames$member' => NULL, 'LoadBalancerState$LoadBalancerName' => '

The name of the load balancer.

', 'LoadBalancerState$State' => '

One of the following load balancer states:

', 'LoadBalancerTargetGroupState$State' => '

The state of the target group.

', 'MetricCollectionType$Metric' => '

One of the following metrics:

', 'MetricGranularityType$Granularity' => '

The granularity. The only valid value is 1Minute.

', 'Metrics$member' => NULL, 'NotificationConfiguration$NotificationType' => '

One of the following event notification types:

', 'ProcessNames$member' => NULL, 'ProcessType$ProcessName' => '

One of the following processes:

', 'PutScalingPolicyType$PolicyName' => '

The name of the policy.

', 'PutScalingPolicyType$AdjustmentType' => '

The adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

This parameter is supported if the policy type is SimpleScaling or StepScaling.

For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

', 'PutScheduledUpdateGroupActionType$ScheduledActionName' => '

The name of this scaling action.

', 'PutScheduledUpdateGroupActionType$Recurrence' => '

The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

', 'ResourceContentionFault$message' => '

', 'ResourceInUseFault$message' => '

', 'ScalingActivityInProgressFault$message' => '

', 'ScalingPolicy$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScalingPolicy$PolicyName' => '

The name of the scaling policy.

', 'ScalingPolicy$AdjustmentType' => '

The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

', 'ScheduledUpdateGroupAction$AutoScalingGroupName' => '

The name of the Auto Scaling group.

', 'ScheduledUpdateGroupAction$ScheduledActionName' => '

The name of the scheduled action.

', 'ScheduledUpdateGroupAction$Recurrence' => '

The recurring schedule for the action.

', 'ScheduledUpdateGroupActionRequest$ScheduledActionName' => '

The name of the scaling action.

', 'ScheduledUpdateGroupActionRequest$Recurrence' => '

The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

', 'ServiceLinkedRoleFailure$message' => NULL, 'SuspendedProcess$ProcessName' => '

The name of the suspended process.

', 'SuspendedProcess$SuspensionReason' => '

The reason that the process was suspended.

', 'UpdateAutoScalingGroupType$PlacementGroup' => '

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

', ], ], 'XmlStringMaxLen32' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroup$HealthCheckType' => '

The service to use for the health checks. The valid values are EC2 and ELB.

', 'AutoScalingInstanceDetails$LifecycleState' => '

The lifecycle state for the instance.

', 'AutoScalingInstanceDetails$HealthStatus' => '

The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

', 'CreateAutoScalingGroupType$HealthCheckType' => '

The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

', 'Instance$HealthStatus' => '

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

', 'PutScalingPolicyType$MetricAggregationType' => '

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

This parameter is supported if the policy type is StepScaling.

', 'ScalingPolicy$MetricAggregationType' => '

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

', 'SetInstanceHealthQuery$HealthStatus' => '

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

', 'UpdateAutoScalingGroupType$HealthCheckType' => '

The service to use for the health checks. The valid values are EC2 and ELB.

', ], ], 'XmlStringMaxLen511' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTargetGroupState$LoadBalancerTargetGroupARN' => '

The Amazon Resource Name (ARN) of the target group.

', 'TargetGroupARNs$member' => NULL, ], ], 'XmlStringMaxLen64' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$PlacementTenancy' => '

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.

To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

Valid values: default | dedicated

', 'FailedScheduledUpdateGroupActionRequest$ErrorCode' => '

The error code.

', 'LaunchConfiguration$PlacementTenancy' => '

The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.

', 'PolicyTypes$member' => NULL, 'PutScalingPolicyType$PolicyType' => '

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.

', 'ScalingPolicy$PolicyType' => '

The policy type. The valid values are SimpleScaling and StepScaling.

', ], ], 'XmlStringUserData' => [ 'base' => NULL, 'refs' => [ 'CreateLaunchConfigurationType$UserData' => '

The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.

', 'LaunchConfiguration$UserData' => '

The user data available to the instances.

', ], ], ],]; diff --git a/src/data/ecs/2014-11-13/api-2.json b/src/data/ecs/2014-11-13/api-2.json index a9decbf710..cf218c63f8 100644 --- a/src/data/ecs/2014-11-13/api-2.json +++ b/src/data/ecs/2014-11-13/api-2.json @@ -785,6 +785,15 @@ "gpuIds":{"shape":"GpuIds"} } }, + "ContainerCondition":{ + "type":"string", + "enum":[ + "START", + "COMPLETE", + "SUCCESS", + "HEALTHY" + ] + }, "ContainerDefinition":{ "type":"structure", "members":{ @@ -804,6 +813,9 @@ "volumesFrom":{"shape":"VolumeFromList"}, "linuxParameters":{"shape":"LinuxParameters"}, "secrets":{"shape":"SecretList"}, + "dependsOn":{"shape":"ContainerDependencies"}, + "startTimeout":{"shape":"BoxedInteger"}, + "stopTimeout":{"shape":"BoxedInteger"}, "hostname":{"shape":"String"}, "user":{"shape":"String"}, "workingDirectory":{"shape":"String"}, @@ -828,6 +840,21 @@ "type":"list", "member":{"shape":"ContainerDefinition"} }, + "ContainerDependencies":{ + "type":"list", + "member":{"shape":"ContainerDependency"} + }, + "ContainerDependency":{ + "type":"structure", + "required":[ + "containerName", + "condition" + ], + "members":{ + "containerName":{"shape":"String"}, + "condition":{"shape":"ContainerCondition"} + } + }, "ContainerInstance":{ "type":"structure", "members":{ @@ -1668,6 +1695,23 @@ "SERVICE" ] }, + "ProxyConfiguration":{ + "type":"structure", + "required":["containerName"], + "members":{ + "type":{"shape":"ProxyConfigurationType"}, + "containerName":{"shape":"String"}, + "properties":{"shape":"ProxyConfigurationProperties"} + } + }, + "ProxyConfigurationProperties":{ + "type":"list", + "member":{"shape":"KeyValuePair"} + }, + "ProxyConfigurationType":{ + "type":"string", + "enum":["APPMESH"] + }, "PutAccountSettingDefaultRequest":{ "type":"structure", "required":[ @@ -1756,7 +1800,8 @@ "memory":{"shape":"String"}, "tags":{"shape":"Tags"}, "pidMode":{"shape":"PidMode"}, - "ipcMode":{"shape":"IpcMode"} + "ipcMode":{"shape":"IpcMode"}, + "proxyConfiguration":{"shape":"ProxyConfiguration"} } }, "RegisterTaskDefinitionResponse":{ @@ -2220,7 +2265,8 @@ "cpu":{"shape":"String"}, "memory":{"shape":"String"}, "pidMode":{"shape":"PidMode"}, - "ipcMode":{"shape":"IpcMode"} + "ipcMode":{"shape":"IpcMode"}, + "proxyConfiguration":{"shape":"ProxyConfiguration"} } }, "TaskDefinitionFamilyStatus":{ diff --git a/src/data/ecs/2014-11-13/api-2.json.php b/src/data/ecs/2014-11-13/api-2.json.php index 79bb6fec8d..fb2f8e78b3 100644 --- a/src/data/ecs/2014-11-13/api-2.json.php +++ b/src/data/ecs/2014-11-13/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2014-11-13', 'endpointPrefix' => 'ecs', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Amazon ECS', 'serviceFullName' => 'Amazon EC2 Container Service', 'serviceId' => 'ECS', 'signatureVersion' => 'v4', 'targetPrefix' => 'AmazonEC2ContainerServiceV20141113', 'uid' => 'ecs-2014-11-13', ], 'operations' => [ 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'CreateService' => [ 'name' => 'CreateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceRequest', ], 'output' => [ 'shape' => 'CreateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAccountSetting' => [ 'name' => 'DeleteAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAccountSettingRequest', ], 'output' => [ 'shape' => 'DeleteAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteAttributes' => [ 'name' => 'DeleteAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAttributesRequest', ], 'output' => [ 'shape' => 'DeleteAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ClusterContainsContainerInstancesException', ], [ 'shape' => 'ClusterContainsServicesException', ], [ 'shape' => 'ClusterContainsTasksException', ], ], ], 'DeleteService' => [ 'name' => 'DeleteService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceRequest', ], 'output' => [ 'shape' => 'DeleteServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'DeregisterContainerInstance' => [ 'name' => 'DeregisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'DeregisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DeregisterTaskDefinition' => [ 'name' => 'DeregisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DeregisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeContainerInstances' => [ 'name' => 'DescribeContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContainerInstancesRequest', ], 'output' => [ 'shape' => 'DescribeContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeServices' => [ 'name' => 'DescribeServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServicesRequest', ], 'output' => [ 'shape' => 'DescribeServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeTaskDefinition' => [ 'name' => 'DescribeTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeTasks' => [ 'name' => 'DescribeTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTasksRequest', ], 'output' => [ 'shape' => 'DescribeTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DiscoverPollEndpoint' => [ 'name' => 'DiscoverPollEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverPollEndpointRequest', ], 'output' => [ 'shape' => 'DiscoverPollEndpointResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], ], ], 'ListAccountSettings' => [ 'name' => 'ListAccountSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAccountSettingsRequest', ], 'output' => [ 'shape' => 'ListAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListAttributes' => [ 'name' => 'ListAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAttributesRequest', ], 'output' => [ 'shape' => 'ListAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListContainerInstances' => [ 'name' => 'ListContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContainerInstancesRequest', ], 'output' => [ 'shape' => 'ListContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListServices' => [ 'name' => 'ListServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesRequest', ], 'output' => [ 'shape' => 'ListServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitionFamilies' => [ 'name' => 'ListTaskDefinitionFamilies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionFamiliesRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionFamiliesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitions' => [ 'name' => 'ListTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTasks' => [ 'name' => 'ListTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTasksRequest', ], 'output' => [ 'shape' => 'ListTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'PutAccountSetting' => [ 'name' => 'PutAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingRequest', ], 'output' => [ 'shape' => 'PutAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAccountSettingDefault' => [ 'name' => 'PutAccountSettingDefault', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingDefaultRequest', ], 'output' => [ 'shape' => 'PutAccountSettingDefaultResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAttributes' => [ 'name' => 'PutAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAttributesRequest', ], 'output' => [ 'shape' => 'PutAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'AttributeLimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RegisterContainerInstance' => [ 'name' => 'RegisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'RegisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RegisterTaskDefinition' => [ 'name' => 'RegisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'RegisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RunTask' => [ 'name' => 'RunTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunTaskRequest', ], 'output' => [ 'shape' => 'RunTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BlockedException', ], ], ], 'StartTask' => [ 'name' => 'StartTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartTaskRequest', ], 'output' => [ 'shape' => 'StartTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'StopTask' => [ 'name' => 'StopTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTaskRequest', ], 'output' => [ 'shape' => 'StopTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'SubmitContainerStateChange' => [ 'name' => 'SubmitContainerStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitContainerStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitContainerStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SubmitTaskStateChange' => [ 'name' => 'SubmitTaskStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitTaskStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitTaskStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateContainerAgent' => [ 'name' => 'UpdateContainerAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerAgentRequest', ], 'output' => [ 'shape' => 'UpdateContainerAgentResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UpdateInProgressException', ], [ 'shape' => 'NoUpdateAvailableException', ], [ 'shape' => 'MissingVersionException', ], ], ], 'UpdateContainerInstancesState' => [ 'name' => 'UpdateContainerInstancesState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerInstancesStateRequest', ], 'output' => [ 'shape' => 'UpdateContainerInstancesStateResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'UpdateService' => [ 'name' => 'UpdateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceRequest', ], 'output' => [ 'shape' => 'UpdateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'AgentUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STAGING', 'STAGED', 'UPDATING', 'UPDATED', 'FAILED', ], ], 'AssignPublicIp' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'Attachment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'details' => [ 'shape' => 'AttachmentDetails', ], ], ], 'AttachmentDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'AttachmentStateChange' => [ 'type' => 'structure', 'required' => [ 'attachmentArn', 'status', ], 'members' => [ 'attachmentArn' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'AttachmentStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentStateChange', ], ], 'Attachments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attachment', ], ], 'Attribute' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'targetId' => [ 'shape' => 'String', ], ], ], 'AttributeLimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Attributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'AwsVpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'subnets', ], 'members' => [ 'subnets' => [ 'shape' => 'StringList', ], 'securityGroups' => [ 'shape' => 'StringList', ], 'assignPublicIp' => [ 'shape' => 'AssignPublicIp', ], ], ], 'BlockedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'BoxedBoolean' => [ 'type' => 'boolean', 'box' => true, ], 'BoxedInteger' => [ 'type' => 'integer', 'box' => true, ], 'ClientException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'clusterArn' => [ 'shape' => 'String', ], 'clusterName' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'registeredContainerInstancesCount' => [ 'shape' => 'Integer', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'activeServicesCount' => [ 'shape' => 'Integer', ], 'statistics' => [ 'shape' => 'Statistics', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'ClusterContainsContainerInstancesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsServicesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsTasksException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterField' => [ 'type' => 'string', 'enum' => [ 'STATISTICS', 'TAGS', ], ], 'ClusterFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterField', ], ], 'ClusterNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], 'Compatibility' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', ], ], 'CompatibilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Compatibility', ], ], 'Connectivity' => [ 'type' => 'string', 'enum' => [ 'CONNECTED', 'DISCONNECTED', ], ], 'Container' => [ 'type' => 'structure', 'members' => [ 'containerArn' => [ 'shape' => 'String', ], 'taskArn' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'lastStatus' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'networkInterfaces' => [ 'shape' => 'NetworkInterfaces', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'memoryReservation' => [ 'shape' => 'String', ], 'gpuIds' => [ 'shape' => 'GpuIds', ], ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'repositoryCredentials' => [ 'shape' => 'RepositoryCredentials', ], 'cpu' => [ 'shape' => 'Integer', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'links' => [ 'shape' => 'StringList', ], 'portMappings' => [ 'shape' => 'PortMappingList', ], 'essential' => [ 'shape' => 'BoxedBoolean', ], 'entryPoint' => [ 'shape' => 'StringList', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'mountPoints' => [ 'shape' => 'MountPointList', ], 'volumesFrom' => [ 'shape' => 'VolumeFromList', ], 'linuxParameters' => [ 'shape' => 'LinuxParameters', ], 'secrets' => [ 'shape' => 'SecretList', ], 'hostname' => [ 'shape' => 'String', ], 'user' => [ 'shape' => 'String', ], 'workingDirectory' => [ 'shape' => 'String', ], 'disableNetworking' => [ 'shape' => 'BoxedBoolean', ], 'privileged' => [ 'shape' => 'BoxedBoolean', ], 'readonlyRootFilesystem' => [ 'shape' => 'BoxedBoolean', ], 'dnsServers' => [ 'shape' => 'StringList', ], 'dnsSearchDomains' => [ 'shape' => 'StringList', ], 'extraHosts' => [ 'shape' => 'HostEntryList', ], 'dockerSecurityOptions' => [ 'shape' => 'StringList', ], 'interactive' => [ 'shape' => 'BoxedBoolean', ], 'pseudoTerminal' => [ 'shape' => 'BoxedBoolean', ], 'dockerLabels' => [ 'shape' => 'DockerLabelsMap', ], 'ulimits' => [ 'shape' => 'UlimitList', ], 'logConfiguration' => [ 'shape' => 'LogConfiguration', ], 'healthCheck' => [ 'shape' => 'HealthCheck', ], 'systemControls' => [ 'shape' => 'SystemControls', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], ], ], 'ContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], ], 'ContainerInstance' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArn' => [ 'shape' => 'String', ], 'ec2InstanceId' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'remainingResources' => [ 'shape' => 'Resources', ], 'registeredResources' => [ 'shape' => 'Resources', ], 'status' => [ 'shape' => 'String', ], 'agentConnected' => [ 'shape' => 'Boolean', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'agentUpdateStatus' => [ 'shape' => 'AgentUpdateStatus', ], 'attributes' => [ 'shape' => 'Attributes', ], 'registeredAt' => [ 'shape' => 'Timestamp', ], 'attachments' => [ 'shape' => 'Attachments', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'ContainerInstanceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'ContainerInstanceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstanceField', ], ], 'ContainerInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DRAINING', ], ], 'ContainerInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstance', ], ], 'ContainerOverride' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'cpu' => [ 'shape' => 'BoxedInteger', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], ], ], 'ContainerOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerOverride', ], ], 'ContainerStateChange' => [ 'type' => 'structure', 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'reason' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'ContainerStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerStateChange', ], ], 'Containers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Container', ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'members' => [ 'clusterName' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'taskDefinition', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'clientToken' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'role' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'CreateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'DeleteAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'DeleteAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'DeleteAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'DeleteServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeleteServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'Deployment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], ], ], 'DeploymentConfiguration' => [ 'type' => 'structure', 'members' => [ 'maximumPercent' => [ 'shape' => 'BoxedInteger', ], 'minimumHealthyPercent' => [ 'shape' => 'BoxedInteger', ], ], ], 'DeploymentController' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'DeploymentControllerType', ], ], ], 'DeploymentControllerType' => [ 'type' => 'string', 'enum' => [ 'ECS', 'CODE_DEPLOY', ], ], 'Deployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Deployment', ], ], 'DeregisterContainerInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeregisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'DeregisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'DeregisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], 'DescribeClustersRequest' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ClusterFieldList', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'Clusters', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeContainerInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ContainerInstanceFieldList', ], ], ], 'DescribeContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeServicesRequest' => [ 'type' => 'structure', 'required' => [ 'services', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ServiceFieldList', ], ], ], 'DescribeServicesResponse' => [ 'type' => 'structure', 'members' => [ 'services' => [ 'shape' => 'Services', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], 'include' => [ 'shape' => 'TaskDefinitionFieldList', ], ], ], 'DescribeTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'DescribeTasksRequest' => [ 'type' => 'structure', 'required' => [ 'tasks', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'TaskFieldList', ], ], ], 'DescribeTasksResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DesiredStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'PENDING', 'STOPPED', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'hostPath', ], 'members' => [ 'hostPath' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'permissions' => [ 'shape' => 'DeviceCgroupPermissions', ], ], ], 'DeviceCgroupPermission' => [ 'type' => 'string', 'enum' => [ 'read', 'write', 'mknod', ], ], 'DeviceCgroupPermissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceCgroupPermission', ], ], 'DevicesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DiscoverPollEndpointRequest' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'String', ], 'cluster' => [ 'shape' => 'String', ], ], ], 'DiscoverPollEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'endpoint' => [ 'shape' => 'String', ], 'telemetryEndpoint' => [ 'shape' => 'String', ], ], ], 'DockerLabelsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'DockerVolumeConfiguration' => [ 'type' => 'structure', 'members' => [ 'scope' => [ 'shape' => 'Scope', ], 'autoprovision' => [ 'shape' => 'BoxedBoolean', ], 'driver' => [ 'shape' => 'String', ], 'driverOpts' => [ 'shape' => 'StringMap', ], 'labels' => [ 'shape' => 'StringMap', ], ], ], 'Double' => [ 'type' => 'double', ], 'EnvironmentVariables' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'Failure' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'Failures' => [ 'type' => 'list', 'member' => [ 'shape' => 'Failure', ], ], 'GpuIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'HealthCheck' => [ 'type' => 'structure', 'required' => [ 'command', ], 'members' => [ 'command' => [ 'shape' => 'StringList', ], 'interval' => [ 'shape' => 'BoxedInteger', ], 'timeout' => [ 'shape' => 'BoxedInteger', ], 'retries' => [ 'shape' => 'BoxedInteger', ], 'startPeriod' => [ 'shape' => 'BoxedInteger', ], ], ], 'HealthStatus' => [ 'type' => 'string', 'enum' => [ 'HEALTHY', 'UNHEALTHY', 'UNKNOWN', ], ], 'HostEntry' => [ 'type' => 'structure', 'required' => [ 'hostname', 'ipAddress', ], 'members' => [ 'hostname' => [ 'shape' => 'String', ], 'ipAddress' => [ 'shape' => 'String', ], ], ], 'HostEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HostEntry', ], ], 'HostVolumeProperties' => [ 'type' => 'structure', 'members' => [ 'sourcePath' => [ 'shape' => 'String', ], ], ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'IpcMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', 'none', ], ], 'KernelCapabilities' => [ 'type' => 'structure', 'members' => [ 'add' => [ 'shape' => 'StringList', ], 'drop' => [ 'shape' => 'StringList', ], ], ], 'KeyValuePair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'LaunchType' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', ], ], 'LinuxParameters' => [ 'type' => 'structure', 'members' => [ 'capabilities' => [ 'shape' => 'KernelCapabilities', ], 'devices' => [ 'shape' => 'DevicesList', ], 'initProcessEnabled' => [ 'shape' => 'BoxedBoolean', ], 'sharedMemorySize' => [ 'shape' => 'BoxedInteger', ], 'tmpfs' => [ 'shape' => 'TmpfsList', ], ], ], 'ListAccountSettingsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], 'effectiveSettings' => [ 'shape' => 'Boolean', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'Integer', ], ], ], 'ListAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'settings' => [ 'shape' => 'Settings', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'targetType', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'attributeName' => [ 'shape' => 'String', ], 'attributeValue' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusterArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListContainerInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'filter' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'ListContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], ], ], 'ListServicesResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'ListTaskDefinitionFamiliesRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionFamilyStatus', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionFamiliesResponse' => [ 'type' => 'structure', 'members' => [ 'families' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTaskDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'sort' => [ 'shape' => 'SortOrder', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTasksRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'family' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'startedBy' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'desiredStatus' => [ 'shape' => 'DesiredStatus', ], 'launchType' => [ 'shape' => 'LaunchType', ], ], ], 'ListTasksResponse' => [ 'type' => 'structure', 'members' => [ 'taskArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'targetGroupArn' => [ 'shape' => 'String', ], 'loadBalancerName' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'LoadBalancers' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LogConfiguration' => [ 'type' => 'structure', 'required' => [ 'logDriver', ], 'members' => [ 'logDriver' => [ 'shape' => 'LogDriver', ], 'options' => [ 'shape' => 'LogConfigurationOptionsMap', ], ], ], 'LogConfigurationOptionsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'LogDriver' => [ 'type' => 'string', 'enum' => [ 'json-file', 'syslog', 'journald', 'gelf', 'fluentd', 'awslogs', 'splunk', ], ], 'Long' => [ 'type' => 'long', ], 'MissingVersionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MountPoint' => [ 'type' => 'structure', 'members' => [ 'sourceVolume' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'MountPointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MountPoint', ], ], 'NetworkBinding' => [ 'type' => 'structure', 'members' => [ 'bindIP' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], ], ], 'NetworkBindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkBinding', ], ], 'NetworkConfiguration' => [ 'type' => 'structure', 'members' => [ 'awsvpcConfiguration' => [ 'shape' => 'AwsVpcConfiguration', ], ], ], 'NetworkInterface' => [ 'type' => 'structure', 'members' => [ 'attachmentId' => [ 'shape' => 'String', ], 'privateIpv4Address' => [ 'shape' => 'String', ], 'ipv6Address' => [ 'shape' => 'String', ], ], ], 'NetworkInterfaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkInterface', ], ], 'NetworkMode' => [ 'type' => 'string', 'enum' => [ 'bridge', 'host', 'awsvpc', 'none', ], ], 'NoUpdateAvailableException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PidMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', ], ], 'PlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'PlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'distinctInstance', 'memberOf', ], ], 'PlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementConstraint', ], ], 'PlacementStrategies' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementStrategy', ], ], 'PlacementStrategy' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementStrategyType', ], 'field' => [ 'shape' => 'String', ], ], ], 'PlacementStrategyType' => [ 'type' => 'string', 'enum' => [ 'random', 'spread', 'binpack', ], ], 'PlatformDevice' => [ 'type' => 'structure', 'required' => [ 'id', 'type', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'PlatformDeviceType', ], ], ], 'PlatformDeviceType' => [ 'type' => 'string', 'enum' => [ 'GPU', ], ], 'PlatformDevices' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlatformDevice', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PlatformUnknownException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PortMapping' => [ 'type' => 'structure', 'members' => [ 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], ], ], 'PortMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortMapping', ], ], 'PropagateTags' => [ 'type' => 'string', 'enum' => [ 'TASK_DEFINITION', 'SERVICE', ], ], 'PutAccountSettingDefaultRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingDefaultResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'PutAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'RegisterContainerInstanceRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'instanceIdentityDocument' => [ 'shape' => 'String', ], 'instanceIdentityDocumentSignature' => [ 'shape' => 'String', ], 'totalResources' => [ 'shape' => 'Resources', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], 'platformDevices' => [ 'shape' => 'PlatformDevices', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RegisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'RegisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'family', 'containerDefinitions', ], 'members' => [ 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], ], ], 'RegisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RepositoryCredentials' => [ 'type' => 'structure', 'required' => [ 'credentialsParameter', ], 'members' => [ 'credentialsParameter' => [ 'shape' => 'String', ], ], ], 'RequiresAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'doubleValue' => [ 'shape' => 'Double', ], 'longValue' => [ 'shape' => 'Long', ], 'integerValue' => [ 'shape' => 'Integer', ], 'stringSetValue' => [ 'shape' => 'StringList', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceRequirement' => [ 'type' => 'structure', 'required' => [ 'value', 'type', ], 'members' => [ 'value' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'ResourceType', ], ], ], 'ResourceRequirements' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceRequirement', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'GPU', ], ], 'Resources' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'RunTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'count' => [ 'shape' => 'BoxedInteger', ], 'startedBy' => [ 'shape' => 'String', ], 'group' => [ 'shape' => 'String', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'RunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'Scale' => [ 'type' => 'structure', 'members' => [ 'value' => [ 'shape' => 'Double', ], 'unit' => [ 'shape' => 'ScaleUnit', ], ], ], 'ScaleUnit' => [ 'type' => 'string', 'enum' => [ 'PERCENT', ], ], 'SchedulingStrategy' => [ 'type' => 'string', 'enum' => [ 'REPLICA', 'DAEMON', ], ], 'Scope' => [ 'type' => 'string', 'enum' => [ 'task', 'shared', ], ], 'Secret' => [ 'type' => 'structure', 'required' => [ 'name', 'valueFrom', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'valueFrom' => [ 'shape' => 'String', ], ], ], 'SecretList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Secret', ], ], 'ServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'fault' => true, ], 'Service' => [ 'type' => 'structure', 'members' => [ 'serviceArn' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'status' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'taskSets' => [ 'shape' => 'TaskSets', ], 'deployments' => [ 'shape' => 'Deployments', ], 'roleArn' => [ 'shape' => 'String', ], 'events' => [ 'shape' => 'ServiceEvents', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'createdBy' => [ 'shape' => 'String', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'ServiceEvent' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'message' => [ 'shape' => 'String', ], ], ], 'ServiceEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceEvent', ], ], 'ServiceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'ServiceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceField', ], ], 'ServiceNotActiveException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceRegistries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceRegistry', ], ], 'ServiceRegistry' => [ 'type' => 'structure', 'members' => [ 'registryArn' => [ 'shape' => 'String', ], 'port' => [ 'shape' => 'BoxedInteger', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'Services' => [ 'type' => 'list', 'member' => [ 'shape' => 'Service', ], ], 'Setting' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'SettingName' => [ 'type' => 'string', 'enum' => [ 'serviceLongArnFormat', 'taskLongArnFormat', 'containerInstanceLongArnFormat', ], ], 'Settings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Setting', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'StabilityStatus' => [ 'type' => 'string', 'enum' => [ 'STEADY_STATE', 'STABILIZING', ], ], 'StartTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'startedBy' => [ 'shape' => 'String', ], 'group' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'StartTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'Statistics' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'StopTaskRequest' => [ 'type' => 'structure', 'required' => [ 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'StopTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'Task', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SubmitContainerStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], ], ], 'SubmitContainerStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SubmitTaskStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'ContainerStateChanges', ], 'attachments' => [ 'shape' => 'AttachmentStateChanges', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], ], ], 'SubmitTaskStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SystemControl' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'SystemControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'SystemControl', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TargetNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'container-instance', ], ], 'Task' => [ 'type' => 'structure', 'members' => [ 'taskArn' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'lastStatus' => [ 'shape' => 'String', ], 'desiredStatus' => [ 'shape' => 'String', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'Containers', ], 'startedBy' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'stoppedReason' => [ 'shape' => 'String', ], 'stopCode' => [ 'shape' => 'TaskStopCode', ], 'connectivity' => [ 'shape' => 'Connectivity', ], 'connectivityAt' => [ 'shape' => 'Timestamp', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'startedAt' => [ 'shape' => 'Timestamp', ], 'stoppingAt' => [ 'shape' => 'Timestamp', ], 'stoppedAt' => [ 'shape' => 'Timestamp', ], 'group' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'attachments' => [ 'shape' => 'Attachments', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TaskDefinition' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'revision' => [ 'shape' => 'Integer', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'requiresAttributes' => [ 'shape' => 'RequiresAttributes', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'compatibilities' => [ 'shape' => 'CompatibilityList', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], ], ], 'TaskDefinitionFamilyStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'ALL', ], ], 'TaskDefinitionField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskDefinitionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionField', ], ], 'TaskDefinitionPlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'TaskDefinitionPlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'TaskDefinitionPlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'memberOf', ], ], 'TaskDefinitionPlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionPlacementConstraint', ], ], 'TaskDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'TaskField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskField', ], ], 'TaskOverride' => [ 'type' => 'structure', 'members' => [ 'containerOverrides' => [ 'shape' => 'ContainerOverrides', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], ], ], 'TaskSet' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'taskSetArn' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'externalId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'computedDesiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'scale' => [ 'shape' => 'Scale', ], 'stabilityStatus' => [ 'shape' => 'StabilityStatus', ], 'stabilityStatusAt' => [ 'shape' => 'Timestamp', ], ], ], 'TaskSets' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskSet', ], ], 'TaskStopCode' => [ 'type' => 'string', 'enum' => [ 'TaskFailedToStart', 'EssentialContainerExited', 'UserInitiated', ], ], 'Tasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'Task', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'Tmpfs' => [ 'type' => 'structure', 'required' => [ 'containerPath', 'size', ], 'members' => [ 'containerPath' => [ 'shape' => 'String', ], 'size' => [ 'shape' => 'Integer', ], 'mountOptions' => [ 'shape' => 'StringList', ], ], ], 'TmpfsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tmpfs', ], ], 'TransportProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'udp', ], ], 'Ulimit' => [ 'type' => 'structure', 'required' => [ 'name', 'softLimit', 'hardLimit', ], 'members' => [ 'name' => [ 'shape' => 'UlimitName', ], 'softLimit' => [ 'shape' => 'Integer', ], 'hardLimit' => [ 'shape' => 'Integer', ], ], ], 'UlimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ulimit', ], ], 'UlimitName' => [ 'type' => 'string', 'enum' => [ 'core', 'cpu', 'data', 'fsize', 'locks', 'memlock', 'msgqueue', 'nice', 'nofile', 'nproc', 'rss', 'rtprio', 'rttime', 'sigpending', 'stack', ], ], 'UnsupportedFeatureException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContainerAgentRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], ], ], 'UpdateContainerAgentResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'UpdateContainerInstancesStateRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', 'status', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'UpdateContainerInstancesStateResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'UpdateInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UpdateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'platformVersion' => [ 'shape' => 'String', ], 'forceNewDeployment' => [ 'shape' => 'Boolean', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], ], ], 'UpdateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'VersionInfo' => [ 'type' => 'structure', 'members' => [ 'agentVersion' => [ 'shape' => 'String', ], 'agentHash' => [ 'shape' => 'String', ], 'dockerVersion' => [ 'shape' => 'String', ], ], ], 'Volume' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'host' => [ 'shape' => 'HostVolumeProperties', ], 'dockerVolumeConfiguration' => [ 'shape' => 'DockerVolumeConfiguration', ], ], ], 'VolumeFrom' => [ 'type' => 'structure', 'members' => [ 'sourceContainer' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'VolumeFromList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VolumeFrom', ], ], 'VolumeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Volume', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2014-11-13', 'endpointPrefix' => 'ecs', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Amazon ECS', 'serviceFullName' => 'Amazon EC2 Container Service', 'serviceId' => 'ECS', 'signatureVersion' => 'v4', 'targetPrefix' => 'AmazonEC2ContainerServiceV20141113', 'uid' => 'ecs-2014-11-13', ], 'operations' => [ 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'CreateService' => [ 'name' => 'CreateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceRequest', ], 'output' => [ 'shape' => 'CreateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteAccountSetting' => [ 'name' => 'DeleteAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAccountSettingRequest', ], 'output' => [ 'shape' => 'DeleteAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteAttributes' => [ 'name' => 'DeleteAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAttributesRequest', ], 'output' => [ 'shape' => 'DeleteAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ClusterContainsContainerInstancesException', ], [ 'shape' => 'ClusterContainsServicesException', ], [ 'shape' => 'ClusterContainsTasksException', ], ], ], 'DeleteService' => [ 'name' => 'DeleteService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceRequest', ], 'output' => [ 'shape' => 'DeleteServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'DeregisterContainerInstance' => [ 'name' => 'DeregisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'DeregisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DeregisterTaskDefinition' => [ 'name' => 'DeregisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DeregisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeContainerInstances' => [ 'name' => 'DescribeContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContainerInstancesRequest', ], 'output' => [ 'shape' => 'DescribeContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeServices' => [ 'name' => 'DescribeServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServicesRequest', ], 'output' => [ 'shape' => 'DescribeServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeTaskDefinition' => [ 'name' => 'DescribeTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeTasks' => [ 'name' => 'DescribeTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTasksRequest', ], 'output' => [ 'shape' => 'DescribeTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DiscoverPollEndpoint' => [ 'name' => 'DiscoverPollEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverPollEndpointRequest', ], 'output' => [ 'shape' => 'DiscoverPollEndpointResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], ], ], 'ListAccountSettings' => [ 'name' => 'ListAccountSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAccountSettingsRequest', ], 'output' => [ 'shape' => 'ListAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListAttributes' => [ 'name' => 'ListAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAttributesRequest', ], 'output' => [ 'shape' => 'ListAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListContainerInstances' => [ 'name' => 'ListContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContainerInstancesRequest', ], 'output' => [ 'shape' => 'ListContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListServices' => [ 'name' => 'ListServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesRequest', ], 'output' => [ 'shape' => 'ListServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitionFamilies' => [ 'name' => 'ListTaskDefinitionFamilies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionFamiliesRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionFamiliesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitions' => [ 'name' => 'ListTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTasks' => [ 'name' => 'ListTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTasksRequest', ], 'output' => [ 'shape' => 'ListTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'PutAccountSetting' => [ 'name' => 'PutAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingRequest', ], 'output' => [ 'shape' => 'PutAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAccountSettingDefault' => [ 'name' => 'PutAccountSettingDefault', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingDefaultRequest', ], 'output' => [ 'shape' => 'PutAccountSettingDefaultResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAttributes' => [ 'name' => 'PutAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAttributesRequest', ], 'output' => [ 'shape' => 'PutAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'AttributeLimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RegisterContainerInstance' => [ 'name' => 'RegisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'RegisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RegisterTaskDefinition' => [ 'name' => 'RegisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'RegisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RunTask' => [ 'name' => 'RunTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunTaskRequest', ], 'output' => [ 'shape' => 'RunTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BlockedException', ], ], ], 'StartTask' => [ 'name' => 'StartTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartTaskRequest', ], 'output' => [ 'shape' => 'StartTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'StopTask' => [ 'name' => 'StopTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTaskRequest', ], 'output' => [ 'shape' => 'StopTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'SubmitContainerStateChange' => [ 'name' => 'SubmitContainerStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitContainerStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitContainerStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SubmitTaskStateChange' => [ 'name' => 'SubmitTaskStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitTaskStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitTaskStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateContainerAgent' => [ 'name' => 'UpdateContainerAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerAgentRequest', ], 'output' => [ 'shape' => 'UpdateContainerAgentResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UpdateInProgressException', ], [ 'shape' => 'NoUpdateAvailableException', ], [ 'shape' => 'MissingVersionException', ], ], ], 'UpdateContainerInstancesState' => [ 'name' => 'UpdateContainerInstancesState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerInstancesStateRequest', ], 'output' => [ 'shape' => 'UpdateContainerInstancesStateResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'UpdateService' => [ 'name' => 'UpdateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceRequest', ], 'output' => [ 'shape' => 'UpdateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'AgentUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STAGING', 'STAGED', 'UPDATING', 'UPDATED', 'FAILED', ], ], 'AssignPublicIp' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'Attachment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'details' => [ 'shape' => 'AttachmentDetails', ], ], ], 'AttachmentDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'AttachmentStateChange' => [ 'type' => 'structure', 'required' => [ 'attachmentArn', 'status', ], 'members' => [ 'attachmentArn' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'AttachmentStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentStateChange', ], ], 'Attachments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attachment', ], ], 'Attribute' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'targetId' => [ 'shape' => 'String', ], ], ], 'AttributeLimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Attributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'AwsVpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'subnets', ], 'members' => [ 'subnets' => [ 'shape' => 'StringList', ], 'securityGroups' => [ 'shape' => 'StringList', ], 'assignPublicIp' => [ 'shape' => 'AssignPublicIp', ], ], ], 'BlockedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'BoxedBoolean' => [ 'type' => 'boolean', 'box' => true, ], 'BoxedInteger' => [ 'type' => 'integer', 'box' => true, ], 'ClientException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'clusterArn' => [ 'shape' => 'String', ], 'clusterName' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'registeredContainerInstancesCount' => [ 'shape' => 'Integer', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'activeServicesCount' => [ 'shape' => 'Integer', ], 'statistics' => [ 'shape' => 'Statistics', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'ClusterContainsContainerInstancesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsServicesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsTasksException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterField' => [ 'type' => 'string', 'enum' => [ 'STATISTICS', 'TAGS', ], ], 'ClusterFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterField', ], ], 'ClusterNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], 'Compatibility' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', ], ], 'CompatibilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Compatibility', ], ], 'Connectivity' => [ 'type' => 'string', 'enum' => [ 'CONNECTED', 'DISCONNECTED', ], ], 'Container' => [ 'type' => 'structure', 'members' => [ 'containerArn' => [ 'shape' => 'String', ], 'taskArn' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'lastStatus' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'networkInterfaces' => [ 'shape' => 'NetworkInterfaces', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'memoryReservation' => [ 'shape' => 'String', ], 'gpuIds' => [ 'shape' => 'GpuIds', ], ], ], 'ContainerCondition' => [ 'type' => 'string', 'enum' => [ 'START', 'COMPLETE', 'SUCCESS', 'HEALTHY', ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'repositoryCredentials' => [ 'shape' => 'RepositoryCredentials', ], 'cpu' => [ 'shape' => 'Integer', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'links' => [ 'shape' => 'StringList', ], 'portMappings' => [ 'shape' => 'PortMappingList', ], 'essential' => [ 'shape' => 'BoxedBoolean', ], 'entryPoint' => [ 'shape' => 'StringList', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'mountPoints' => [ 'shape' => 'MountPointList', ], 'volumesFrom' => [ 'shape' => 'VolumeFromList', ], 'linuxParameters' => [ 'shape' => 'LinuxParameters', ], 'secrets' => [ 'shape' => 'SecretList', ], 'dependsOn' => [ 'shape' => 'ContainerDependencies', ], 'startTimeout' => [ 'shape' => 'BoxedInteger', ], 'stopTimeout' => [ 'shape' => 'BoxedInteger', ], 'hostname' => [ 'shape' => 'String', ], 'user' => [ 'shape' => 'String', ], 'workingDirectory' => [ 'shape' => 'String', ], 'disableNetworking' => [ 'shape' => 'BoxedBoolean', ], 'privileged' => [ 'shape' => 'BoxedBoolean', ], 'readonlyRootFilesystem' => [ 'shape' => 'BoxedBoolean', ], 'dnsServers' => [ 'shape' => 'StringList', ], 'dnsSearchDomains' => [ 'shape' => 'StringList', ], 'extraHosts' => [ 'shape' => 'HostEntryList', ], 'dockerSecurityOptions' => [ 'shape' => 'StringList', ], 'interactive' => [ 'shape' => 'BoxedBoolean', ], 'pseudoTerminal' => [ 'shape' => 'BoxedBoolean', ], 'dockerLabels' => [ 'shape' => 'DockerLabelsMap', ], 'ulimits' => [ 'shape' => 'UlimitList', ], 'logConfiguration' => [ 'shape' => 'LogConfiguration', ], 'healthCheck' => [ 'shape' => 'HealthCheck', ], 'systemControls' => [ 'shape' => 'SystemControls', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], ], ], 'ContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], ], 'ContainerDependencies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDependency', ], ], 'ContainerDependency' => [ 'type' => 'structure', 'required' => [ 'containerName', 'condition', ], 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'condition' => [ 'shape' => 'ContainerCondition', ], ], ], 'ContainerInstance' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArn' => [ 'shape' => 'String', ], 'ec2InstanceId' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'remainingResources' => [ 'shape' => 'Resources', ], 'registeredResources' => [ 'shape' => 'Resources', ], 'status' => [ 'shape' => 'String', ], 'agentConnected' => [ 'shape' => 'Boolean', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'agentUpdateStatus' => [ 'shape' => 'AgentUpdateStatus', ], 'attributes' => [ 'shape' => 'Attributes', ], 'registeredAt' => [ 'shape' => 'Timestamp', ], 'attachments' => [ 'shape' => 'Attachments', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'ContainerInstanceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'ContainerInstanceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstanceField', ], ], 'ContainerInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DRAINING', ], ], 'ContainerInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstance', ], ], 'ContainerOverride' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'cpu' => [ 'shape' => 'BoxedInteger', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], ], ], 'ContainerOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerOverride', ], ], 'ContainerStateChange' => [ 'type' => 'structure', 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'reason' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'ContainerStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerStateChange', ], ], 'Containers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Container', ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'members' => [ 'clusterName' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'taskDefinition', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'clientToken' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'role' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'CreateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'DeleteAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'DeleteAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'DeleteAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'DeleteServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeleteServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'Deployment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], ], ], 'DeploymentConfiguration' => [ 'type' => 'structure', 'members' => [ 'maximumPercent' => [ 'shape' => 'BoxedInteger', ], 'minimumHealthyPercent' => [ 'shape' => 'BoxedInteger', ], ], ], 'DeploymentController' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'DeploymentControllerType', ], ], ], 'DeploymentControllerType' => [ 'type' => 'string', 'enum' => [ 'ECS', 'CODE_DEPLOY', ], ], 'Deployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Deployment', ], ], 'DeregisterContainerInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeregisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'DeregisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'DeregisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], 'DescribeClustersRequest' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ClusterFieldList', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'Clusters', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeContainerInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ContainerInstanceFieldList', ], ], ], 'DescribeContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeServicesRequest' => [ 'type' => 'structure', 'required' => [ 'services', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ServiceFieldList', ], ], ], 'DescribeServicesResponse' => [ 'type' => 'structure', 'members' => [ 'services' => [ 'shape' => 'Services', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], 'include' => [ 'shape' => 'TaskDefinitionFieldList', ], ], ], 'DescribeTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'DescribeTasksRequest' => [ 'type' => 'structure', 'required' => [ 'tasks', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'TaskFieldList', ], ], ], 'DescribeTasksResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DesiredStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'PENDING', 'STOPPED', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'hostPath', ], 'members' => [ 'hostPath' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'permissions' => [ 'shape' => 'DeviceCgroupPermissions', ], ], ], 'DeviceCgroupPermission' => [ 'type' => 'string', 'enum' => [ 'read', 'write', 'mknod', ], ], 'DeviceCgroupPermissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceCgroupPermission', ], ], 'DevicesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DiscoverPollEndpointRequest' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'String', ], 'cluster' => [ 'shape' => 'String', ], ], ], 'DiscoverPollEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'endpoint' => [ 'shape' => 'String', ], 'telemetryEndpoint' => [ 'shape' => 'String', ], ], ], 'DockerLabelsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'DockerVolumeConfiguration' => [ 'type' => 'structure', 'members' => [ 'scope' => [ 'shape' => 'Scope', ], 'autoprovision' => [ 'shape' => 'BoxedBoolean', ], 'driver' => [ 'shape' => 'String', ], 'driverOpts' => [ 'shape' => 'StringMap', ], 'labels' => [ 'shape' => 'StringMap', ], ], ], 'Double' => [ 'type' => 'double', ], 'EnvironmentVariables' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'Failure' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'Failures' => [ 'type' => 'list', 'member' => [ 'shape' => 'Failure', ], ], 'GpuIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'HealthCheck' => [ 'type' => 'structure', 'required' => [ 'command', ], 'members' => [ 'command' => [ 'shape' => 'StringList', ], 'interval' => [ 'shape' => 'BoxedInteger', ], 'timeout' => [ 'shape' => 'BoxedInteger', ], 'retries' => [ 'shape' => 'BoxedInteger', ], 'startPeriod' => [ 'shape' => 'BoxedInteger', ], ], ], 'HealthStatus' => [ 'type' => 'string', 'enum' => [ 'HEALTHY', 'UNHEALTHY', 'UNKNOWN', ], ], 'HostEntry' => [ 'type' => 'structure', 'required' => [ 'hostname', 'ipAddress', ], 'members' => [ 'hostname' => [ 'shape' => 'String', ], 'ipAddress' => [ 'shape' => 'String', ], ], ], 'HostEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HostEntry', ], ], 'HostVolumeProperties' => [ 'type' => 'structure', 'members' => [ 'sourcePath' => [ 'shape' => 'String', ], ], ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'IpcMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', 'none', ], ], 'KernelCapabilities' => [ 'type' => 'structure', 'members' => [ 'add' => [ 'shape' => 'StringList', ], 'drop' => [ 'shape' => 'StringList', ], ], ], 'KeyValuePair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'LaunchType' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', ], ], 'LinuxParameters' => [ 'type' => 'structure', 'members' => [ 'capabilities' => [ 'shape' => 'KernelCapabilities', ], 'devices' => [ 'shape' => 'DevicesList', ], 'initProcessEnabled' => [ 'shape' => 'BoxedBoolean', ], 'sharedMemorySize' => [ 'shape' => 'BoxedInteger', ], 'tmpfs' => [ 'shape' => 'TmpfsList', ], ], ], 'ListAccountSettingsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], 'effectiveSettings' => [ 'shape' => 'Boolean', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'Integer', ], ], ], 'ListAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'settings' => [ 'shape' => 'Settings', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'targetType', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'attributeName' => [ 'shape' => 'String', ], 'attributeValue' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusterArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListContainerInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'filter' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'ListContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], ], ], 'ListServicesResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'ListTaskDefinitionFamiliesRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionFamilyStatus', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionFamiliesResponse' => [ 'type' => 'structure', 'members' => [ 'families' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTaskDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'sort' => [ 'shape' => 'SortOrder', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTasksRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'family' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'startedBy' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'desiredStatus' => [ 'shape' => 'DesiredStatus', ], 'launchType' => [ 'shape' => 'LaunchType', ], ], ], 'ListTasksResponse' => [ 'type' => 'structure', 'members' => [ 'taskArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'targetGroupArn' => [ 'shape' => 'String', ], 'loadBalancerName' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'LoadBalancers' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LogConfiguration' => [ 'type' => 'structure', 'required' => [ 'logDriver', ], 'members' => [ 'logDriver' => [ 'shape' => 'LogDriver', ], 'options' => [ 'shape' => 'LogConfigurationOptionsMap', ], ], ], 'LogConfigurationOptionsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'LogDriver' => [ 'type' => 'string', 'enum' => [ 'json-file', 'syslog', 'journald', 'gelf', 'fluentd', 'awslogs', 'splunk', ], ], 'Long' => [ 'type' => 'long', ], 'MissingVersionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MountPoint' => [ 'type' => 'structure', 'members' => [ 'sourceVolume' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'MountPointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MountPoint', ], ], 'NetworkBinding' => [ 'type' => 'structure', 'members' => [ 'bindIP' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], ], ], 'NetworkBindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkBinding', ], ], 'NetworkConfiguration' => [ 'type' => 'structure', 'members' => [ 'awsvpcConfiguration' => [ 'shape' => 'AwsVpcConfiguration', ], ], ], 'NetworkInterface' => [ 'type' => 'structure', 'members' => [ 'attachmentId' => [ 'shape' => 'String', ], 'privateIpv4Address' => [ 'shape' => 'String', ], 'ipv6Address' => [ 'shape' => 'String', ], ], ], 'NetworkInterfaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkInterface', ], ], 'NetworkMode' => [ 'type' => 'string', 'enum' => [ 'bridge', 'host', 'awsvpc', 'none', ], ], 'NoUpdateAvailableException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PidMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', ], ], 'PlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'PlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'distinctInstance', 'memberOf', ], ], 'PlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementConstraint', ], ], 'PlacementStrategies' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementStrategy', ], ], 'PlacementStrategy' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementStrategyType', ], 'field' => [ 'shape' => 'String', ], ], ], 'PlacementStrategyType' => [ 'type' => 'string', 'enum' => [ 'random', 'spread', 'binpack', ], ], 'PlatformDevice' => [ 'type' => 'structure', 'required' => [ 'id', 'type', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'PlatformDeviceType', ], ], ], 'PlatformDeviceType' => [ 'type' => 'string', 'enum' => [ 'GPU', ], ], 'PlatformDevices' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlatformDevice', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PlatformUnknownException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PortMapping' => [ 'type' => 'structure', 'members' => [ 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], ], ], 'PortMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortMapping', ], ], 'PropagateTags' => [ 'type' => 'string', 'enum' => [ 'TASK_DEFINITION', 'SERVICE', ], ], 'ProxyConfiguration' => [ 'type' => 'structure', 'required' => [ 'containerName', ], 'members' => [ 'type' => [ 'shape' => 'ProxyConfigurationType', ], 'containerName' => [ 'shape' => 'String', ], 'properties' => [ 'shape' => 'ProxyConfigurationProperties', ], ], ], 'ProxyConfigurationProperties' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'ProxyConfigurationType' => [ 'type' => 'string', 'enum' => [ 'APPMESH', ], ], 'PutAccountSettingDefaultRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingDefaultResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'PutAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'RegisterContainerInstanceRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'instanceIdentityDocument' => [ 'shape' => 'String', ], 'instanceIdentityDocumentSignature' => [ 'shape' => 'String', ], 'totalResources' => [ 'shape' => 'Resources', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], 'platformDevices' => [ 'shape' => 'PlatformDevices', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RegisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'RegisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'family', 'containerDefinitions', ], 'members' => [ 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], 'proxyConfiguration' => [ 'shape' => 'ProxyConfiguration', ], ], ], 'RegisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RepositoryCredentials' => [ 'type' => 'structure', 'required' => [ 'credentialsParameter', ], 'members' => [ 'credentialsParameter' => [ 'shape' => 'String', ], ], ], 'RequiresAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'doubleValue' => [ 'shape' => 'Double', ], 'longValue' => [ 'shape' => 'Long', ], 'integerValue' => [ 'shape' => 'Integer', ], 'stringSetValue' => [ 'shape' => 'StringList', ], ], ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceRequirement' => [ 'type' => 'structure', 'required' => [ 'value', 'type', ], 'members' => [ 'value' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'ResourceType', ], ], ], 'ResourceRequirements' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceRequirement', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'GPU', ], ], 'Resources' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'RunTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'count' => [ 'shape' => 'BoxedInteger', ], 'startedBy' => [ 'shape' => 'String', ], 'group' => [ 'shape' => 'String', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'RunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'Scale' => [ 'type' => 'structure', 'members' => [ 'value' => [ 'shape' => 'Double', ], 'unit' => [ 'shape' => 'ScaleUnit', ], ], ], 'ScaleUnit' => [ 'type' => 'string', 'enum' => [ 'PERCENT', ], ], 'SchedulingStrategy' => [ 'type' => 'string', 'enum' => [ 'REPLICA', 'DAEMON', ], ], 'Scope' => [ 'type' => 'string', 'enum' => [ 'task', 'shared', ], ], 'Secret' => [ 'type' => 'structure', 'required' => [ 'name', 'valueFrom', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'valueFrom' => [ 'shape' => 'String', ], ], ], 'SecretList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Secret', ], ], 'ServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'fault' => true, ], 'Service' => [ 'type' => 'structure', 'members' => [ 'serviceArn' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'status' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'taskSets' => [ 'shape' => 'TaskSets', ], 'deployments' => [ 'shape' => 'Deployments', ], 'roleArn' => [ 'shape' => 'String', ], 'events' => [ 'shape' => 'ServiceEvents', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'createdBy' => [ 'shape' => 'String', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'ServiceEvent' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'message' => [ 'shape' => 'String', ], ], ], 'ServiceEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceEvent', ], ], 'ServiceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'ServiceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceField', ], ], 'ServiceNotActiveException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceRegistries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceRegistry', ], ], 'ServiceRegistry' => [ 'type' => 'structure', 'members' => [ 'registryArn' => [ 'shape' => 'String', ], 'port' => [ 'shape' => 'BoxedInteger', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'Services' => [ 'type' => 'list', 'member' => [ 'shape' => 'Service', ], ], 'Setting' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'SettingName' => [ 'type' => 'string', 'enum' => [ 'serviceLongArnFormat', 'taskLongArnFormat', 'containerInstanceLongArnFormat', ], ], 'Settings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Setting', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'StabilityStatus' => [ 'type' => 'string', 'enum' => [ 'STEADY_STATE', 'STABILIZING', ], ], 'StartTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'startedBy' => [ 'shape' => 'String', ], 'group' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], ], ], 'StartTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'Statistics' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'StopTaskRequest' => [ 'type' => 'structure', 'required' => [ 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'StopTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'Task', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SubmitContainerStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], ], ], 'SubmitContainerStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SubmitTaskStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'ContainerStateChanges', ], 'attachments' => [ 'shape' => 'AttachmentStateChanges', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], ], ], 'SubmitTaskStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SystemControl' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'SystemControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'SystemControl', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TargetNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'container-instance', ], ], 'Task' => [ 'type' => 'structure', 'members' => [ 'taskArn' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'lastStatus' => [ 'shape' => 'String', ], 'desiredStatus' => [ 'shape' => 'String', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'Containers', ], 'startedBy' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'stoppedReason' => [ 'shape' => 'String', ], 'stopCode' => [ 'shape' => 'TaskStopCode', ], 'connectivity' => [ 'shape' => 'Connectivity', ], 'connectivityAt' => [ 'shape' => 'Timestamp', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'startedAt' => [ 'shape' => 'Timestamp', ], 'stoppingAt' => [ 'shape' => 'Timestamp', ], 'stoppedAt' => [ 'shape' => 'Timestamp', ], 'group' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'attachments' => [ 'shape' => 'Attachments', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TaskDefinition' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'revision' => [ 'shape' => 'Integer', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'requiresAttributes' => [ 'shape' => 'RequiresAttributes', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'compatibilities' => [ 'shape' => 'CompatibilityList', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], 'proxyConfiguration' => [ 'shape' => 'ProxyConfiguration', ], ], ], 'TaskDefinitionFamilyStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'ALL', ], ], 'TaskDefinitionField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskDefinitionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionField', ], ], 'TaskDefinitionPlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'TaskDefinitionPlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'TaskDefinitionPlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'memberOf', ], ], 'TaskDefinitionPlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionPlacementConstraint', ], ], 'TaskDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'TaskField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskField', ], ], 'TaskOverride' => [ 'type' => 'structure', 'members' => [ 'containerOverrides' => [ 'shape' => 'ContainerOverrides', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], ], ], 'TaskSet' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'taskSetArn' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'externalId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'computedDesiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'scale' => [ 'shape' => 'Scale', ], 'stabilityStatus' => [ 'shape' => 'StabilityStatus', ], 'stabilityStatusAt' => [ 'shape' => 'Timestamp', ], ], ], 'TaskSets' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskSet', ], ], 'TaskStopCode' => [ 'type' => 'string', 'enum' => [ 'TaskFailedToStart', 'EssentialContainerExited', 'UserInitiated', ], ], 'Tasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'Task', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'Tmpfs' => [ 'type' => 'structure', 'required' => [ 'containerPath', 'size', ], 'members' => [ 'containerPath' => [ 'shape' => 'String', ], 'size' => [ 'shape' => 'Integer', ], 'mountOptions' => [ 'shape' => 'StringList', ], ], ], 'TmpfsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tmpfs', ], ], 'TransportProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'udp', ], ], 'Ulimit' => [ 'type' => 'structure', 'required' => [ 'name', 'softLimit', 'hardLimit', ], 'members' => [ 'name' => [ 'shape' => 'UlimitName', ], 'softLimit' => [ 'shape' => 'Integer', ], 'hardLimit' => [ 'shape' => 'Integer', ], ], ], 'UlimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ulimit', ], ], 'UlimitName' => [ 'type' => 'string', 'enum' => [ 'core', 'cpu', 'data', 'fsize', 'locks', 'memlock', 'msgqueue', 'nice', 'nofile', 'nproc', 'rss', 'rtprio', 'rttime', 'sigpending', 'stack', ], ], 'UnsupportedFeatureException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContainerAgentRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], ], ], 'UpdateContainerAgentResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'UpdateContainerInstancesStateRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', 'status', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'UpdateContainerInstancesStateResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'UpdateInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UpdateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'platformVersion' => [ 'shape' => 'String', ], 'forceNewDeployment' => [ 'shape' => 'Boolean', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], ], ], 'UpdateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'VersionInfo' => [ 'type' => 'structure', 'members' => [ 'agentVersion' => [ 'shape' => 'String', ], 'agentHash' => [ 'shape' => 'String', ], 'dockerVersion' => [ 'shape' => 'String', ], ], ], 'Volume' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'host' => [ 'shape' => 'HostVolumeProperties', ], 'dockerVolumeConfiguration' => [ 'shape' => 'DockerVolumeConfiguration', ], ], ], 'VolumeFrom' => [ 'type' => 'structure', 'members' => [ 'sourceContainer' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'VolumeFromList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VolumeFrom', ], ], 'VolumeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Volume', ], ], ],]; diff --git a/src/data/ecs/2014-11-13/docs-2.json b/src/data/ecs/2014-11-13/docs-2.json index 10720667dc..809f31e639 100644 --- a/src/data/ecs/2014-11-13/docs-2.json +++ b/src/data/ecs/2014-11-13/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

", + "service": "Amazon Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

", "operations": { "CreateCluster": "

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

", "CreateService": "

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.

If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the CODE_DEPLOY deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values are not used, although they are currently visible when describing your service.

Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:

", @@ -160,12 +160,14 @@ "Container$exitCode": "

The exit code returned from the container.

", "ContainerDefinition$memory": "

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.

For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

", "ContainerDefinition$memoryReservation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

", + "ContainerDefinition$startTimeout": "

Time duration to wait before giving up on starting the container.

The startTimeout value for the container will take precedence over the ECS_CONTAINER_START_TIMEOUT container agent configuration parameter, if used.

", + "ContainerDefinition$stopTimeout": "

Time duration to wait before the container is forcefully killed if it does not exit normally on its own.

The stopTimeout value for the container will take precedence over the ECS_CONTAINER_STOP_TIMEOUT container agent configuration parameter, if used.

", "ContainerOverride$cpu": "

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

", "ContainerOverride$memory": "

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

", "ContainerOverride$memoryReservation": "

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

", "ContainerStateChange$exitCode": "

The exit code for the container, if the state change is a result of the container exiting.

", "CreateServiceRequest$desiredCount": "

The number of instantiations of the specified task definition to place and keep running on your cluster.

", - "CreateServiceRequest$healthCheckGracePeriodSeconds": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

", + "CreateServiceRequest$healthCheckGracePeriodSeconds": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

", "DeploymentConfiguration$maximumPercent": "

If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

", "DeploymentConfiguration$minimumHealthyPercent": "

If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

", "HealthCheck$interval": "

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

", @@ -271,6 +273,12 @@ "Containers$member": null } }, + "ContainerCondition": { + "base": null, + "refs": { + "ContainerDependency$condition": "

The dependency condition of the container. The following are the available conditions and their behavior:

" + } + }, "ContainerDefinition": { "base": "

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

", "refs": { @@ -284,6 +292,18 @@ "TaskDefinition$containerDefinitions": "

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

" } }, + "ContainerDependencies": { + "base": null, + "refs": { + "ContainerDefinition$dependsOn": "

The dependencies defined for container startup. A container can contain multiple dependencies.

" + } + }, + "ContainerDependency": { + "base": "

The dependencies defined for container startup. A container can contain multiple dependencies.

", + "refs": { + "ContainerDependencies$member": null + } + }, "ContainerInstance": { "base": "

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

", "refs": { @@ -683,6 +703,7 @@ "refs": { "AttachmentDetails$member": null, "EnvironmentVariables$member": null, + "ProxyConfigurationProperties$member": null, "Statistics$member": null } }, @@ -998,6 +1019,25 @@ "StartTaskRequest$propagateTags": "

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

" } }, + "ProxyConfiguration": { + "base": "

The configuration details for the App Mesh proxy.

", + "refs": { + "RegisterTaskDefinitionRequest$proxyConfiguration": null, + "TaskDefinition$proxyConfiguration": "

" + } + }, + "ProxyConfigurationProperties": { + "base": null, + "refs": { + "ProxyConfiguration$properties": "

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

" + } + }, + "ProxyConfigurationType": { + "base": null, + "refs": { + "ProxyConfiguration$type": "

The proxy type. The only supported value is APPMESH.

" + } + }, "PutAccountSettingDefaultRequest": { "base": null, "refs": { @@ -1302,8 +1342,9 @@ "ContainerDefinition$name": "

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

", "ContainerDefinition$image": "

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

", "ContainerDefinition$hostname": "

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

", - "ContainerDefinition$user": "

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

This parameter is not supported for Windows containers.

", + "ContainerDefinition$user": "

The username to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

This following formats can be used. If specifying a UID or GID, it must be specified as a positive integer.

This parameter is not supported for Windows containers.

", "ContainerDefinition$workingDirectory": "

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

", + "ContainerDependency$containerName": "

The name of a container.

", "ContainerInstance$containerInstanceArn": "

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

", "ContainerInstance$ec2InstanceId": "

The EC2 instance ID of the container instance.

", "ContainerInstance$status": "

The status of the container instance. The valid values are ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.

", @@ -1397,6 +1438,7 @@ "PlacementConstraint$expression": "

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

", "PlacementStrategy$field": "

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

", "PlatformDevice$id": "

The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

", + "ProxyConfiguration$containerName": "

The name of the container that will serve as the App Mesh proxy.

", "PutAccountSettingDefaultRequest$value": "

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

", "PutAccountSettingRequest$value": "

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

", "PutAccountSettingRequest$principalArn": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the settings are changed only for the authenticated user.

", diff --git a/src/data/ecs/2014-11-13/docs-2.json.php b/src/data/ecs/2014-11-13/docs-2.json.php index d9dff94692..e91b1793be 100644 --- a/src/data/ecs/2014-11-13/docs-2.json.php +++ b/src/data/ecs/2014-11-13/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

', 'operations' => [ 'CreateCluster' => '

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'CreateService' => '

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.

If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the CODE_DEPLOY deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values are not used, although they are currently visible when describing your service.

Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:

', 'DeleteAccountSetting' => '

Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.

', 'DeleteAttributes' => '

Deletes one or more custom attributes from an Amazon ECS resource.

', 'DeleteCluster' => '

Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

', 'DeleteService' => '

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

', 'DeregisterContainerInstance' => '

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

', 'DeregisterTaskDefinition' => '

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service\'s desired count.

You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

', 'DescribeClusters' => '

Describes one or more of your clusters.

', 'DescribeContainerInstances' => '

Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

', 'DescribeServices' => '

Describes the specified services running in your cluster.

', 'DescribeTaskDefinition' => '

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

', 'DescribeTasks' => '

Describes a specified task or tasks.

', 'DiscoverPollEndpoint' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

', 'ListAccountSettings' => '

Lists the account settings for an Amazon ECS resource for a specified principal.

', 'ListAttributes' => '

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

', 'ListClusters' => '

Returns a list of existing clusters.

', 'ListContainerInstances' => '

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListServices' => '

Lists the services that are running in a specified cluster.

', 'ListTagsForResource' => '

List the tags for an Amazon ECS resource.

', 'ListTaskDefinitionFamilies' => '

Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

', 'ListTaskDefinitions' => '

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

', 'ListTasks' => '

Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.

Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

', 'PutAccountSetting' => '

Modifies the ARN and resource ID format of a resource type for a specified IAM user, IAM role, or the root user for an account. If the account setting for the root user is changed, it sets the default setting for all of the IAM users and roles for which no individual account setting has been set. The opt-in and opt-out account setting can be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. Enabling this setting is required to use new Amazon ECS features such as resource tagging. For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon Elastic Container Service Developer Guide.

', 'PutAccountSettingDefault' => '

Modifies the ARN and resource ID format of a resource type for all IAM users on an account for which no individual account setting has been set. Enabling this setting is required to use new Amazon ECS features such as resource tagging.

', 'PutAttributes' => '

Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'RegisterContainerInstance' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

', 'RegisterTaskDefinition' => '

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'RunTask' => '

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

', 'StartTask' => '

Starts a new task from the specified task definition on the specified container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

', 'StopTask' => '

Stops a running task. Any tags associated with the task will be deleted.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', 'SubmitContainerStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

', 'SubmitTaskStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

', 'TagResource' => '

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

', 'UntagResource' => '

Deletes specified tags from a resource.

', 'UpdateContainerAgent' => '

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide.

', 'UpdateContainerInstancesState' => '

Modifies the status of an Amazon ECS container instance.

You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service\'s deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

', 'UpdateService' => '

Modifies the parameters of a service.

For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service\'s deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

You do not have authorization to perform the requested action.

', 'refs' => [], ], 'AgentUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentUpdateStatus' => '

The status of the most recent agent update. If an update has never been requested, this value is NULL.

', ], ], 'AssignPublicIp' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$assignPublicIp' => '

Whether the task\'s elastic network interface receives a public IP address. The default value is DISABLED.

', ], ], 'Attachment' => [ 'base' => '

An object representing a container instance or task attachment.

', 'refs' => [ 'Attachments$member' => NULL, ], ], 'AttachmentDetails' => [ 'base' => NULL, 'refs' => [ 'Attachment$details' => '

Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

', ], ], 'AttachmentStateChange' => [ 'base' => '

An object representing a change in state for a task attachment.

', 'refs' => [ 'AttachmentStateChanges$member' => NULL, ], ], 'AttachmentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$attachments' => '

Any attachments associated with the state change request.

', ], ], 'Attachments' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attachments' => '

The elastic network interfaces associated with the container instance.

', 'Task$attachments' => '

The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.

', ], ], 'Attribute' => [ 'base' => '

An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'AttributeLimitExceededException' => [ 'base' => '

You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

', 'refs' => [], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => '

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

', 'DeleteAttributesRequest$attributes' => '

The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.

', 'DeleteAttributesResponse$attributes' => '

A list of attribute objects that were successfully deleted from your resource.

', 'ListAttributesResponse$attributes' => '

A list of attribute objects that meet the criteria of the request.

', 'PutAttributesRequest$attributes' => '

The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.

', 'PutAttributesResponse$attributes' => '

The attributes applied to your resource.

', 'RegisterContainerInstanceRequest$attributes' => '

The container instance attributes that this container instance supports.

', ], ], 'AwsVpcConfiguration' => [ 'base' => '

An object representing the networking details for a task or service.

', 'refs' => [ 'NetworkConfiguration$awsvpcConfiguration' => '

The VPC subnets and security groups associated with a task.

All specified subnets and security groups must be from the same VPC.

', ], ], 'BlockedException' => [ 'base' => '

Your AWS account has been blocked. For more information, contact AWS Support.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => '

This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests.

', 'CreateServiceRequest$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'ListAccountSettingsRequest$effectiveSettings' => '

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

', 'RunTaskRequest$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'Service$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'StartTaskRequest$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'UpdateServiceRequest$forceNewDeployment' => '

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service\'s tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$essential' => '

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

', 'ContainerDefinition$disableNetworking' => '

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$privileged' => '

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', 'ContainerDefinition$readonlyRootFilesystem' => '

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$interactive' => '

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

', 'ContainerDefinition$pseudoTerminal' => '

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

', 'DeleteServiceRequest$force' => '

If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.

', 'DeregisterContainerInstanceRequest$force' => '

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

', 'DockerVolumeConfiguration$autoprovision' => '

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

', 'LinuxParameters$initProcessEnabled' => '

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', 'MountPoint$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', 'VolumeFrom$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', ], ], 'BoxedInteger' => [ 'base' => NULL, 'refs' => [ 'Container$exitCode' => '

The exit code returned from the container.

', 'ContainerDefinition$memory' => '

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.

For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

', 'ContainerDefinition$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

', 'ContainerOverride$cpu' => '

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerOverride$memory' => '

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

', 'ContainerOverride$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerStateChange$exitCode' => '

The exit code for the container, if the state change is a result of the container exiting.

', 'CreateServiceRequest$desiredCount' => '

The number of instantiations of the specified task definition to place and keep running on your cluster.

', 'CreateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', 'DeploymentConfiguration$maximumPercent' => '

If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

', 'DeploymentConfiguration$minimumHealthyPercent' => '

If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

', 'HealthCheck$interval' => '

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

', 'HealthCheck$timeout' => '

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

', 'HealthCheck$retries' => '

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

', 'HealthCheck$startPeriod' => '

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

', 'LinuxParameters$sharedMemorySize' => '

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

', 'ListAttributesRequest$maxResults' => '

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

', 'ListClustersRequest$maxResults' => '

The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.

', 'ListContainerInstancesRequest$maxResults' => '

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

', 'ListServicesRequest$maxResults' => '

The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.

', 'ListTaskDefinitionFamiliesRequest$maxResults' => '

The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

', 'ListTaskDefinitionsRequest$maxResults' => '

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

', 'ListTasksRequest$maxResults' => '

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

', 'LoadBalancer$containerPort' => '

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service\'s task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

', 'NetworkBinding$containerPort' => '

The port number on the container that is used with the network binding.

', 'NetworkBinding$hostPort' => '

The port number on the host that is used with the network binding.

', 'PortMapping$containerPort' => '

The port number on the container that is bound to the user-specified or automatically assigned host port.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.

If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

', 'PortMapping$hostPort' => '

The port number on the container instance to reserve for your container.

If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don\'t count toward the 100 reserved ports limit.

', 'RunTaskRequest$count' => '

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

', 'Service$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

', 'ServiceRegistry$port' => '

The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.

', 'ServiceRegistry$containerPort' => '

The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

', 'SubmitContainerStateChangeRequest$exitCode' => '

The exit code returned for the state change request.

', 'UpdateServiceRequest$desiredCount' => '

The number of instantiations of the task to place and keep running in your service.

', 'UpdateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', ], ], 'ClientException' => [ 'base' => '

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn\'t have permissions to use the action or resource, or specifying an identifier that is not valid.

', 'refs' => [], ], 'Cluster' => [ 'base' => '

A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => '

The full description of your new cluster.

', 'DeleteClusterResponse$cluster' => '

The full description of the deleted cluster.

', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => '

You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

', 'refs' => [], ], 'ClusterContainsServicesException' => [ 'base' => '

You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

', 'refs' => [], ], 'ClusterContainsTasksException' => [ 'base' => '

You cannot delete a cluster that has active tasks.

', 'refs' => [], ], 'ClusterField' => [ 'base' => NULL, 'refs' => [ 'ClusterFieldList$member' => NULL, ], ], 'ClusterFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$include' => '

Additional information about your clusters to be separated by launch type, including:

', ], ], 'ClusterNotFoundException' => [ 'base' => '

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

', 'refs' => [], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => '

The list of clusters.

', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CompatibilityList$member' => NULL, ], ], 'CompatibilityList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$requiresCompatibilities' => '

The launch type required by the task. If no value is specified, it defaults to EC2.

', 'TaskDefinition$compatibilities' => '

The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$requiresCompatibilities' => '

The launch type that the task is using.

', ], ], 'Connectivity' => [ 'base' => NULL, 'refs' => [ 'Task$connectivity' => '

The connectivity status of a task.

', ], ], 'Container' => [ 'base' => '

A Docker container that is part of a task.

', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerDefinition' => [ 'base' => '

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task.

', 'TaskDefinition$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ContainerInstance' => [ 'base' => '

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => '

The container instance that was deregistered.

', 'RegisterContainerInstanceResponse$containerInstance' => '

The container instance that was registered.

', 'UpdateContainerAgentResponse$containerInstance' => '

The container instance for which the container agent was updated.

', ], ], 'ContainerInstanceField' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceFieldList$member' => NULL, ], ], 'ContainerInstanceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesRequest$include' => '

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'ContainerInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ListContainerInstancesRequest$status' => '

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING.

', 'UpdateContainerInstancesStateRequest$status' => '

The container instance state with which to update the container instance.

', ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => '

The list of container instances.

', 'UpdateContainerInstancesStateResponse$containerInstances' => '

The list of container instances.

', ], ], 'ContainerOverride' => [ 'base' => '

The overrides that should be sent to a container.

', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => '

One or more container overrides sent to a task.

', ], ], 'ContainerStateChange' => [ 'base' => '

An object representing a change in state for a container.

', 'refs' => [ 'ContainerStateChanges$member' => NULL, ], ], 'ContainerStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$containers' => '

Any containers associated with the state change request.

', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => '

The containers associated with the task.

', ], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => '

The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.

', 'refs' => [ 'Deployments$member' => NULL, ], ], 'DeploymentConfiguration' => [ 'base' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'refs' => [ 'CreateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'Service$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'UpdateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', ], ], 'DeploymentController' => [ 'base' => '

The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateServiceRequest$deploymentController' => '

The deployment controller to use for the service.

', 'Service$deploymentController' => '

The deployment controller type the service is using.

', ], ], 'DeploymentControllerType' => [ 'base' => NULL, 'refs' => [ 'DeploymentController$type' => '

The deployment controller type to use.

There are two deployment controller types available:

ECS

The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

CODE_DEPLOY

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'Service$deployments' => '

The current state of deployments for the service.

', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => '

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task\'s lastStatus may have a value of PENDING).

', ], ], 'Device' => [ 'base' => '

An object representing a container instance host device.

', 'refs' => [ 'DevicesList$member' => NULL, ], ], 'DeviceCgroupPermission' => [ 'base' => NULL, 'refs' => [ 'DeviceCgroupPermissions$member' => NULL, ], ], 'DeviceCgroupPermissions' => [ 'base' => NULL, 'refs' => [ 'Device$permissions' => '

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

', ], ], 'DevicesList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$devices' => '

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you are using tasks that use the Fargate launch type, the devices parameter is not supported.

', ], ], 'DiscoverPollEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscoverPollEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerLabelsMap' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$dockerLabels' => '

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'DockerVolumeConfiguration' => [ 'base' => '

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

', 'refs' => [ 'Volume$dockerVolumeConfiguration' => '

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'Resource$doubleValue' => '

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

', 'Scale$value' => '

The value, specified as a percent total of a service\'s desiredCount, to scale the task set.

', ], ], 'EnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$environment' => '

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

', 'ContainerOverride$environment' => '

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

', ], ], 'Failure' => [ 'base' => '

A failed resource.

', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$failures' => '

Any failures associated with the call.

', 'DescribeContainerInstancesResponse$failures' => '

Any failures associated with the call.

', 'DescribeServicesResponse$failures' => '

Any failures associated with the call.

', 'DescribeTasksResponse$failures' => '

Any failures associated with the call.

', 'RunTaskResponse$failures' => '

Any failures associated with the call.

', 'StartTaskResponse$failures' => '

Any failures associated with the call.

', 'UpdateContainerInstancesStateResponse$failures' => '

Any failures associated with the call.

', ], ], 'GpuIds' => [ 'base' => NULL, 'refs' => [ 'Container$gpuIds' => '

The IDs of each GPU assigned to the container.

', ], ], 'HealthCheck' => [ 'base' => '

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image\'s Dockerfile).

The following are notes about container health check support:

', 'refs' => [ 'ContainerDefinition$healthCheck' => '

The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

', ], ], 'HealthStatus' => [ 'base' => NULL, 'refs' => [ 'Container$healthStatus' => '

The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN.

', 'Task$healthStatus' => '

The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.

The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image\'s Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

', ], ], 'HostEntry' => [ 'base' => '

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

', 'refs' => [ 'HostEntryList$member' => NULL, ], ], 'HostEntryList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$extraHosts' => '

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

', ], ], 'HostVolumeProperties' => [ 'base' => '

Details on a container instance bind mount host volume.

', 'refs' => [ 'Volume$host' => '

This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => '

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

', 'Cluster$runningTasksCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Cluster$pendingTasksCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'Cluster$activeServicesCount' => '

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

', 'ContainerDefinition$cpu' => '

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.

', 'ContainerInstance$runningTasksCount' => '

The number of tasks on the container instance that are in the RUNNING status.

', 'ContainerInstance$pendingTasksCount' => '

The number of tasks on the container instance that are in the PENDING status.

', 'Deployment$desiredCount' => '

The most recent desired count of tasks that was specified for the service to deploy or maintain.

', 'Deployment$pendingCount' => '

The number of tasks in the deployment that are in the PENDING status.

', 'Deployment$runningCount' => '

The number of tasks in the deployment that are in the RUNNING status.

', 'ListAccountSettingsRequest$maxResults' => '

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

', 'Resource$integerValue' => '

When the integerValue type is set, the value of the resource must be an integer.

', 'Service$desiredCount' => '

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$runningCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Service$pendingCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'TaskDefinition$revision' => '

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.

', 'TaskSet$computedDesiredCount' => '

The computed desired count for the task set. This is calculated by multiplying the service\'s desiredCount by the task set\'s scale percentage.

', 'TaskSet$pendingCount' => '

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

', 'TaskSet$runningCount' => '

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

', 'Tmpfs$size' => '

The size (in MiB) of the tmpfs volume.

', 'Ulimit$softLimit' => '

The soft limit for the ulimit type.

', 'Ulimit$hardLimit' => '

The hard limit for the ulimit type.

', ], ], 'InvalidParameterException' => [ 'base' => '

The specified parameter is invalid. Review the available parameters for the API request.

', 'refs' => [], ], 'IpcMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', 'TaskDefinition$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', ], ], 'KernelCapabilities' => [ 'base' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.

', 'refs' => [ 'LinuxParameters$capabilities' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.

', ], ], 'KeyValuePair' => [ 'base' => '

A key-value pair object.

', 'refs' => [ 'AttachmentDetails$member' => NULL, 'EnvironmentVariables$member' => NULL, 'Statistics$member' => NULL, ], ], 'LaunchType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$launchType' => '

The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$launchType' => '

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'ListServicesRequest$launchType' => '

The launch type for the services to list.

', 'ListTasksRequest$launchType' => '

The launch type for services to list.

', 'RunTaskRequest$launchType' => '

The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'Service$launchType' => '

The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'Task$launchType' => '

The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$launchType' => '

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', ], ], 'LinuxParameters' => [ 'base' => '

Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

', 'refs' => [ 'ContainerDefinition$linuxParameters' => '

Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.

This parameter is not supported for Windows containers.

', ], ], 'ListAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadBalancer' => [ 'base' => '

Details on a load balancer that is used with a service.

If the service is using the ECS deployment controller, you are limited to one load balancer or target group.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => '

A load balancer object representing the load balancer to use with your service.

If the service is using the ECS deployment controller, you are limited to one load balancer or target group.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'Service$loadBalancers' => '

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'TaskSet$loadBalancers' => '

Details on a load balancer that is used with a task set.

', ], ], 'LogConfiguration' => [ 'base' => '

Log configuration options to send to a custom log driver for the container.

', 'refs' => [ 'ContainerDefinition$logConfiguration' => '

The log configuration specification for the container.

If you are using the Fargate launch type, the only supported value is awslogs.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', ], ], 'LogConfigurationOptionsMap' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$options' => '

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'LogDriver' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$logDriver' => '

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs. For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$version' => '

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

', 'Resource$longValue' => '

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

', 'Task$version' => '

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

', ], ], 'MissingVersionException' => [ 'base' => '

Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.

', 'refs' => [], ], 'MountPoint' => [ 'base' => '

Details on a volume mount point that is used in a container definition.

', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => '

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

', ], ], 'NetworkBinding' => [ 'base' => '

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'NetworkBindings$member' => NULL, ], ], 'NetworkBindings' => [ 'base' => NULL, 'refs' => [ 'Container$networkBindings' => '

The network bindings associated with the container.

', 'ContainerStateChange$networkBindings' => '

Any network bindings associated with the container.

', 'SubmitContainerStateChangeRequest$networkBindings' => '

The network bindings of the container.

', ], ], 'NetworkConfiguration' => [ 'base' => '

An object representing the network configuration for a task or service.

', 'refs' => [ 'CreateServiceRequest$networkConfiguration' => '

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'RunTaskRequest$networkConfiguration' => '

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'Service$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'StartTaskRequest$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'TaskSet$networkConfiguration' => '

The network configuration for the task set.

', 'UpdateServiceRequest$networkConfiguration' => '

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.

', ], ], 'NetworkInterface' => [ 'base' => '

An object representing the elastic network interface for tasks that use the awsvpc network mode.

', 'refs' => [ 'NetworkInterfaces$member' => NULL, ], ], 'NetworkInterfaces' => [ 'base' => NULL, 'refs' => [ 'Container$networkInterfaces' => '

The network interfaces associated with the container.

', ], ], 'NetworkMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

', 'TaskDefinition$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

', ], ], 'NoUpdateAvailableException' => [ 'base' => '

There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.

', 'refs' => [], ], 'PidMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', 'TaskDefinition$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', ], ], 'PlacementConstraint' => [ 'base' => '

An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'PlacementConstraints$member' => NULL, ], ], 'PlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'PlacementConstraint$type' => '

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.

', ], ], 'PlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementConstraints' => '

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

', 'RunTaskRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

', 'Service$placementConstraints' => '

The placement constraints for the tasks in the service.

', ], ], 'PlacementStrategies' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementStrategy' => '

The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.

', 'RunTaskRequest$placementStrategy' => '

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

', 'Service$placementStrategy' => '

The placement strategy that determines how tasks for the service are placed.

', ], ], 'PlacementStrategy' => [ 'base' => '

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'PlacementStrategies$member' => NULL, ], ], 'PlacementStrategyType' => [ 'base' => NULL, 'refs' => [ 'PlacementStrategy$type' => '

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

', ], ], 'PlatformDevice' => [ 'base' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', 'refs' => [ 'PlatformDevices$member' => NULL, ], ], 'PlatformDeviceType' => [ 'base' => NULL, 'refs' => [ 'PlatformDevice$type' => '

The type of device that is available on the container instance. The only supported value is GPU.

', ], ], 'PlatformDevices' => [ 'base' => NULL, 'refs' => [ 'RegisterContainerInstanceRequest$platformDevices' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'base' => '

The specified platform version does not satisfy the task definition\'s required capabilities.

', 'refs' => [], ], 'PlatformUnknownException' => [ 'base' => '

The specified platform version does not exist.

', 'refs' => [], ], 'PortMapping' => [ 'base' => '

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'PortMappingList$member' => NULL, ], ], 'PortMappingList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$portMappings' => '

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container\'s mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can\'t specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

', ], ], 'PropagateTags' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

', 'RunTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

', 'Service$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

', 'StartTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

', ], ], 'PutAccountSettingDefaultRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingDefaultResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryCredentials' => [ 'base' => '

The repository credentials for private registry authentication.

', 'refs' => [ 'ContainerDefinition$repositoryCredentials' => '

The private repository authentication credentials to use.

', ], ], 'RequiresAttributes' => [ 'base' => NULL, 'refs' => [ 'TaskDefinition$requiresAttributes' => '

The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.

', ], ], 'Resource' => [ 'base' => '

Describes the resources available for a container instance.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource could not be found.

', 'refs' => [], ], 'ResourceRequirement' => [ 'base' => '

The type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS in the Amazon Elastic Container Service Developer Guide

', 'refs' => [ 'ResourceRequirements$member' => NULL, ], ], 'ResourceRequirements' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$resourceRequirements' => '

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

', 'ContainerOverride$resourceRequirements' => '

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceRequirement$type' => '

The type of resource to assign to a container. The only supported value is GPU.

', ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => '

For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.

', 'ContainerInstance$registeredResources' => '

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

', 'RegisterContainerInstanceRequest$totalResources' => '

The resources available on the instance.

', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Scale' => [ 'base' => '

A floating-point percentage of the desired number of tasks to place and keep running in the service. This is used when a service uses the CODE_DEPLOY deployment controller type.

', 'refs' => [ 'TaskSet$scale' => '

A floating-point percentage of the desired number of tasks to place and keep running in the service.

', ], ], 'ScaleUnit' => [ 'base' => NULL, 'refs' => [ 'Scale$unit' => '

The unit of measure for the scale value.

', ], ], 'SchedulingStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

', 'ListServicesRequest$schedulingStrategy' => '

The scheduling strategy for services to list.

', 'Service$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$scope' => '

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

', ], ], 'Secret' => [ 'base' => '

An object representing the secret to expose to your container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'SecretList$member' => NULL, ], ], 'SecretList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$secrets' => '

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ServerException' => [ 'base' => '

These errors are usually caused by a server issue.

', 'refs' => [], ], 'Service' => [ 'base' => '

Details on a service within a cluster

', 'refs' => [ 'CreateServiceResponse$service' => '

The full description of your service following the create call.

If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

', 'DeleteServiceResponse$service' => '

The full description of the deleted service.

', 'Services$member' => NULL, 'UpdateServiceResponse$service' => '

The full description of your service following the update call.

', ], ], 'ServiceEvent' => [ 'base' => '

Details on an event associated with a service.

', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => '

The event stream for your service. A maximum of 100 of the latest events are displayed.

', ], ], 'ServiceField' => [ 'base' => NULL, 'refs' => [ 'ServiceFieldList$member' => NULL, ], ], 'ServiceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesRequest$include' => '

Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'ServiceNotActiveException' => [ 'base' => '

The specified service is not active. You can\'t update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

', 'refs' => [], ], 'ServiceNotFoundException' => [ 'base' => '

The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

', 'refs' => [], ], 'ServiceRegistries' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$serviceRegistries' => '

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

', 'Service$serviceRegistries' => '

', ], ], 'ServiceRegistry' => [ 'base' => '

Details of the service registry.

', 'refs' => [ 'ServiceRegistries$member' => NULL, ], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => '

The list of services described.

', ], ], 'Setting' => [ 'base' => '

The current account setting for a resource.

', 'refs' => [ 'DeleteAccountSettingResponse$setting' => '

The account setting for the specified principal ARN.

', 'PutAccountSettingDefaultResponse$setting' => NULL, 'PutAccountSettingResponse$setting' => '

The current account setting for a resource.

', 'Settings$member' => NULL, ], ], 'SettingName' => [ 'base' => NULL, 'refs' => [ 'DeleteAccountSettingRequest$name' => '

The resource name for which to disable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.

', 'ListAccountSettingsRequest$name' => '

The resource name you want to list the account settings for.

', 'PutAccountSettingDefaultRequest$name' => '

The resource type to enable the new format for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks are affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances are affected.

', 'PutAccountSettingRequest$name' => '

The resource name for which to enable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.

', 'Setting$name' => '

The account resource name.

', ], ], 'Settings' => [ 'base' => NULL, 'refs' => [ 'ListAccountSettingsResponse$settings' => '

The account settings for the resource.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => '

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

', ], ], 'StabilityStatus' => [ 'base' => NULL, 'refs' => [ 'TaskSet$stabilityStatus' => '

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

If any of those conditions are not met, the stability status returns STABILIZING.

', ], ], 'StartTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistics' => [ 'base' => NULL, 'refs' => [ 'Cluster$statistics' => '

Additional information about your clusters that are separated by launch type, including:

', ], ], 'StopTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Attachment$id' => '

The unique identifier for the attachment.

', 'Attachment$type' => '

The type of the attachment, such as ElasticNetworkInterface.

', 'Attachment$status' => '

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED.

', 'AttachmentStateChange$attachmentArn' => '

The Amazon Resource Name (ARN) of the attachment.

', 'AttachmentStateChange$status' => '

The status of the attachment.

', 'Attribute$name' => '

The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.

', 'Attribute$value' => '

The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.

', 'Attribute$targetId' => '

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

', 'ClientException$message' => NULL, 'Cluster$clusterArn' => '

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test ..

', 'Cluster$clusterName' => '

A user-generated string that you use to identify your cluster.

', 'Cluster$status' => '

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

', 'Container$containerArn' => '

The Amazon Resource Name (ARN) of the container.

', 'Container$taskArn' => '

The ARN of the task.

', 'Container$name' => '

The name of the container.

', 'Container$lastStatus' => '

The last known status of the container.

', 'Container$reason' => '

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

', 'Container$cpu' => '

The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.

', 'Container$memory' => '

The hard limit (in MiB) of memory set for the container.

', 'Container$memoryReservation' => '

The soft limit (in MiB) of memory set for the container.

', 'ContainerDefinition$name' => '

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

', 'ContainerDefinition$image' => '

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

', 'ContainerDefinition$hostname' => '

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

', 'ContainerDefinition$user' => '

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$workingDirectory' => '

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

', 'ContainerInstance$containerInstanceArn' => '

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

', 'ContainerInstance$ec2InstanceId' => '

The EC2 instance ID of the container instance.

', 'ContainerInstance$status' => '

The status of the container instance. The valid values are ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.

', 'ContainerOverride$name' => '

The name of the container that receives the override. This parameter is required if any override is specified.

', 'ContainerStateChange$containerName' => '

The name of the container.

', 'ContainerStateChange$reason' => '

The reason for the state change.

', 'ContainerStateChange$status' => '

The status of the container.

', 'CreateClusterRequest$clusterName' => '

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

', 'CreateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

', 'CreateServiceRequest$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'CreateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

', 'CreateServiceRequest$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

', 'CreateServiceRequest$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'CreateServiceRequest$role' => '

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

', 'DeleteAccountSettingRequest$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.

', 'DeleteAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteClusterRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

', 'DeleteServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteServiceRequest$service' => '

The name of the service to delete.

', 'Deployment$id' => '

The ID of the deployment.

', 'Deployment$status' => '

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

', 'Deployment$taskDefinition' => '

The most recent task definition that was specified for the tasks in the service to use.

', 'Deployment$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'DeregisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

', 'DeregisterContainerInstanceRequest$containerInstance' => '

The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

', 'DeregisterTaskDefinitionRequest$taskDefinition' => '

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

', 'DescribeContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeTaskDefinitionRequest$taskDefinition' => '

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

', 'DescribeTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.

', 'Device$hostPath' => '

The path for the device on the host container instance.

', 'Device$containerPath' => '

The path inside the container at which to expose the host device.

', 'DiscoverPollEndpointRequest$containerInstance' => '

The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

', 'DiscoverPollEndpointRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.

', 'DiscoverPollEndpointResponse$endpoint' => '

The endpoint for the Amazon ECS agent to poll.

', 'DiscoverPollEndpointResponse$telemetryEndpoint' => '

The telemetry endpoint for the Amazon ECS agent.

', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'DockerVolumeConfiguration$driver' => '

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create .

', 'Failure$arn' => '

The Amazon Resource Name (ARN) of the failed resource.

', 'Failure$reason' => '

The reason for the failure.

', 'GpuIds$member' => NULL, 'HostEntry$hostname' => '

The hostname to use in the /etc/hosts entry.

', 'HostEntry$ipAddress' => '

The IP address to use in the /etc/hosts entry.

', 'HostVolumeProperties$sourcePath' => '

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

', 'KeyValuePair$name' => '

The name of the key-value pair. For environment variables, this is the name of the environment variable.

', 'KeyValuePair$value' => '

The value of the key-value pair. For environment variables, this is the value of the environment variable.

', 'ListAccountSettingsRequest$value' => '

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

', 'ListAccountSettingsRequest$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

', 'ListAccountSettingsRequest$nextToken' => '

The nextToken value returned from a previous paginated ListAccountSettings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAccountSettingsResponse$nextToken' => '

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

', 'ListAttributesRequest$attributeName' => '

The name of the attribute with which to filter the results.

', 'ListAttributesRequest$attributeValue' => '

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

', 'ListAttributesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAttributesResponse$nextToken' => '

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListClustersRequest$nextToken' => '

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListClustersResponse$nextToken' => '

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListContainerInstancesRequest$filter' => '

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListContainerInstancesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListContainerInstancesResponse$nextToken' => '

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListServicesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListServicesResponse$nextToken' => '

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'ListTaskDefinitionFamiliesRequest$familyPrefix' => '

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

', 'ListTaskDefinitionFamiliesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionFamiliesResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTaskDefinitionsRequest$familyPrefix' => '

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

', 'ListTaskDefinitionsRequest$nextToken' => '

The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionsResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListTasksRequest$containerInstance' => '

The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

', 'ListTasksRequest$family' => '

The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

', 'ListTasksRequest$nextToken' => '

The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTasksRequest$startedBy' => '

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

', 'ListTasksRequest$serviceName' => '

The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

', 'ListTasksResponse$nextToken' => '

The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'LoadBalancer$targetGroupArn' => '

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.

If your service\'s task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'LoadBalancer$loadBalancerName' => '

The name of a load balancer.

', 'LoadBalancer$containerName' => '

The name of the container (as it appears in a container definition) to associate with the load balancer.

', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'MountPoint$sourceVolume' => '

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

', 'MountPoint$containerPath' => '

The path on the container to mount the host volume at.

', 'NetworkBinding$bindIP' => '

The IP address that the container is bound to on the container instance.

', 'NetworkInterface$attachmentId' => '

The attachment ID for the network interface.

', 'NetworkInterface$privateIpv4Address' => '

The private IPv4 address for the network interface.

', 'NetworkInterface$ipv6Address' => '

The private IPv6 address for the network interface.

', 'PlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'PlacementStrategy$field' => '

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

', 'PlatformDevice$id' => '

The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

', 'PutAccountSettingDefaultRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

', 'PutAccountSettingRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

', 'PutAccountSettingRequest$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the settings are changed only for the authenticated user.

', 'PutAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => '

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

', 'RegisterContainerInstanceRequest$instanceIdentityDocumentSignature' => '

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

', 'RegisterContainerInstanceRequest$containerInstanceArn' => '

The ARN of the container instance (if it was previously registered).

', 'RegisterTaskDefinitionRequest$family' => '

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

', 'RegisterTaskDefinitionRequest$taskRoleArn' => '

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'RegisterTaskDefinitionRequest$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

', 'RegisterTaskDefinitionRequest$cpu' => '

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

', 'RegisterTaskDefinitionRequest$memory' => '

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

', 'RepositoryCredentials$credentialsParameter' => '

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.

', 'Resource$name' => '

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

', 'Resource$type' => '

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

', 'ResourceRequirement$value' => '

The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.

', 'RunTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

', 'RunTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

', 'RunTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'RunTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'RunTaskRequest$platformVersion' => '

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Secret$name' => '

The value to set as the environment variable on the container.

', 'Secret$valueFrom' => '

The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.

If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

', 'ServerException$message' => NULL, 'Service$serviceArn' => '

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service .

', 'Service$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'Service$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster that hosts the service.

', 'Service$status' => '

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

', 'Service$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Service$taskDefinition' => '

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$roleArn' => '

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

', 'Service$createdBy' => '

The principal that created the service.

', 'ServiceEvent$id' => '

The ID string of the event.

', 'ServiceEvent$message' => '

The event message.

', 'ServiceRegistry$registryArn' => '

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service.

', 'ServiceRegistry$containerName' => '

The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

', 'Setting$value' => '

The current account setting for the resource name. If enabled, then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled, then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.

', 'Setting$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

', 'StartTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

', 'StartTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

', 'StartTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'StartTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'StopTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

', 'StopTaskRequest$task' => '

The task ID or full ARN entry of the task to stop.

', 'StopTaskRequest$reason' => '

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitContainerStateChangeRequest$cluster' => '

The short name or full ARN of the cluster that hosts the container.

', 'SubmitContainerStateChangeRequest$task' => '

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

', 'SubmitContainerStateChangeRequest$containerName' => '

The name of the container.

', 'SubmitContainerStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitContainerStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitContainerStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SubmitTaskStateChangeRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

', 'SubmitTaskStateChangeRequest$task' => '

The task ID or full ARN of the task in the state change request.

', 'SubmitTaskStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitTaskStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitTaskStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SystemControl$namespace' => '

The namespaced kernel parameter for which to set a value.

', 'SystemControl$value' => '

The value for the namespaced kernel parameter specified in namespace.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'Task$taskArn' => '

The Amazon Resource Name (ARN) of the task.

', 'Task$clusterArn' => '

The ARN of the cluster that hosts the task.

', 'Task$taskDefinitionArn' => '

The ARN of the task definition that creates the task.

', 'Task$containerInstanceArn' => '

The ARN of the container instances that host the task.

', 'Task$lastStatus' => '

The last known status of the task. For more information, see Task Lifecycle.

', 'Task$desiredStatus' => '

The desired status of the task. For more information, see Task Lifecycle.

', 'Task$cpu' => '

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

', 'Task$memory' => '

The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.

If you are using the EC2 launch type, this field is optional.

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

', 'Task$startedBy' => '

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'Task$stoppedReason' => '

The reason that the task was stopped.

', 'Task$group' => '

The name of the task group associated with the task.

', 'Task$platformVersion' => '

The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$taskDefinitionArn' => '

The full Amazon Resource Name (ARN) of the task definition.

', 'TaskDefinition$family' => '

The family of your task definition, used as the definition name.

', 'TaskDefinition$taskRoleArn' => '

The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

', 'TaskDefinition$cpu' => '

The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

', 'TaskDefinition$memory' => '

The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

', 'TaskDefinitionPlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'TaskOverride$taskRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

', 'TaskOverride$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

', 'TaskSet$id' => '

The ID of the task set.

', 'TaskSet$taskSetArn' => '

The Amazon Resource Name (ARN) of the task set.

', 'TaskSet$startedBy' => '

The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY.

', 'TaskSet$externalId' => '

The deployment ID of the AWS CodeDeploy deployment.

', 'TaskSet$status' => '

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

', 'TaskSet$taskDefinition' => '

The task definition the task set is using.

', 'TaskSet$platformVersion' => '

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Tmpfs$containerPath' => '

The absolute file path where the tmpfs volume is to be mounted.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'UpdateContainerAgentRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateContainerAgentRequest$containerInstance' => '

The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.

', 'UpdateContainerInstancesStateRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServiceRequest$service' => '

The name of the service to update.

', 'UpdateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

', 'UpdateServiceRequest$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'VersionInfo$agentVersion' => '

The version number of the Amazon ECS container agent.

', 'VersionInfo$agentHash' => '

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

', 'VersionInfo$dockerVersion' => '

The Docker version running on the container instance.

', 'Volume$name' => '

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

', 'VolumeFrom$sourceContainer' => '

The name of another container within the same task definition from which to mount volumes.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$subnets' => '

The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

', 'AwsVpcConfiguration$securityGroups' => '

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

', 'ContainerDefinition$links' => '

The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run .

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

', 'ContainerDefinition$entryPoint' => '

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

', 'ContainerDefinition$command' => '

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

', 'ContainerDefinition$dnsServers' => '

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dnsSearchDomains' => '

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dockerSecurityOptions' => '

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers.

', 'ContainerOverride$command' => '

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

', 'DescribeClustersRequest$clusters' => '

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeContainerInstancesRequest$containerInstances' => '

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

', 'DescribeServicesRequest$services' => '

A list of services to describe. You may specify up to 10 services to describe in a single operation.

', 'DescribeTasksRequest$tasks' => '

A list of up to 100 task IDs or full ARN entries.

', 'HealthCheck$command' => '

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container\'s default shell. For example:

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

', 'KernelCapabilities$add' => '

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

If you are using tasks that use the Fargate launch type, the add parameter is not supported.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'KernelCapabilities$drop' => '

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'ListClustersResponse$clusterArns' => '

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

', 'ListContainerInstancesResponse$containerInstanceArns' => '

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

', 'ListServicesResponse$serviceArns' => '

The list of full ARN entries for each service associated with the specified cluster.

', 'ListTaskDefinitionFamiliesResponse$families' => '

The list of task definition family names that match the ListTaskDefinitionFamilies request.

', 'ListTaskDefinitionsResponse$taskDefinitionArns' => '

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

', 'ListTasksResponse$taskArns' => '

The list of task ARN entries for the ListTasks request.

', 'Resource$stringSetValue' => '

When the stringSetValue type is set, the value of the resource must be a string type.

', 'StartTaskRequest$containerInstances' => '

The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

', 'Tmpfs$mountOptions' => '

The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

', 'UpdateContainerInstancesStateRequest$containerInstances' => '

A list of container instance IDs or full ARN entries.

', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$driverOpts' => '

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create .

', 'DockerVolumeConfiguration$labels' => '

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create .

', ], ], 'SubmitContainerStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SystemControl' => [ 'base' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:

', 'refs' => [ 'SystemControls$member' => NULL, ], ], 'SystemControls' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$systemControls' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance\'s namespaced kernel parameters as well as the containers.

', ], ], 'Tag' => [ 'base' => '

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The keys of the tags to be removed.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'Cluster$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'ContainerInstance$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'CreateClusterRequest$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'CreateServiceRequest$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'DescribeTaskDefinitionResponse$tags' => '

The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'ListTagsForResourceResponse$tags' => '

The tags for the resource.

', 'RegisterContainerInstanceRequest$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'RegisterTaskDefinitionRequest$tags' => '

The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'RegisterTaskDefinitionResponse$tags' => '

The list of tags associated with the task definition.

', 'RunTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'Service$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'StartTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'TagResourceRequest$tags' => '

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'Task$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', ], ], 'TargetNotFoundException' => [ 'base' => '

The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

', 'refs' => [], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Attribute$targetType' => '

The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.

', 'ListAttributesRequest$targetType' => '

The type of the target with which to list attributes.

', ], ], 'Task' => [ 'base' => '

Details on a task in a cluster.

', 'refs' => [ 'StopTaskResponse$task' => '

The task that was stopped.

', 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => '

Details of a task definition.

', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => '

The full description of the deregistered task.

', 'DescribeTaskDefinitionResponse$taskDefinition' => '

The full task definition description.

', 'RegisterTaskDefinitionResponse$taskDefinition' => '

The full description of the registered task definition.

', ], ], 'TaskDefinitionFamilyStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionFamiliesRequest$status' => '

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', ], ], 'TaskDefinitionField' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionFieldList$member' => NULL, ], ], 'TaskDefinitionFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskDefinitionRequest$include' => '

Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'TaskDefinitionPlacementConstraint' => [ 'base' => '

An object representing a constraint on task placement in the task definition.

If you are using the Fargate launch type, task placement constraints are not supported.

For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'TaskDefinitionPlacementConstraints$member' => NULL, ], ], 'TaskDefinitionPlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionPlacementConstraint$type' => '

The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.

', ], ], 'TaskDefinitionPlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

', 'TaskDefinition$placementConstraints' => '

An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.

', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => '

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', 'TaskDefinition$status' => '

The status of the task definition.

', ], ], 'TaskField' => [ 'base' => NULL, 'refs' => [ 'TaskFieldList$member' => NULL, ], ], 'TaskFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksRequest$include' => '

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'TaskOverride' => [ 'base' => '

The overrides associated with a task.

', 'refs' => [ 'RunTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'StartTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'Task$overrides' => '

One or more container overrides.

', ], ], 'TaskSet' => [ 'base' => '

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', 'refs' => [ 'TaskSets$member' => NULL, ], ], 'TaskSets' => [ 'base' => NULL, 'refs' => [ 'Service$taskSets' => '

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', ], ], 'TaskStopCode' => [ 'base' => NULL, 'refs' => [ 'Task$stopCode' => '

The stop code indicating why a task was stopped. The stoppedReason may contain additional details.

', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => '

The list of tasks.

', 'RunTaskResponse$tasks' => '

A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.

', 'StartTaskResponse$tasks' => '

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$registeredAt' => '

The Unix timestamp for when the container instance was registered.

', 'Deployment$createdAt' => '

The Unix timestamp for when the service deployment was created.

', 'Deployment$updatedAt' => '

The Unix timestamp for when the service deployment was last updated.

', 'Service$createdAt' => '

The Unix timestamp for when the service was created.

', 'ServiceEvent$createdAt' => '

The Unix timestamp for when the event was triggered.

', 'SubmitTaskStateChangeRequest$pullStartedAt' => '

The Unix timestamp for when the container image pull began.

', 'SubmitTaskStateChangeRequest$pullStoppedAt' => '

The Unix timestamp for when the container image pull completed.

', 'SubmitTaskStateChangeRequest$executionStoppedAt' => '

The Unix timestamp for when the task execution stopped.

', 'Task$connectivityAt' => '

The Unix timestamp for when the task last went into CONNECTED status.

', 'Task$pullStartedAt' => '

The Unix timestamp for when the container image pull began.

', 'Task$pullStoppedAt' => '

The Unix timestamp for when the container image pull completed.

', 'Task$executionStoppedAt' => '

The Unix timestamp for when the task execution stopped.

', 'Task$createdAt' => '

The Unix timestamp for when the task was created (the task entered the PENDING state).

', 'Task$startedAt' => '

The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).

', 'Task$stoppingAt' => '

The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).

', 'Task$stoppedAt' => '

The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

', 'TaskSet$createdAt' => '

The Unix timestamp for when the task set was created.

', 'TaskSet$updatedAt' => '

The Unix timestamp for when the task set was last updated.

', 'TaskSet$stabilityStatusAt' => '

The Unix timestamp for when the task set stability status was retrieved.

', ], ], 'Tmpfs' => [ 'base' => '

The container path, mount options, and size of the tmpfs mount.

', 'refs' => [ 'TmpfsList$member' => NULL, ], ], 'TmpfsList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$tmpfs' => '

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

', ], ], 'TransportProtocol' => [ 'base' => NULL, 'refs' => [ 'NetworkBinding$protocol' => '

The protocol used for the network binding.

', 'PortMapping$protocol' => '

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

', ], ], 'Ulimit' => [ 'base' => '

The ulimit settings to pass to the container.

', 'refs' => [ 'UlimitList$member' => NULL, ], ], 'UlimitList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ulimits' => '

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

This parameter is not supported for Windows containers.

', ], ], 'UlimitName' => [ 'base' => NULL, 'refs' => [ 'Ulimit$name' => '

The type of the ulimit.

', ], ], 'UnsupportedFeatureException' => [ 'base' => '

The specified task is not supported in this Region.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInProgressException' => [ 'base' => '

There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

', 'refs' => [], ], 'UpdateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'VersionInfo' => [ 'base' => '

The Docker and Amazon ECS container agent version information about a container instance.

', 'refs' => [ 'ContainerInstance$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

', 'RegisterContainerInstanceRequest$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

', ], ], 'Volume' => [ 'base' => '

A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => '

Details on a data volume from another container in the same task definition.

', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => '

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

', ], ], 'VolumeList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$volumes' => '

A list of volume definitions in JSON format that containers in your task may use.

', 'TaskDefinition$volumes' => '

The list of volumes in a task.

If you are using the Fargate launch type, the host and sourcePath parameters are not supported.

For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

', 'operations' => [ 'CreateCluster' => '

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'CreateService' => '

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.

If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the CODE_DEPLOY deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values are not used, although they are currently visible when describing your service.

Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:

', 'DeleteAccountSetting' => '

Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.

', 'DeleteAttributes' => '

Deletes one or more custom attributes from an Amazon ECS resource.

', 'DeleteCluster' => '

Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

', 'DeleteService' => '

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

', 'DeregisterContainerInstance' => '

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

', 'DeregisterTaskDefinition' => '

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service\'s desired count.

You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

', 'DescribeClusters' => '

Describes one or more of your clusters.

', 'DescribeContainerInstances' => '

Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

', 'DescribeServices' => '

Describes the specified services running in your cluster.

', 'DescribeTaskDefinition' => '

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

', 'DescribeTasks' => '

Describes a specified task or tasks.

', 'DiscoverPollEndpoint' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

', 'ListAccountSettings' => '

Lists the account settings for an Amazon ECS resource for a specified principal.

', 'ListAttributes' => '

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

', 'ListClusters' => '

Returns a list of existing clusters.

', 'ListContainerInstances' => '

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListServices' => '

Lists the services that are running in a specified cluster.

', 'ListTagsForResource' => '

List the tags for an Amazon ECS resource.

', 'ListTaskDefinitionFamilies' => '

Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

', 'ListTaskDefinitions' => '

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

', 'ListTasks' => '

Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.

Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

', 'PutAccountSetting' => '

Modifies the ARN and resource ID format of a resource type for a specified IAM user, IAM role, or the root user for an account. If the account setting for the root user is changed, it sets the default setting for all of the IAM users and roles for which no individual account setting has been set. The opt-in and opt-out account setting can be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. Enabling this setting is required to use new Amazon ECS features such as resource tagging. For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon Elastic Container Service Developer Guide.

', 'PutAccountSettingDefault' => '

Modifies the ARN and resource ID format of a resource type for all IAM users on an account for which no individual account setting has been set. Enabling this setting is required to use new Amazon ECS features such as resource tagging.

', 'PutAttributes' => '

Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'RegisterContainerInstance' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

', 'RegisterTaskDefinition' => '

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'RunTask' => '

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

', 'StartTask' => '

Starts a new task from the specified task definition on the specified container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

', 'StopTask' => '

Stops a running task. Any tags associated with the task will be deleted.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', 'SubmitContainerStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

', 'SubmitTaskStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

', 'TagResource' => '

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

', 'UntagResource' => '

Deletes specified tags from a resource.

', 'UpdateContainerAgent' => '

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide.

', 'UpdateContainerInstancesState' => '

Modifies the status of an Amazon ECS container instance.

You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service\'s deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

', 'UpdateService' => '

Modifies the parameters of a service.

For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service\'s deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

You do not have authorization to perform the requested action.

', 'refs' => [], ], 'AgentUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentUpdateStatus' => '

The status of the most recent agent update. If an update has never been requested, this value is NULL.

', ], ], 'AssignPublicIp' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$assignPublicIp' => '

Whether the task\'s elastic network interface receives a public IP address. The default value is DISABLED.

', ], ], 'Attachment' => [ 'base' => '

An object representing a container instance or task attachment.

', 'refs' => [ 'Attachments$member' => NULL, ], ], 'AttachmentDetails' => [ 'base' => NULL, 'refs' => [ 'Attachment$details' => '

Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

', ], ], 'AttachmentStateChange' => [ 'base' => '

An object representing a change in state for a task attachment.

', 'refs' => [ 'AttachmentStateChanges$member' => NULL, ], ], 'AttachmentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$attachments' => '

Any attachments associated with the state change request.

', ], ], 'Attachments' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attachments' => '

The elastic network interfaces associated with the container instance.

', 'Task$attachments' => '

The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.

', ], ], 'Attribute' => [ 'base' => '

An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'AttributeLimitExceededException' => [ 'base' => '

You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

', 'refs' => [], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => '

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

', 'DeleteAttributesRequest$attributes' => '

The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.

', 'DeleteAttributesResponse$attributes' => '

A list of attribute objects that were successfully deleted from your resource.

', 'ListAttributesResponse$attributes' => '

A list of attribute objects that meet the criteria of the request.

', 'PutAttributesRequest$attributes' => '

The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.

', 'PutAttributesResponse$attributes' => '

The attributes applied to your resource.

', 'RegisterContainerInstanceRequest$attributes' => '

The container instance attributes that this container instance supports.

', ], ], 'AwsVpcConfiguration' => [ 'base' => '

An object representing the networking details for a task or service.

', 'refs' => [ 'NetworkConfiguration$awsvpcConfiguration' => '

The VPC subnets and security groups associated with a task.

All specified subnets and security groups must be from the same VPC.

', ], ], 'BlockedException' => [ 'base' => '

Your AWS account has been blocked. For more information, contact AWS Support.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => '

This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests.

', 'CreateServiceRequest$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'ListAccountSettingsRequest$effectiveSettings' => '

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

', 'RunTaskRequest$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'Service$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'StartTaskRequest$enableECSManagedTags' => '

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'UpdateServiceRequest$forceNewDeployment' => '

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service\'s tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$essential' => '

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

', 'ContainerDefinition$disableNetworking' => '

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$privileged' => '

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', 'ContainerDefinition$readonlyRootFilesystem' => '

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$interactive' => '

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

', 'ContainerDefinition$pseudoTerminal' => '

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

', 'DeleteServiceRequest$force' => '

If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.

', 'DeregisterContainerInstanceRequest$force' => '

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

', 'DockerVolumeConfiguration$autoprovision' => '

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

', 'LinuxParameters$initProcessEnabled' => '

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', 'MountPoint$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', 'VolumeFrom$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', ], ], 'BoxedInteger' => [ 'base' => NULL, 'refs' => [ 'Container$exitCode' => '

The exit code returned from the container.

', 'ContainerDefinition$memory' => '

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.

For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

', 'ContainerDefinition$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

', 'ContainerDefinition$startTimeout' => '

Time duration to wait before giving up on starting the container.

The startTimeout value for the container will take precedence over the ECS_CONTAINER_START_TIMEOUT container agent configuration parameter, if used.

', 'ContainerDefinition$stopTimeout' => '

Time duration to wait before the container is forcefully killed if it does not exit normally on its own.

The stopTimeout value for the container will take precedence over the ECS_CONTAINER_STOP_TIMEOUT container agent configuration parameter, if used.

', 'ContainerOverride$cpu' => '

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerOverride$memory' => '

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

', 'ContainerOverride$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerStateChange$exitCode' => '

The exit code for the container, if the state change is a result of the container exiting.

', 'CreateServiceRequest$desiredCount' => '

The number of instantiations of the specified task definition to place and keep running on your cluster.

', 'CreateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', 'DeploymentConfiguration$maximumPercent' => '

If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

', 'DeploymentConfiguration$minimumHealthyPercent' => '

If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

', 'HealthCheck$interval' => '

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

', 'HealthCheck$timeout' => '

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

', 'HealthCheck$retries' => '

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

', 'HealthCheck$startPeriod' => '

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

', 'LinuxParameters$sharedMemorySize' => '

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

', 'ListAttributesRequest$maxResults' => '

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

', 'ListClustersRequest$maxResults' => '

The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.

', 'ListContainerInstancesRequest$maxResults' => '

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

', 'ListServicesRequest$maxResults' => '

The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.

', 'ListTaskDefinitionFamiliesRequest$maxResults' => '

The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

', 'ListTaskDefinitionsRequest$maxResults' => '

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

', 'ListTasksRequest$maxResults' => '

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

', 'LoadBalancer$containerPort' => '

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service\'s task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

', 'NetworkBinding$containerPort' => '

The port number on the container that is used with the network binding.

', 'NetworkBinding$hostPort' => '

The port number on the host that is used with the network binding.

', 'PortMapping$containerPort' => '

The port number on the container that is bound to the user-specified or automatically assigned host port.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.

If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

', 'PortMapping$hostPort' => '

The port number on the container instance to reserve for your container.

If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don\'t count toward the 100 reserved ports limit.

', 'RunTaskRequest$count' => '

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

', 'Service$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

', 'ServiceRegistry$port' => '

The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.

', 'ServiceRegistry$containerPort' => '

The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

', 'SubmitContainerStateChangeRequest$exitCode' => '

The exit code returned for the state change request.

', 'UpdateServiceRequest$desiredCount' => '

The number of instantiations of the task to place and keep running in your service.

', 'UpdateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', ], ], 'ClientException' => [ 'base' => '

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn\'t have permissions to use the action or resource, or specifying an identifier that is not valid.

', 'refs' => [], ], 'Cluster' => [ 'base' => '

A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => '

The full description of your new cluster.

', 'DeleteClusterResponse$cluster' => '

The full description of the deleted cluster.

', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => '

You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

', 'refs' => [], ], 'ClusterContainsServicesException' => [ 'base' => '

You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

', 'refs' => [], ], 'ClusterContainsTasksException' => [ 'base' => '

You cannot delete a cluster that has active tasks.

', 'refs' => [], ], 'ClusterField' => [ 'base' => NULL, 'refs' => [ 'ClusterFieldList$member' => NULL, ], ], 'ClusterFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$include' => '

Additional information about your clusters to be separated by launch type, including:

', ], ], 'ClusterNotFoundException' => [ 'base' => '

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

', 'refs' => [], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => '

The list of clusters.

', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CompatibilityList$member' => NULL, ], ], 'CompatibilityList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$requiresCompatibilities' => '

The launch type required by the task. If no value is specified, it defaults to EC2.

', 'TaskDefinition$compatibilities' => '

The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$requiresCompatibilities' => '

The launch type that the task is using.

', ], ], 'Connectivity' => [ 'base' => NULL, 'refs' => [ 'Task$connectivity' => '

The connectivity status of a task.

', ], ], 'Container' => [ 'base' => '

A Docker container that is part of a task.

', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerCondition' => [ 'base' => NULL, 'refs' => [ 'ContainerDependency$condition' => '

The dependency condition of the container. The following are the available conditions and their behavior:

', ], ], 'ContainerDefinition' => [ 'base' => '

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task.

', 'TaskDefinition$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ContainerDependencies' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$dependsOn' => '

The dependencies defined for container startup. A container can contain multiple dependencies.

', ], ], 'ContainerDependency' => [ 'base' => '

The dependencies defined for container startup. A container can contain multiple dependencies.

', 'refs' => [ 'ContainerDependencies$member' => NULL, ], ], 'ContainerInstance' => [ 'base' => '

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => '

The container instance that was deregistered.

', 'RegisterContainerInstanceResponse$containerInstance' => '

The container instance that was registered.

', 'UpdateContainerAgentResponse$containerInstance' => '

The container instance for which the container agent was updated.

', ], ], 'ContainerInstanceField' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceFieldList$member' => NULL, ], ], 'ContainerInstanceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesRequest$include' => '

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'ContainerInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ListContainerInstancesRequest$status' => '

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING.

', 'UpdateContainerInstancesStateRequest$status' => '

The container instance state with which to update the container instance.

', ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => '

The list of container instances.

', 'UpdateContainerInstancesStateResponse$containerInstances' => '

The list of container instances.

', ], ], 'ContainerOverride' => [ 'base' => '

The overrides that should be sent to a container.

', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => '

One or more container overrides sent to a task.

', ], ], 'ContainerStateChange' => [ 'base' => '

An object representing a change in state for a container.

', 'refs' => [ 'ContainerStateChanges$member' => NULL, ], ], 'ContainerStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$containers' => '

Any containers associated with the state change request.

', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => '

The containers associated with the task.

', ], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => '

The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.

', 'refs' => [ 'Deployments$member' => NULL, ], ], 'DeploymentConfiguration' => [ 'base' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'refs' => [ 'CreateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'Service$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'UpdateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', ], ], 'DeploymentController' => [ 'base' => '

The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateServiceRequest$deploymentController' => '

The deployment controller to use for the service.

', 'Service$deploymentController' => '

The deployment controller type the service is using.

', ], ], 'DeploymentControllerType' => [ 'base' => NULL, 'refs' => [ 'DeploymentController$type' => '

The deployment controller type to use.

There are two deployment controller types available:

ECS

The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

CODE_DEPLOY

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'Service$deployments' => '

The current state of deployments for the service.

', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => '

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task\'s lastStatus may have a value of PENDING).

', ], ], 'Device' => [ 'base' => '

An object representing a container instance host device.

', 'refs' => [ 'DevicesList$member' => NULL, ], ], 'DeviceCgroupPermission' => [ 'base' => NULL, 'refs' => [ 'DeviceCgroupPermissions$member' => NULL, ], ], 'DeviceCgroupPermissions' => [ 'base' => NULL, 'refs' => [ 'Device$permissions' => '

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

', ], ], 'DevicesList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$devices' => '

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you are using tasks that use the Fargate launch type, the devices parameter is not supported.

', ], ], 'DiscoverPollEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscoverPollEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerLabelsMap' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$dockerLabels' => '

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'DockerVolumeConfiguration' => [ 'base' => '

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

', 'refs' => [ 'Volume$dockerVolumeConfiguration' => '

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'Resource$doubleValue' => '

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

', 'Scale$value' => '

The value, specified as a percent total of a service\'s desiredCount, to scale the task set.

', ], ], 'EnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$environment' => '

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

', 'ContainerOverride$environment' => '

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

', ], ], 'Failure' => [ 'base' => '

A failed resource.

', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$failures' => '

Any failures associated with the call.

', 'DescribeContainerInstancesResponse$failures' => '

Any failures associated with the call.

', 'DescribeServicesResponse$failures' => '

Any failures associated with the call.

', 'DescribeTasksResponse$failures' => '

Any failures associated with the call.

', 'RunTaskResponse$failures' => '

Any failures associated with the call.

', 'StartTaskResponse$failures' => '

Any failures associated with the call.

', 'UpdateContainerInstancesStateResponse$failures' => '

Any failures associated with the call.

', ], ], 'GpuIds' => [ 'base' => NULL, 'refs' => [ 'Container$gpuIds' => '

The IDs of each GPU assigned to the container.

', ], ], 'HealthCheck' => [ 'base' => '

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image\'s Dockerfile).

The following are notes about container health check support:

', 'refs' => [ 'ContainerDefinition$healthCheck' => '

The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

', ], ], 'HealthStatus' => [ 'base' => NULL, 'refs' => [ 'Container$healthStatus' => '

The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN.

', 'Task$healthStatus' => '

The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.

The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image\'s Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

', ], ], 'HostEntry' => [ 'base' => '

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

', 'refs' => [ 'HostEntryList$member' => NULL, ], ], 'HostEntryList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$extraHosts' => '

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

', ], ], 'HostVolumeProperties' => [ 'base' => '

Details on a container instance bind mount host volume.

', 'refs' => [ 'Volume$host' => '

This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => '

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

', 'Cluster$runningTasksCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Cluster$pendingTasksCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'Cluster$activeServicesCount' => '

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

', 'ContainerDefinition$cpu' => '

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.

', 'ContainerInstance$runningTasksCount' => '

The number of tasks on the container instance that are in the RUNNING status.

', 'ContainerInstance$pendingTasksCount' => '

The number of tasks on the container instance that are in the PENDING status.

', 'Deployment$desiredCount' => '

The most recent desired count of tasks that was specified for the service to deploy or maintain.

', 'Deployment$pendingCount' => '

The number of tasks in the deployment that are in the PENDING status.

', 'Deployment$runningCount' => '

The number of tasks in the deployment that are in the RUNNING status.

', 'ListAccountSettingsRequest$maxResults' => '

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

', 'Resource$integerValue' => '

When the integerValue type is set, the value of the resource must be an integer.

', 'Service$desiredCount' => '

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$runningCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Service$pendingCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'TaskDefinition$revision' => '

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.

', 'TaskSet$computedDesiredCount' => '

The computed desired count for the task set. This is calculated by multiplying the service\'s desiredCount by the task set\'s scale percentage.

', 'TaskSet$pendingCount' => '

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

', 'TaskSet$runningCount' => '

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

', 'Tmpfs$size' => '

The size (in MiB) of the tmpfs volume.

', 'Ulimit$softLimit' => '

The soft limit for the ulimit type.

', 'Ulimit$hardLimit' => '

The hard limit for the ulimit type.

', ], ], 'InvalidParameterException' => [ 'base' => '

The specified parameter is invalid. Review the available parameters for the API request.

', 'refs' => [], ], 'IpcMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', 'TaskDefinition$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', ], ], 'KernelCapabilities' => [ 'base' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.

', 'refs' => [ 'LinuxParameters$capabilities' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.

', ], ], 'KeyValuePair' => [ 'base' => '

A key-value pair object.

', 'refs' => [ 'AttachmentDetails$member' => NULL, 'EnvironmentVariables$member' => NULL, 'ProxyConfigurationProperties$member' => NULL, 'Statistics$member' => NULL, ], ], 'LaunchType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$launchType' => '

The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$launchType' => '

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'ListServicesRequest$launchType' => '

The launch type for the services to list.

', 'ListTasksRequest$launchType' => '

The launch type for services to list.

', 'RunTaskRequest$launchType' => '

The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'Service$launchType' => '

The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'Task$launchType' => '

The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$launchType' => '

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', ], ], 'LinuxParameters' => [ 'base' => '

Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

', 'refs' => [ 'ContainerDefinition$linuxParameters' => '

Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.

This parameter is not supported for Windows containers.

', ], ], 'ListAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadBalancer' => [ 'base' => '

Details on a load balancer that is used with a service.

If the service is using the ECS deployment controller, you are limited to one load balancer or target group.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => '

A load balancer object representing the load balancer to use with your service.

If the service is using the ECS deployment controller, you are limited to one load balancer or target group.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'Service$loadBalancers' => '

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'TaskSet$loadBalancers' => '

Details on a load balancer that is used with a task set.

', ], ], 'LogConfiguration' => [ 'base' => '

Log configuration options to send to a custom log driver for the container.

', 'refs' => [ 'ContainerDefinition$logConfiguration' => '

The log configuration specification for the container.

If you are using the Fargate launch type, the only supported value is awslogs.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', ], ], 'LogConfigurationOptionsMap' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$options' => '

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'LogDriver' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$logDriver' => '

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs. For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$version' => '

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

', 'Resource$longValue' => '

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

', 'Task$version' => '

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

', ], ], 'MissingVersionException' => [ 'base' => '

Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.

', 'refs' => [], ], 'MountPoint' => [ 'base' => '

Details on a volume mount point that is used in a container definition.

', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => '

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

', ], ], 'NetworkBinding' => [ 'base' => '

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'NetworkBindings$member' => NULL, ], ], 'NetworkBindings' => [ 'base' => NULL, 'refs' => [ 'Container$networkBindings' => '

The network bindings associated with the container.

', 'ContainerStateChange$networkBindings' => '

Any network bindings associated with the container.

', 'SubmitContainerStateChangeRequest$networkBindings' => '

The network bindings of the container.

', ], ], 'NetworkConfiguration' => [ 'base' => '

An object representing the network configuration for a task or service.

', 'refs' => [ 'CreateServiceRequest$networkConfiguration' => '

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'RunTaskRequest$networkConfiguration' => '

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'Service$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'StartTaskRequest$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'TaskSet$networkConfiguration' => '

The network configuration for the task set.

', 'UpdateServiceRequest$networkConfiguration' => '

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.

', ], ], 'NetworkInterface' => [ 'base' => '

An object representing the elastic network interface for tasks that use the awsvpc network mode.

', 'refs' => [ 'NetworkInterfaces$member' => NULL, ], ], 'NetworkInterfaces' => [ 'base' => NULL, 'refs' => [ 'Container$networkInterfaces' => '

The network interfaces associated with the container.

', ], ], 'NetworkMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

', 'TaskDefinition$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

', ], ], 'NoUpdateAvailableException' => [ 'base' => '

There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.

', 'refs' => [], ], 'PidMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', 'TaskDefinition$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

', ], ], 'PlacementConstraint' => [ 'base' => '

An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'PlacementConstraints$member' => NULL, ], ], 'PlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'PlacementConstraint$type' => '

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.

', ], ], 'PlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementConstraints' => '

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

', 'RunTaskRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

', 'Service$placementConstraints' => '

The placement constraints for the tasks in the service.

', ], ], 'PlacementStrategies' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementStrategy' => '

The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.

', 'RunTaskRequest$placementStrategy' => '

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

', 'Service$placementStrategy' => '

The placement strategy that determines how tasks for the service are placed.

', ], ], 'PlacementStrategy' => [ 'base' => '

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'PlacementStrategies$member' => NULL, ], ], 'PlacementStrategyType' => [ 'base' => NULL, 'refs' => [ 'PlacementStrategy$type' => '

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

', ], ], 'PlatformDevice' => [ 'base' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', 'refs' => [ 'PlatformDevices$member' => NULL, ], ], 'PlatformDeviceType' => [ 'base' => NULL, 'refs' => [ 'PlatformDevice$type' => '

The type of device that is available on the container instance. The only supported value is GPU.

', ], ], 'PlatformDevices' => [ 'base' => NULL, 'refs' => [ 'RegisterContainerInstanceRequest$platformDevices' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'base' => '

The specified platform version does not satisfy the task definition\'s required capabilities.

', 'refs' => [], ], 'PlatformUnknownException' => [ 'base' => '

The specified platform version does not exist.

', 'refs' => [], ], 'PortMapping' => [ 'base' => '

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'PortMappingList$member' => NULL, ], ], 'PortMappingList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$portMappings' => '

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container\'s mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can\'t specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

', ], ], 'PropagateTags' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

', 'RunTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

', 'Service$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

', 'StartTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

', ], ], 'ProxyConfiguration' => [ 'base' => '

The configuration details for the App Mesh proxy.

', 'refs' => [ 'RegisterTaskDefinitionRequest$proxyConfiguration' => NULL, 'TaskDefinition$proxyConfiguration' => '

', ], ], 'ProxyConfigurationProperties' => [ 'base' => NULL, 'refs' => [ 'ProxyConfiguration$properties' => '

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

', ], ], 'ProxyConfigurationType' => [ 'base' => NULL, 'refs' => [ 'ProxyConfiguration$type' => '

The proxy type. The only supported value is APPMESH.

', ], ], 'PutAccountSettingDefaultRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingDefaultResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryCredentials' => [ 'base' => '

The repository credentials for private registry authentication.

', 'refs' => [ 'ContainerDefinition$repositoryCredentials' => '

The private repository authentication credentials to use.

', ], ], 'RequiresAttributes' => [ 'base' => NULL, 'refs' => [ 'TaskDefinition$requiresAttributes' => '

The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.

', ], ], 'Resource' => [ 'base' => '

Describes the resources available for a container instance.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource could not be found.

', 'refs' => [], ], 'ResourceRequirement' => [ 'base' => '

The type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS in the Amazon Elastic Container Service Developer Guide

', 'refs' => [ 'ResourceRequirements$member' => NULL, ], ], 'ResourceRequirements' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$resourceRequirements' => '

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

', 'ContainerOverride$resourceRequirements' => '

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceRequirement$type' => '

The type of resource to assign to a container. The only supported value is GPU.

', ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => '

For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.

', 'ContainerInstance$registeredResources' => '

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

', 'RegisterContainerInstanceRequest$totalResources' => '

The resources available on the instance.

', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Scale' => [ 'base' => '

A floating-point percentage of the desired number of tasks to place and keep running in the service. This is used when a service uses the CODE_DEPLOY deployment controller type.

', 'refs' => [ 'TaskSet$scale' => '

A floating-point percentage of the desired number of tasks to place and keep running in the service.

', ], ], 'ScaleUnit' => [ 'base' => NULL, 'refs' => [ 'Scale$unit' => '

The unit of measure for the scale value.

', ], ], 'SchedulingStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

', 'ListServicesRequest$schedulingStrategy' => '

The scheduling strategy for services to list.

', 'Service$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$scope' => '

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

', ], ], 'Secret' => [ 'base' => '

An object representing the secret to expose to your container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'SecretList$member' => NULL, ], ], 'SecretList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$secrets' => '

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ServerException' => [ 'base' => '

These errors are usually caused by a server issue.

', 'refs' => [], ], 'Service' => [ 'base' => '

Details on a service within a cluster

', 'refs' => [ 'CreateServiceResponse$service' => '

The full description of your service following the create call.

If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

', 'DeleteServiceResponse$service' => '

The full description of the deleted service.

', 'Services$member' => NULL, 'UpdateServiceResponse$service' => '

The full description of your service following the update call.

', ], ], 'ServiceEvent' => [ 'base' => '

Details on an event associated with a service.

', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => '

The event stream for your service. A maximum of 100 of the latest events are displayed.

', ], ], 'ServiceField' => [ 'base' => NULL, 'refs' => [ 'ServiceFieldList$member' => NULL, ], ], 'ServiceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesRequest$include' => '

Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'ServiceNotActiveException' => [ 'base' => '

The specified service is not active. You can\'t update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

', 'refs' => [], ], 'ServiceNotFoundException' => [ 'base' => '

The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

', 'refs' => [], ], 'ServiceRegistries' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$serviceRegistries' => '

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

', 'Service$serviceRegistries' => '

', ], ], 'ServiceRegistry' => [ 'base' => '

Details of the service registry.

', 'refs' => [ 'ServiceRegistries$member' => NULL, ], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => '

The list of services described.

', ], ], 'Setting' => [ 'base' => '

The current account setting for a resource.

', 'refs' => [ 'DeleteAccountSettingResponse$setting' => '

The account setting for the specified principal ARN.

', 'PutAccountSettingDefaultResponse$setting' => NULL, 'PutAccountSettingResponse$setting' => '

The current account setting for a resource.

', 'Settings$member' => NULL, ], ], 'SettingName' => [ 'base' => NULL, 'refs' => [ 'DeleteAccountSettingRequest$name' => '

The resource name for which to disable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.

', 'ListAccountSettingsRequest$name' => '

The resource name you want to list the account settings for.

', 'PutAccountSettingDefaultRequest$name' => '

The resource type to enable the new format for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks are affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances are affected.

', 'PutAccountSettingRequest$name' => '

The resource name for which to enable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.

', 'Setting$name' => '

The account resource name.

', ], ], 'Settings' => [ 'base' => NULL, 'refs' => [ 'ListAccountSettingsResponse$settings' => '

The account settings for the resource.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => '

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

', ], ], 'StabilityStatus' => [ 'base' => NULL, 'refs' => [ 'TaskSet$stabilityStatus' => '

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

If any of those conditions are not met, the stability status returns STABILIZING.

', ], ], 'StartTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistics' => [ 'base' => NULL, 'refs' => [ 'Cluster$statistics' => '

Additional information about your clusters that are separated by launch type, including:

', ], ], 'StopTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Attachment$id' => '

The unique identifier for the attachment.

', 'Attachment$type' => '

The type of the attachment, such as ElasticNetworkInterface.

', 'Attachment$status' => '

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED.

', 'AttachmentStateChange$attachmentArn' => '

The Amazon Resource Name (ARN) of the attachment.

', 'AttachmentStateChange$status' => '

The status of the attachment.

', 'Attribute$name' => '

The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.

', 'Attribute$value' => '

The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.

', 'Attribute$targetId' => '

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

', 'ClientException$message' => NULL, 'Cluster$clusterArn' => '

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test ..

', 'Cluster$clusterName' => '

A user-generated string that you use to identify your cluster.

', 'Cluster$status' => '

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

', 'Container$containerArn' => '

The Amazon Resource Name (ARN) of the container.

', 'Container$taskArn' => '

The ARN of the task.

', 'Container$name' => '

The name of the container.

', 'Container$lastStatus' => '

The last known status of the container.

', 'Container$reason' => '

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

', 'Container$cpu' => '

The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.

', 'Container$memory' => '

The hard limit (in MiB) of memory set for the container.

', 'Container$memoryReservation' => '

The soft limit (in MiB) of memory set for the container.

', 'ContainerDefinition$name' => '

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

', 'ContainerDefinition$image' => '

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

', 'ContainerDefinition$hostname' => '

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

', 'ContainerDefinition$user' => '

The username to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

This following formats can be used. If specifying a UID or GID, it must be specified as a positive integer.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$workingDirectory' => '

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

', 'ContainerDependency$containerName' => '

The name of a container.

', 'ContainerInstance$containerInstanceArn' => '

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

', 'ContainerInstance$ec2InstanceId' => '

The EC2 instance ID of the container instance.

', 'ContainerInstance$status' => '

The status of the container instance. The valid values are ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.

', 'ContainerOverride$name' => '

The name of the container that receives the override. This parameter is required if any override is specified.

', 'ContainerStateChange$containerName' => '

The name of the container.

', 'ContainerStateChange$reason' => '

The reason for the state change.

', 'ContainerStateChange$status' => '

The status of the container.

', 'CreateClusterRequest$clusterName' => '

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

', 'CreateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

', 'CreateServiceRequest$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'CreateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

', 'CreateServiceRequest$clientToken' => '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

', 'CreateServiceRequest$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'CreateServiceRequest$role' => '

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

', 'DeleteAccountSettingRequest$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.

', 'DeleteAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteClusterRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

', 'DeleteServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteServiceRequest$service' => '

The name of the service to delete.

', 'Deployment$id' => '

The ID of the deployment.

', 'Deployment$status' => '

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

', 'Deployment$taskDefinition' => '

The most recent task definition that was specified for the tasks in the service to use.

', 'Deployment$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'DeregisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

', 'DeregisterContainerInstanceRequest$containerInstance' => '

The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

', 'DeregisterTaskDefinitionRequest$taskDefinition' => '

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

', 'DescribeContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeTaskDefinitionRequest$taskDefinition' => '

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

', 'DescribeTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.

', 'Device$hostPath' => '

The path for the device on the host container instance.

', 'Device$containerPath' => '

The path inside the container at which to expose the host device.

', 'DiscoverPollEndpointRequest$containerInstance' => '

The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

', 'DiscoverPollEndpointRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.

', 'DiscoverPollEndpointResponse$endpoint' => '

The endpoint for the Amazon ECS agent to poll.

', 'DiscoverPollEndpointResponse$telemetryEndpoint' => '

The telemetry endpoint for the Amazon ECS agent.

', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'DockerVolumeConfiguration$driver' => '

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create .

', 'Failure$arn' => '

The Amazon Resource Name (ARN) of the failed resource.

', 'Failure$reason' => '

The reason for the failure.

', 'GpuIds$member' => NULL, 'HostEntry$hostname' => '

The hostname to use in the /etc/hosts entry.

', 'HostEntry$ipAddress' => '

The IP address to use in the /etc/hosts entry.

', 'HostVolumeProperties$sourcePath' => '

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

', 'KeyValuePair$name' => '

The name of the key-value pair. For environment variables, this is the name of the environment variable.

', 'KeyValuePair$value' => '

The value of the key-value pair. For environment variables, this is the value of the environment variable.

', 'ListAccountSettingsRequest$value' => '

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

', 'ListAccountSettingsRequest$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

', 'ListAccountSettingsRequest$nextToken' => '

The nextToken value returned from a previous paginated ListAccountSettings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAccountSettingsResponse$nextToken' => '

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

', 'ListAttributesRequest$attributeName' => '

The name of the attribute with which to filter the results.

', 'ListAttributesRequest$attributeValue' => '

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

', 'ListAttributesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAttributesResponse$nextToken' => '

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListClustersRequest$nextToken' => '

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListClustersResponse$nextToken' => '

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListContainerInstancesRequest$filter' => '

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListContainerInstancesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListContainerInstancesResponse$nextToken' => '

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListServicesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListServicesResponse$nextToken' => '

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'ListTaskDefinitionFamiliesRequest$familyPrefix' => '

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

', 'ListTaskDefinitionFamiliesRequest$nextToken' => '

The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionFamiliesResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTaskDefinitionsRequest$familyPrefix' => '

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

', 'ListTaskDefinitionsRequest$nextToken' => '

The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionsResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListTasksRequest$containerInstance' => '

The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

', 'ListTasksRequest$family' => '

The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

', 'ListTasksRequest$nextToken' => '

The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTasksRequest$startedBy' => '

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

', 'ListTasksRequest$serviceName' => '

The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

', 'ListTasksResponse$nextToken' => '

The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'LoadBalancer$targetGroupArn' => '

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.

If your service\'s task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'LoadBalancer$loadBalancerName' => '

The name of a load balancer.

', 'LoadBalancer$containerName' => '

The name of the container (as it appears in a container definition) to associate with the load balancer.

', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'MountPoint$sourceVolume' => '

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

', 'MountPoint$containerPath' => '

The path on the container to mount the host volume at.

', 'NetworkBinding$bindIP' => '

The IP address that the container is bound to on the container instance.

', 'NetworkInterface$attachmentId' => '

The attachment ID for the network interface.

', 'NetworkInterface$privateIpv4Address' => '

The private IPv4 address for the network interface.

', 'NetworkInterface$ipv6Address' => '

The private IPv6 address for the network interface.

', 'PlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'PlacementStrategy$field' => '

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

', 'PlatformDevice$id' => '

The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

', 'ProxyConfiguration$containerName' => '

The name of the container that will serve as the App Mesh proxy.

', 'PutAccountSettingDefaultRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

', 'PutAccountSettingRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

', 'PutAccountSettingRequest$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the settings are changed only for the authenticated user.

', 'PutAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => '

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

', 'RegisterContainerInstanceRequest$instanceIdentityDocumentSignature' => '

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

', 'RegisterContainerInstanceRequest$containerInstanceArn' => '

The ARN of the container instance (if it was previously registered).

', 'RegisterTaskDefinitionRequest$family' => '

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

', 'RegisterTaskDefinitionRequest$taskRoleArn' => '

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'RegisterTaskDefinitionRequest$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

', 'RegisterTaskDefinitionRequest$cpu' => '

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

', 'RegisterTaskDefinitionRequest$memory' => '

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

', 'RepositoryCredentials$credentialsParameter' => '

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.

', 'Resource$name' => '

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

', 'Resource$type' => '

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

', 'ResourceRequirement$value' => '

The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.

', 'RunTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

', 'RunTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

', 'RunTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'RunTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'RunTaskRequest$platformVersion' => '

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Secret$name' => '

The value to set as the environment variable on the container.

', 'Secret$valueFrom' => '

The secret to expose to the container. If your task is using the EC2 launch type, then supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If your task is using the Fargate launch type, then the only supported value is the full ARN of the parameter in the AWS Systems Manager Parameter Store.

If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

', 'ServerException$message' => NULL, 'Service$serviceArn' => '

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service .

', 'Service$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'Service$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster that hosts the service.

', 'Service$status' => '

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

', 'Service$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Service$taskDefinition' => '

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$roleArn' => '

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

', 'Service$createdBy' => '

The principal that created the service.

', 'ServiceEvent$id' => '

The ID string of the event.

', 'ServiceEvent$message' => '

The event message.

', 'ServiceRegistry$registryArn' => '

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service.

', 'ServiceRegistry$containerName' => '

The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

', 'Setting$value' => '

The current account setting for the resource name. If enabled, then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled, then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.

', 'Setting$principalArn' => '

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

', 'StartTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

', 'StartTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

', 'StartTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'StartTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'StopTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

', 'StopTaskRequest$task' => '

The task ID or full ARN entry of the task to stop.

', 'StopTaskRequest$reason' => '

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitContainerStateChangeRequest$cluster' => '

The short name or full ARN of the cluster that hosts the container.

', 'SubmitContainerStateChangeRequest$task' => '

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

', 'SubmitContainerStateChangeRequest$containerName' => '

The name of the container.

', 'SubmitContainerStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitContainerStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitContainerStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SubmitTaskStateChangeRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

', 'SubmitTaskStateChangeRequest$task' => '

The task ID or full ARN of the task in the state change request.

', 'SubmitTaskStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitTaskStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitTaskStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SystemControl$namespace' => '

The namespaced kernel parameter for which to set a value.

', 'SystemControl$value' => '

The value for the namespaced kernel parameter specified in namespace.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'Task$taskArn' => '

The Amazon Resource Name (ARN) of the task.

', 'Task$clusterArn' => '

The ARN of the cluster that hosts the task.

', 'Task$taskDefinitionArn' => '

The ARN of the task definition that creates the task.

', 'Task$containerInstanceArn' => '

The ARN of the container instances that host the task.

', 'Task$lastStatus' => '

The last known status of the task. For more information, see Task Lifecycle.

', 'Task$desiredStatus' => '

The desired status of the task. For more information, see Task Lifecycle.

', 'Task$cpu' => '

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

', 'Task$memory' => '

The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.

If you are using the EC2 launch type, this field is optional.

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

', 'Task$startedBy' => '

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'Task$stoppedReason' => '

The reason that the task was stopped.

', 'Task$group' => '

The name of the task group associated with the task.

', 'Task$platformVersion' => '

The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$taskDefinitionArn' => '

The full Amazon Resource Name (ARN) of the task definition.

', 'TaskDefinition$family' => '

The family of your task definition, used as the definition name.

', 'TaskDefinition$taskRoleArn' => '

The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

', 'TaskDefinition$cpu' => '

The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

', 'TaskDefinition$memory' => '

The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

', 'TaskDefinitionPlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'TaskOverride$taskRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

', 'TaskOverride$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

', 'TaskSet$id' => '

The ID of the task set.

', 'TaskSet$taskSetArn' => '

The Amazon Resource Name (ARN) of the task set.

', 'TaskSet$startedBy' => '

The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY.

', 'TaskSet$externalId' => '

The deployment ID of the AWS CodeDeploy deployment.

', 'TaskSet$status' => '

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

', 'TaskSet$taskDefinition' => '

The task definition the task set is using.

', 'TaskSet$platformVersion' => '

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Tmpfs$containerPath' => '

The absolute file path where the tmpfs volume is to be mounted.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'UpdateContainerAgentRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateContainerAgentRequest$containerInstance' => '

The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.

', 'UpdateContainerInstancesStateRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServiceRequest$service' => '

The name of the service to update.

', 'UpdateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

', 'UpdateServiceRequest$platformVersion' => '

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'VersionInfo$agentVersion' => '

The version number of the Amazon ECS container agent.

', 'VersionInfo$agentHash' => '

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

', 'VersionInfo$dockerVersion' => '

The Docker version running on the container instance.

', 'Volume$name' => '

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

', 'VolumeFrom$sourceContainer' => '

The name of another container within the same task definition from which to mount volumes.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$subnets' => '

The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

', 'AwsVpcConfiguration$securityGroups' => '

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

', 'ContainerDefinition$links' => '

The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run .

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

', 'ContainerDefinition$entryPoint' => '

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

', 'ContainerDefinition$command' => '

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

', 'ContainerDefinition$dnsServers' => '

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dnsSearchDomains' => '

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dockerSecurityOptions' => '

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers.

', 'ContainerOverride$command' => '

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

', 'DescribeClustersRequest$clusters' => '

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeContainerInstancesRequest$containerInstances' => '

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

', 'DescribeServicesRequest$services' => '

A list of services to describe. You may specify up to 10 services to describe in a single operation.

', 'DescribeTasksRequest$tasks' => '

A list of up to 100 task IDs or full ARN entries.

', 'HealthCheck$command' => '

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container\'s default shell. For example:

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

', 'KernelCapabilities$add' => '

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

If you are using tasks that use the Fargate launch type, the add parameter is not supported.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'KernelCapabilities$drop' => '

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'ListClustersResponse$clusterArns' => '

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

', 'ListContainerInstancesResponse$containerInstanceArns' => '

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

', 'ListServicesResponse$serviceArns' => '

The list of full ARN entries for each service associated with the specified cluster.

', 'ListTaskDefinitionFamiliesResponse$families' => '

The list of task definition family names that match the ListTaskDefinitionFamilies request.

', 'ListTaskDefinitionsResponse$taskDefinitionArns' => '

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

', 'ListTasksResponse$taskArns' => '

The list of task ARN entries for the ListTasks request.

', 'Resource$stringSetValue' => '

When the stringSetValue type is set, the value of the resource must be a string type.

', 'StartTaskRequest$containerInstances' => '

The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

', 'Tmpfs$mountOptions' => '

The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

', 'UpdateContainerInstancesStateRequest$containerInstances' => '

A list of container instance IDs or full ARN entries.

', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$driverOpts' => '

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create .

', 'DockerVolumeConfiguration$labels' => '

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create .

', ], ], 'SubmitContainerStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SystemControl' => [ 'base' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:

', 'refs' => [ 'SystemControls$member' => NULL, ], ], 'SystemControls' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$systemControls' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance\'s namespaced kernel parameters as well as the containers.

', ], ], 'Tag' => [ 'base' => '

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The keys of the tags to be removed.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'Cluster$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'ContainerInstance$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'CreateClusterRequest$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'CreateServiceRequest$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'DescribeTaskDefinitionResponse$tags' => '

The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'ListTagsForResourceResponse$tags' => '

The tags for the resource.

', 'RegisterContainerInstanceRequest$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'RegisterTaskDefinitionRequest$tags' => '

The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'RegisterTaskDefinitionResponse$tags' => '

The list of tags associated with the task definition.

', 'RunTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'Service$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'StartTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'TagResourceRequest$tags' => '

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', 'Task$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

', ], ], 'TargetNotFoundException' => [ 'base' => '

The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

', 'refs' => [], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Attribute$targetType' => '

The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.

', 'ListAttributesRequest$targetType' => '

The type of the target with which to list attributes.

', ], ], 'Task' => [ 'base' => '

Details on a task in a cluster.

', 'refs' => [ 'StopTaskResponse$task' => '

The task that was stopped.

', 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => '

Details of a task definition.

', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => '

The full description of the deregistered task.

', 'DescribeTaskDefinitionResponse$taskDefinition' => '

The full task definition description.

', 'RegisterTaskDefinitionResponse$taskDefinition' => '

The full description of the registered task definition.

', ], ], 'TaskDefinitionFamilyStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionFamiliesRequest$status' => '

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', ], ], 'TaskDefinitionField' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionFieldList$member' => NULL, ], ], 'TaskDefinitionFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskDefinitionRequest$include' => '

Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'TaskDefinitionPlacementConstraint' => [ 'base' => '

An object representing a constraint on task placement in the task definition.

If you are using the Fargate launch type, task placement constraints are not supported.

For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'TaskDefinitionPlacementConstraints$member' => NULL, ], ], 'TaskDefinitionPlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionPlacementConstraint$type' => '

The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.

', ], ], 'TaskDefinitionPlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

', 'TaskDefinition$placementConstraints' => '

An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.

', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => '

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', 'TaskDefinition$status' => '

The status of the task definition.

', ], ], 'TaskField' => [ 'base' => NULL, 'refs' => [ 'TaskFieldList$member' => NULL, ], ], 'TaskFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksRequest$include' => '

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

', ], ], 'TaskOverride' => [ 'base' => '

The overrides associated with a task.

', 'refs' => [ 'RunTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'StartTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'Task$overrides' => '

One or more container overrides.

', ], ], 'TaskSet' => [ 'base' => '

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', 'refs' => [ 'TaskSets$member' => NULL, ], ], 'TaskSets' => [ 'base' => NULL, 'refs' => [ 'Service$taskSets' => '

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', ], ], 'TaskStopCode' => [ 'base' => NULL, 'refs' => [ 'Task$stopCode' => '

The stop code indicating why a task was stopped. The stoppedReason may contain additional details.

', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => '

The list of tasks.

', 'RunTaskResponse$tasks' => '

A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.

', 'StartTaskResponse$tasks' => '

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$registeredAt' => '

The Unix timestamp for when the container instance was registered.

', 'Deployment$createdAt' => '

The Unix timestamp for when the service deployment was created.

', 'Deployment$updatedAt' => '

The Unix timestamp for when the service deployment was last updated.

', 'Service$createdAt' => '

The Unix timestamp for when the service was created.

', 'ServiceEvent$createdAt' => '

The Unix timestamp for when the event was triggered.

', 'SubmitTaskStateChangeRequest$pullStartedAt' => '

The Unix timestamp for when the container image pull began.

', 'SubmitTaskStateChangeRequest$pullStoppedAt' => '

The Unix timestamp for when the container image pull completed.

', 'SubmitTaskStateChangeRequest$executionStoppedAt' => '

The Unix timestamp for when the task execution stopped.

', 'Task$connectivityAt' => '

The Unix timestamp for when the task last went into CONNECTED status.

', 'Task$pullStartedAt' => '

The Unix timestamp for when the container image pull began.

', 'Task$pullStoppedAt' => '

The Unix timestamp for when the container image pull completed.

', 'Task$executionStoppedAt' => '

The Unix timestamp for when the task execution stopped.

', 'Task$createdAt' => '

The Unix timestamp for when the task was created (the task entered the PENDING state).

', 'Task$startedAt' => '

The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).

', 'Task$stoppingAt' => '

The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).

', 'Task$stoppedAt' => '

The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

', 'TaskSet$createdAt' => '

The Unix timestamp for when the task set was created.

', 'TaskSet$updatedAt' => '

The Unix timestamp for when the task set was last updated.

', 'TaskSet$stabilityStatusAt' => '

The Unix timestamp for when the task set stability status was retrieved.

', ], ], 'Tmpfs' => [ 'base' => '

The container path, mount options, and size of the tmpfs mount.

', 'refs' => [ 'TmpfsList$member' => NULL, ], ], 'TmpfsList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$tmpfs' => '

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

', ], ], 'TransportProtocol' => [ 'base' => NULL, 'refs' => [ 'NetworkBinding$protocol' => '

The protocol used for the network binding.

', 'PortMapping$protocol' => '

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

', ], ], 'Ulimit' => [ 'base' => '

The ulimit settings to pass to the container.

', 'refs' => [ 'UlimitList$member' => NULL, ], ], 'UlimitList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ulimits' => '

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

This parameter is not supported for Windows containers.

', ], ], 'UlimitName' => [ 'base' => NULL, 'refs' => [ 'Ulimit$name' => '

The type of the ulimit.

', ], ], 'UnsupportedFeatureException' => [ 'base' => '

The specified task is not supported in this Region.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInProgressException' => [ 'base' => '

There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

', 'refs' => [], ], 'UpdateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'VersionInfo' => [ 'base' => '

The Docker and Amazon ECS container agent version information about a container instance.

', 'refs' => [ 'ContainerInstance$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

', 'RegisterContainerInstanceRequest$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

', ], ], 'Volume' => [ 'base' => '

A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => '

Details on a data volume from another container in the same task definition.

', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => '

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

', ], ], 'VolumeList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$volumes' => '

A list of volume definitions in JSON format that containers in your task may use.

', 'TaskDefinition$volumes' => '

The list of volumes in a task.

If you are using the Fargate launch type, the host and sourcePath parameters are not supported.

For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

', ], ], ],]; diff --git a/src/data/endpoints.json b/src/data/endpoints.json index 07b9e12c89..2abd0de383 100644 --- a/src/data/endpoints.json +++ b/src/data/endpoints.json @@ -802,6 +802,14 @@ "us-west-2" : { } } }, + "comprehendmedical" : { + "endpoints" : { + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "config" : { "endpoints" : { "ap-northeast-1" : { }, diff --git a/src/data/endpoints.json.php b/src/data/endpoints.json.php index 52debb1d34..e50357a942 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.ecr' => [ 'endpoints' => [ 'ap-northeast-1' => [ 'credentialScope' => [ 'region' => 'ap-northeast-1', ], 'hostname' => 'api.ecr.ap-northeast-1.amazonaws.com', ], 'ap-northeast-2' => [ 'credentialScope' => [ 'region' => 'ap-northeast-2', ], 'hostname' => 'api.ecr.ap-northeast-2.amazonaws.com', ], 'ap-south-1' => [ 'credentialScope' => [ 'region' => 'ap-south-1', ], 'hostname' => 'api.ecr.ap-south-1.amazonaws.com', ], 'ap-southeast-1' => [ 'credentialScope' => [ 'region' => 'ap-southeast-1', ], 'hostname' => 'api.ecr.ap-southeast-1.amazonaws.com', ], 'ap-southeast-2' => [ 'credentialScope' => [ 'region' => 'ap-southeast-2', ], 'hostname' => 'api.ecr.ap-southeast-2.amazonaws.com', ], 'ca-central-1' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 'api.ecr.ca-central-1.amazonaws.com', ], 'eu-central-1' => [ 'credentialScope' => [ 'region' => 'eu-central-1', ], 'hostname' => 'api.ecr.eu-central-1.amazonaws.com', ], 'eu-north-1' => [ 'credentialScope' => [ 'region' => 'eu-north-1', ], 'hostname' => 'api.ecr.eu-north-1.amazonaws.com', ], 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 'api.ecr.eu-west-1.amazonaws.com', ], 'eu-west-2' => [ 'credentialScope' => [ 'region' => 'eu-west-2', ], 'hostname' => 'api.ecr.eu-west-2.amazonaws.com', ], 'eu-west-3' => [ 'credentialScope' => [ 'region' => 'eu-west-3', ], 'hostname' => 'api.ecr.eu-west-3.amazonaws.com', ], 'sa-east-1' => [ 'credentialScope' => [ 'region' => 'sa-east-1', ], 'hostname' => 'api.ecr.sa-east-1.amazonaws.com', ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'api.ecr.us-east-1.amazonaws.com', ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'api.ecr.us-east-2.amazonaws.com', ], 'us-west-1' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'api.ecr.us-west-1.amazonaws.com', ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'api.ecr.us-west-2.amazonaws.com', ], ], ], 'api.mediatailor' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], '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-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'api-fips.sagemaker.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'api-fips.sagemaker.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'api-fips.sagemaker.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'api-fips.sagemaker.us-west-2.amazonaws.com', ], ], ], '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-northeast-2' => [], '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-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' => [], ], ], '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-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], '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-central-1' => [], '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-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' => [], ], ], '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' => [], ], ], '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' => [], 'eu-west-2' => [], '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' => [], 'fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'es-fips.us-west-1.amazonaws.com', ], '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' => [ 'ProdFips' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 'kms-fips.ca-central-1.amazonaws.com', ], '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' => [], ], ], 'license-manager' => [ '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' => [], ], ], '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-northeast-1' => [ 'credentialScope' => [ 'region' => 'ap-northeast-1', ], 'hostname' => 'rds.ap-northeast-1.amazonaws.com', ], '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-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' => [], ], ], '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-northeast-2' => [], 'ap-south-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' => [ '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' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], '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-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' => '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-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' => [], ], ], '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' => [ 'api.ecr' => [ 'endpoints' => [ 'cn-north-1' => [ 'credentialScope' => [ 'region' => 'cn-north-1', ], 'hostname' => 'api.ecr.cn-north-1.amazonaws.com.cn', ], 'cn-northwest-1' => [ 'credentialScope' => [ 'region' => 'cn-northwest-1', ], 'hostname' => 'api.ecr.cn-northwest-1.amazonaws.com.cn', ], ], ], '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' => [], ], ], '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' => [], ], ], 'firehose' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'gamelift' => [ 'endpoints' => [ 'cn-north-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.ecr' => [ 'endpoints' => [ 'us-gov-east-1' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 'api.ecr.us-gov-east-1.amazonaws.com', ], 'us-gov-west-1' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'api.ecr.us-gov-west-1.amazonaws.com', ], ], ], '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' => [], ], ], 'athena' => [ 'endpoints' => [ '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' => [], ], ], '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' => [ 'fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'es-fips.us-gov-west-1.amazonaws.com', ], 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'events' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'firehose' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'glacier' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'glue' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], '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' => [ 'ProdFips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'kms-fips.us-gov-west-1.amazonaws.com', ], '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', ], ], ], 'workspaces' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], ], ], ], '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.ecr' => [ 'endpoints' => [ 'ap-northeast-1' => [ 'credentialScope' => [ 'region' => 'ap-northeast-1', ], 'hostname' => 'api.ecr.ap-northeast-1.amazonaws.com', ], 'ap-northeast-2' => [ 'credentialScope' => [ 'region' => 'ap-northeast-2', ], 'hostname' => 'api.ecr.ap-northeast-2.amazonaws.com', ], 'ap-south-1' => [ 'credentialScope' => [ 'region' => 'ap-south-1', ], 'hostname' => 'api.ecr.ap-south-1.amazonaws.com', ], 'ap-southeast-1' => [ 'credentialScope' => [ 'region' => 'ap-southeast-1', ], 'hostname' => 'api.ecr.ap-southeast-1.amazonaws.com', ], 'ap-southeast-2' => [ 'credentialScope' => [ 'region' => 'ap-southeast-2', ], 'hostname' => 'api.ecr.ap-southeast-2.amazonaws.com', ], 'ca-central-1' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 'api.ecr.ca-central-1.amazonaws.com', ], 'eu-central-1' => [ 'credentialScope' => [ 'region' => 'eu-central-1', ], 'hostname' => 'api.ecr.eu-central-1.amazonaws.com', ], 'eu-north-1' => [ 'credentialScope' => [ 'region' => 'eu-north-1', ], 'hostname' => 'api.ecr.eu-north-1.amazonaws.com', ], 'eu-west-1' => [ 'credentialScope' => [ 'region' => 'eu-west-1', ], 'hostname' => 'api.ecr.eu-west-1.amazonaws.com', ], 'eu-west-2' => [ 'credentialScope' => [ 'region' => 'eu-west-2', ], 'hostname' => 'api.ecr.eu-west-2.amazonaws.com', ], 'eu-west-3' => [ 'credentialScope' => [ 'region' => 'eu-west-3', ], 'hostname' => 'api.ecr.eu-west-3.amazonaws.com', ], 'sa-east-1' => [ 'credentialScope' => [ 'region' => 'sa-east-1', ], 'hostname' => 'api.ecr.sa-east-1.amazonaws.com', ], 'us-east-1' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'api.ecr.us-east-1.amazonaws.com', ], 'us-east-2' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'api.ecr.us-east-2.amazonaws.com', ], 'us-west-1' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'api.ecr.us-west-1.amazonaws.com', ], 'us-west-2' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'api.ecr.us-west-2.amazonaws.com', ], ], ], 'api.mediatailor' => [ 'endpoints' => [ 'ap-northeast-1' => [], 'ap-southeast-1' => [], 'ap-southeast-2' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-west-2' => [], ], ], '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-1-fips' => [ 'credentialScope' => [ 'region' => 'us-east-1', ], 'hostname' => 'api-fips.sagemaker.us-east-1.amazonaws.com', ], 'us-east-2' => [], 'us-east-2-fips' => [ 'credentialScope' => [ 'region' => 'us-east-2', ], 'hostname' => 'api-fips.sagemaker.us-east-2.amazonaws.com', ], 'us-west-1' => [], 'us-west-1-fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'api-fips.sagemaker.us-west-1.amazonaws.com', ], 'us-west-2' => [], 'us-west-2-fips' => [ 'credentialScope' => [ 'region' => 'us-west-2', ], 'hostname' => 'api-fips.sagemaker.us-west-2.amazonaws.com', ], ], ], '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-northeast-2' => [], '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-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' => [], ], ], '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-1' => [], 'ap-southeast-2' => [], 'ca-central-1' => [], 'eu-central-1' => [], 'eu-west-1' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-2' => [], ], ], 'comprehendmedical' => [ 'endpoints' => [ '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-central-1' => [], '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-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' => [], ], ], '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' => [], ], ], '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' => [], 'eu-west-2' => [], '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' => [], 'fips' => [ 'credentialScope' => [ 'region' => 'us-west-1', ], 'hostname' => 'es-fips.us-west-1.amazonaws.com', ], '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' => [ 'ProdFips' => [ 'credentialScope' => [ 'region' => 'ca-central-1', ], 'hostname' => 'kms-fips.ca-central-1.amazonaws.com', ], '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' => [], ], ], 'license-manager' => [ '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' => [], ], ], '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-northeast-1' => [ 'credentialScope' => [ 'region' => 'ap-northeast-1', ], 'hostname' => 'rds.ap-northeast-1.amazonaws.com', ], '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-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' => [], ], ], '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-northeast-2' => [], 'ap-south-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' => [ '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' => [], 'us-east-1' => [], 'us-east-2' => [], 'us-west-1' => [], '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-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' => '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-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' => [], ], ], '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' => [ 'api.ecr' => [ 'endpoints' => [ 'cn-north-1' => [ 'credentialScope' => [ 'region' => 'cn-north-1', ], 'hostname' => 'api.ecr.cn-north-1.amazonaws.com.cn', ], 'cn-northwest-1' => [ 'credentialScope' => [ 'region' => 'cn-northwest-1', ], 'hostname' => 'api.ecr.cn-northwest-1.amazonaws.com.cn', ], ], ], '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' => [], ], ], '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' => [], ], ], 'firehose' => [ 'endpoints' => [ 'cn-north-1' => [], 'cn-northwest-1' => [], ], ], 'gamelift' => [ 'endpoints' => [ 'cn-north-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.ecr' => [ 'endpoints' => [ 'us-gov-east-1' => [ 'credentialScope' => [ 'region' => 'us-gov-east-1', ], 'hostname' => 'api.ecr.us-gov-east-1.amazonaws.com', ], 'us-gov-west-1' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'api.ecr.us-gov-west-1.amazonaws.com', ], ], ], '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' => [], ], ], 'athena' => [ 'endpoints' => [ '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' => [], ], ], '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' => [ 'fips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'es-fips.us-gov-west-1.amazonaws.com', ], 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'events' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [], ], ], 'firehose' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], 'glacier' => [ 'endpoints' => [ 'us-gov-east-1' => [], 'us-gov-west-1' => [ 'protocols' => [ 'http', 'https', ], ], ], ], 'glue' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], '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' => [ 'ProdFips' => [ 'credentialScope' => [ 'region' => 'us-gov-west-1', ], 'hostname' => 'kms-fips.us-gov-west-1.amazonaws.com', ], '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', ], ], ], 'workspaces' => [ 'endpoints' => [ 'us-gov-west-1' => [], ], ], ], ], ], 'version' => 3,]; diff --git a/src/data/gamelift/2015-10-01/api-2.json b/src/data/gamelift/2015-10-01/api-2.json index e265568ca9..7afb2693d6 100644 --- a/src/data/gamelift/2015-10-01/api-2.json +++ b/src/data/gamelift/2015-10-01/api-2.json @@ -1226,7 +1226,8 @@ "MetricGroups":{"shape":"MetricGroupList"}, "PeerVpcAwsAccountId":{"shape":"NonZeroAndMaxString"}, "PeerVpcId":{"shape":"NonZeroAndMaxString"}, - "FleetType":{"shape":"FleetType"} + "FleetType":{"shape":"FleetType"}, + "InstanceRoleArn":{"shape":"NonEmptyString"} } }, "CreateFleetOutput":{ @@ -1966,7 +1967,8 @@ "OperatingSystem":{"shape":"OperatingSystem"}, "ResourceCreationLimitPolicy":{"shape":"ResourceCreationLimitPolicy"}, "MetricGroups":{"shape":"MetricGroupList"}, - "StoppedActions":{"shape":"FleetActionList"} + "StoppedActions":{"shape":"FleetActionList"}, + "InstanceRoleArn":{"shape":"NonEmptyString"} } }, "FleetAttributesList":{ diff --git a/src/data/gamelift/2015-10-01/api-2.json.php b/src/data/gamelift/2015-10-01/api-2.json.php index 7f394505a6..6114a06d7a 100644 --- a/src/data/gamelift/2015-10-01/api-2.json.php +++ b/src/data/gamelift/2015-10-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2015-10-01', 'endpointPrefix' => 'gamelift', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon GameLift', 'serviceId' => 'GameLift', 'signatureVersion' => 'v4', 'targetPrefix' => 'GameLift', 'uid' => 'gamelift-2015-10-01', ], 'operations' => [ 'AcceptMatch' => [ 'name' => 'AcceptMatch', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AcceptMatchInput', ], 'output' => [ 'shape' => 'AcceptMatchOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'CreateAlias' => [ 'name' => 'CreateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAliasInput', ], 'output' => [ 'shape' => 'CreateAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateBuild' => [ 'name' => 'CreateBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBuildInput', ], 'output' => [ 'shape' => 'CreateBuildOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateFleet' => [ 'name' => 'CreateFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFleetInput', ], 'output' => [ 'shape' => 'CreateFleetOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'CreateGameSession' => [ 'name' => 'CreateGameSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGameSessionInput', ], 'output' => [ 'shape' => 'CreateGameSessionOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'FleetCapacityExceededException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'IdempotentParameterMismatchException', ], ], ], 'CreateGameSessionQueue' => [ 'name' => 'CreateGameSessionQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGameSessionQueueInput', ], 'output' => [ 'shape' => 'CreateGameSessionQueueOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateMatchmakingConfiguration' => [ 'name' => 'CreateMatchmakingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMatchmakingConfigurationInput', ], 'output' => [ 'shape' => 'CreateMatchmakingConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'CreateMatchmakingRuleSet' => [ 'name' => 'CreateMatchmakingRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMatchmakingRuleSetInput', ], 'output' => [ 'shape' => 'CreateMatchmakingRuleSetOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'CreatePlayerSession' => [ 'name' => 'CreatePlayerSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePlayerSessionInput', ], 'output' => [ 'shape' => 'CreatePlayerSessionOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidGameSessionStatusException', ], [ 'shape' => 'GameSessionFullException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], ], ], 'CreatePlayerSessions' => [ 'name' => 'CreatePlayerSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePlayerSessionsInput', ], 'output' => [ 'shape' => 'CreatePlayerSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidGameSessionStatusException', ], [ 'shape' => 'GameSessionFullException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], ], ], 'CreateVpcPeeringAuthorization' => [ 'name' => 'CreateVpcPeeringAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVpcPeeringAuthorizationInput', ], 'output' => [ 'shape' => 'CreateVpcPeeringAuthorizationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateVpcPeeringConnection' => [ 'name' => 'CreateVpcPeeringConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVpcPeeringConnectionInput', ], 'output' => [ 'shape' => 'CreateVpcPeeringConnectionOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteAlias' => [ 'name' => 'DeleteAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAliasInput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteBuild' => [ 'name' => 'DeleteBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBuildInput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteFleet' => [ 'name' => 'DeleteFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFleetInput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteGameSessionQueue' => [ 'name' => 'DeleteGameSessionQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGameSessionQueueInput', ], 'output' => [ 'shape' => 'DeleteGameSessionQueueOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DeleteMatchmakingConfiguration' => [ 'name' => 'DeleteMatchmakingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMatchmakingConfigurationInput', ], 'output' => [ 'shape' => 'DeleteMatchmakingConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DeleteMatchmakingRuleSet' => [ 'name' => 'DeleteMatchmakingRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMatchmakingRuleSetInput', ], 'output' => [ 'shape' => 'DeleteMatchmakingRuleSetOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteScalingPolicy' => [ 'name' => 'DeleteScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteScalingPolicyInput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteVpcPeeringAuthorization' => [ 'name' => 'DeleteVpcPeeringAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVpcPeeringAuthorizationInput', ], 'output' => [ 'shape' => 'DeleteVpcPeeringAuthorizationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteVpcPeeringConnection' => [ 'name' => 'DeleteVpcPeeringConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVpcPeeringConnectionInput', ], 'output' => [ 'shape' => 'DeleteVpcPeeringConnectionOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeAlias' => [ 'name' => 'DescribeAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAliasInput', ], 'output' => [ 'shape' => 'DescribeAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeBuild' => [ 'name' => 'DescribeBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBuildInput', ], 'output' => [ 'shape' => 'DescribeBuildOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeEC2InstanceLimits' => [ 'name' => 'DescribeEC2InstanceLimits', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEC2InstanceLimitsInput', ], 'output' => [ 'shape' => 'DescribeEC2InstanceLimitsOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetAttributes' => [ 'name' => 'DescribeFleetAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetAttributesInput', ], 'output' => [ 'shape' => 'DescribeFleetAttributesOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetCapacity' => [ 'name' => 'DescribeFleetCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetCapacityInput', ], 'output' => [ 'shape' => 'DescribeFleetCapacityOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetEvents' => [ 'name' => 'DescribeFleetEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetEventsInput', ], 'output' => [ 'shape' => 'DescribeFleetEventsOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeFleetPortSettings' => [ 'name' => 'DescribeFleetPortSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetPortSettingsInput', ], 'output' => [ 'shape' => 'DescribeFleetPortSettingsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetUtilization' => [ 'name' => 'DescribeFleetUtilization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetUtilizationInput', ], 'output' => [ 'shape' => 'DescribeFleetUtilizationOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeGameSessionDetails' => [ 'name' => 'DescribeGameSessionDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionDetailsInput', ], 'output' => [ 'shape' => 'DescribeGameSessionDetailsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], ], ], 'DescribeGameSessionPlacement' => [ 'name' => 'DescribeGameSessionPlacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionPlacementInput', ], 'output' => [ 'shape' => 'DescribeGameSessionPlacementOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeGameSessionQueues' => [ 'name' => 'DescribeGameSessionQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionQueuesInput', ], 'output' => [ 'shape' => 'DescribeGameSessionQueuesOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeGameSessions' => [ 'name' => 'DescribeGameSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionsInput', ], 'output' => [ 'shape' => 'DescribeGameSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], ], ], 'DescribeInstances' => [ 'name' => 'DescribeInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInstancesInput', ], 'output' => [ 'shape' => 'DescribeInstancesOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeMatchmaking' => [ 'name' => 'DescribeMatchmaking', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMatchmakingInput', ], 'output' => [ 'shape' => 'DescribeMatchmakingOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DescribeMatchmakingConfigurations' => [ 'name' => 'DescribeMatchmakingConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMatchmakingConfigurationsInput', ], 'output' => [ 'shape' => 'DescribeMatchmakingConfigurationsOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DescribeMatchmakingRuleSets' => [ 'name' => 'DescribeMatchmakingRuleSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMatchmakingRuleSetsInput', ], 'output' => [ 'shape' => 'DescribeMatchmakingRuleSetsOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DescribePlayerSessions' => [ 'name' => 'DescribePlayerSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePlayerSessionsInput', ], 'output' => [ 'shape' => 'DescribePlayerSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeRuntimeConfiguration' => [ 'name' => 'DescribeRuntimeConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRuntimeConfigurationInput', ], 'output' => [ 'shape' => 'DescribeRuntimeConfigurationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeScalingPolicies' => [ 'name' => 'DescribeScalingPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeScalingPoliciesInput', ], 'output' => [ 'shape' => 'DescribeScalingPoliciesOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DescribeVpcPeeringAuthorizations' => [ 'name' => 'DescribeVpcPeeringAuthorizations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVpcPeeringAuthorizationsInput', ], 'output' => [ 'shape' => 'DescribeVpcPeeringAuthorizationsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeVpcPeeringConnections' => [ 'name' => 'DescribeVpcPeeringConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVpcPeeringConnectionsInput', ], 'output' => [ 'shape' => 'DescribeVpcPeeringConnectionsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetGameSessionLogUrl' => [ 'name' => 'GetGameSessionLogUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetGameSessionLogUrlInput', ], 'output' => [ 'shape' => 'GetGameSessionLogUrlOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetInstanceAccess' => [ 'name' => 'GetInstanceAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceAccessInput', ], 'output' => [ 'shape' => 'GetInstanceAccessOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesInput', ], 'output' => [ 'shape' => 'ListAliasesOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListBuilds' => [ 'name' => 'ListBuilds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBuildsInput', ], 'output' => [ 'shape' => 'ListBuildsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListFleets' => [ 'name' => 'ListFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFleetsInput', ], 'output' => [ 'shape' => 'ListFleetsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'PutScalingPolicy' => [ 'name' => 'PutScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutScalingPolicyInput', ], 'output' => [ 'shape' => 'PutScalingPolicyOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'RequestUploadCredentials' => [ 'name' => 'RequestUploadCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RequestUploadCredentialsInput', ], 'output' => [ 'shape' => 'RequestUploadCredentialsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ResolveAlias' => [ 'name' => 'ResolveAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResolveAliasInput', ], 'output' => [ 'shape' => 'ResolveAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchGameSessions' => [ 'name' => 'SearchGameSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchGameSessionsInput', ], 'output' => [ 'shape' => 'SearchGameSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], ], ], 'StartFleetActions' => [ 'name' => 'StartFleetActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartFleetActionsInput', ], 'output' => [ 'shape' => 'StartFleetActionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'StartGameSessionPlacement' => [ 'name' => 'StartGameSessionPlacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartGameSessionPlacementInput', ], 'output' => [ 'shape' => 'StartGameSessionPlacementOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'StartMatchBackfill' => [ 'name' => 'StartMatchBackfill', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMatchBackfillInput', ], 'output' => [ 'shape' => 'StartMatchBackfillOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'StartMatchmaking' => [ 'name' => 'StartMatchmaking', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMatchmakingInput', ], 'output' => [ 'shape' => 'StartMatchmakingOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'StopFleetActions' => [ 'name' => 'StopFleetActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopFleetActionsInput', ], 'output' => [ 'shape' => 'StopFleetActionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'StopGameSessionPlacement' => [ 'name' => 'StopGameSessionPlacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopGameSessionPlacementInput', ], 'output' => [ 'shape' => 'StopGameSessionPlacementOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'StopMatchmaking' => [ 'name' => 'StopMatchmaking', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMatchmakingInput', ], 'output' => [ 'shape' => 'StopMatchmakingOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'UpdateAlias' => [ 'name' => 'UpdateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAliasInput', ], 'output' => [ 'shape' => 'UpdateAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateBuild' => [ 'name' => 'UpdateBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateBuildInput', ], 'output' => [ 'shape' => 'UpdateBuildOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateFleetAttributes' => [ 'name' => 'UpdateFleetAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFleetAttributesInput', ], 'output' => [ 'shape' => 'UpdateFleetAttributesOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateFleetCapacity' => [ 'name' => 'UpdateFleetCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFleetCapacityInput', ], 'output' => [ 'shape' => 'UpdateFleetCapacityOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateFleetPortSettings' => [ 'name' => 'UpdateFleetPortSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFleetPortSettingsInput', ], 'output' => [ 'shape' => 'UpdateFleetPortSettingsOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateGameSession' => [ 'name' => 'UpdateGameSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateGameSessionInput', ], 'output' => [ 'shape' => 'UpdateGameSessionOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidGameSessionStatusException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'UpdateGameSessionQueue' => [ 'name' => 'UpdateGameSessionQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateGameSessionQueueInput', ], 'output' => [ 'shape' => 'UpdateGameSessionQueueOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateMatchmakingConfiguration' => [ 'name' => 'UpdateMatchmakingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMatchmakingConfigurationInput', ], 'output' => [ 'shape' => 'UpdateMatchmakingConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'UpdateRuntimeConfiguration' => [ 'name' => 'UpdateRuntimeConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRuntimeConfigurationInput', ], 'output' => [ 'shape' => 'UpdateRuntimeConfigurationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidFleetStatusException', ], ], ], 'ValidateMatchmakingRuleSet' => [ 'name' => 'ValidateMatchmakingRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ValidateMatchmakingRuleSetInput', ], 'output' => [ 'shape' => 'ValidateMatchmakingRuleSetOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], [ 'shape' => 'InvalidRequestException', ], ], ], ], 'shapes' => [ 'AcceptMatchInput' => [ 'type' => 'structure', 'required' => [ 'TicketId', 'PlayerIds', 'AcceptanceType', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'PlayerIds' => [ 'shape' => 'StringList', ], 'AcceptanceType' => [ 'shape' => 'AcceptanceType', ], ], ], 'AcceptMatchOutput' => [ 'type' => 'structure', 'members' => [], ], 'AcceptanceType' => [ 'type' => 'string', 'enum' => [ 'ACCEPT', 'REJECT', ], ], 'Alias' => [ 'type' => 'structure', 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], 'Name' => [ 'shape' => 'NonBlankAndLengthConstraintString', ], 'AliasArn' => [ 'shape' => 'ArnStringModel', ], 'Description' => [ 'shape' => 'FreeText', ], 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AliasId' => [ 'type' => 'string', 'pattern' => '^alias-\\S+', ], 'AliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alias', ], ], 'ArnStringModel' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9:/-]+', ], 'AttributeValue' => [ 'type' => 'structure', 'members' => [ 'S' => [ 'shape' => 'NonZeroAndMaxString', ], 'N' => [ 'shape' => 'DoubleObject', ], 'SL' => [ 'shape' => 'StringList', ], 'SDM' => [ 'shape' => 'StringDoubleMap', ], ], ], 'AwsCredentials' => [ 'type' => 'structure', 'members' => [ 'AccessKeyId' => [ 'shape' => 'NonEmptyString', ], 'SecretAccessKey' => [ 'shape' => 'NonEmptyString', ], 'SessionToken' => [ 'shape' => 'NonEmptyString', ], ], 'sensitive' => true, ], 'BooleanModel' => [ 'type' => 'boolean', ], 'Build' => [ 'type' => 'structure', 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], 'Name' => [ 'shape' => 'FreeText', ], 'Version' => [ 'shape' => 'FreeText', ], 'Status' => [ 'shape' => 'BuildStatus', ], 'SizeOnDisk' => [ 'shape' => 'PositiveLong', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'BuildId' => [ 'type' => 'string', 'pattern' => '^build-\\S+', ], 'BuildList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Build', ], ], 'BuildStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'READY', 'FAILED', ], ], 'ComparisonOperatorType' => [ 'type' => 'string', 'enum' => [ 'GreaterThanOrEqualToThreshold', 'GreaterThanThreshold', 'LessThanThreshold', 'LessThanOrEqualToThreshold', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'CreateAliasInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'RoutingStrategy', ], 'members' => [ 'Name' => [ 'shape' => 'NonBlankAndLengthConstraintString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'CreateAliasOutput' => [ 'type' => 'structure', 'members' => [ 'Alias' => [ 'shape' => 'Alias', ], ], ], 'CreateBuildInput' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Version' => [ 'shape' => 'NonZeroAndMaxString', ], 'StorageLocation' => [ 'shape' => 'S3Location', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], ], ], 'CreateBuildOutput' => [ 'type' => 'structure', 'members' => [ 'Build' => [ 'shape' => 'Build', ], 'UploadCredentials' => [ 'shape' => 'AwsCredentials', ], 'StorageLocation' => [ 'shape' => 'S3Location', ], ], ], 'CreateFleetInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'BuildId', 'EC2InstanceType', ], 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'BuildId' => [ 'shape' => 'BuildId', ], 'ServerLaunchPath' => [ 'shape' => 'NonZeroAndMaxString', ], 'ServerLaunchParameters' => [ 'shape' => 'NonZeroAndMaxString', ], 'LogPaths' => [ 'shape' => 'StringList', ], 'EC2InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'EC2InboundPermissions' => [ 'shape' => 'IpPermissionsList', ], 'NewGameSessionProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], 'ResourceCreationLimitPolicy' => [ 'shape' => 'ResourceCreationLimitPolicy', ], 'MetricGroups' => [ 'shape' => 'MetricGroupList', ], 'PeerVpcAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetType' => [ 'shape' => 'FleetType', ], ], ], 'CreateFleetOutput' => [ 'type' => 'structure', 'members' => [ 'FleetAttributes' => [ 'shape' => 'FleetAttributes', ], ], ], 'CreateGameSessionInput' => [ 'type' => 'structure', 'required' => [ 'MaximumPlayerSessionCount', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'CreatorId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionId' => [ 'shape' => 'IdStringModel', ], 'IdempotencyToken' => [ 'shape' => 'IdStringModel', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'CreateGameSessionOutput' => [ 'type' => 'structure', 'members' => [ 'GameSession' => [ 'shape' => 'GameSession', ], ], ], 'CreateGameSessionQueueInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], 'TimeoutInSeconds' => [ 'shape' => 'WholeNumber', ], 'PlayerLatencyPolicies' => [ 'shape' => 'PlayerLatencyPolicyList', ], 'Destinations' => [ 'shape' => 'GameSessionQueueDestinationList', ], ], ], 'CreateGameSessionQueueOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionQueue' => [ 'shape' => 'GameSessionQueue', ], ], ], 'CreateMatchmakingConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'GameSessionQueueArns', 'RequestTimeoutSeconds', 'AcceptanceRequired', 'RuleSetName', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionQueueArns' => [ 'shape' => 'QueueArnsList', ], 'RequestTimeoutSeconds' => [ 'shape' => 'MatchmakingRequestTimeoutInteger', ], 'AcceptanceTimeoutSeconds' => [ 'shape' => 'MatchmakingAcceptanceTimeoutInteger', ], 'AcceptanceRequired' => [ 'shape' => 'BooleanModel', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'NotificationTarget' => [ 'shape' => 'SnsArnStringModel', ], 'AdditionalPlayerCount' => [ 'shape' => 'WholeNumber', ], 'CustomEventData' => [ 'shape' => 'CustomEventData', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'CreateMatchmakingConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Configuration' => [ 'shape' => 'MatchmakingConfiguration', ], ], ], 'CreateMatchmakingRuleSetInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'RuleSetBody', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'RuleSetBody' => [ 'shape' => 'RuleSetBody', ], ], ], 'CreateMatchmakingRuleSetOutput' => [ 'type' => 'structure', 'required' => [ 'RuleSet', ], 'members' => [ 'RuleSet' => [ 'shape' => 'MatchmakingRuleSet', ], ], ], 'CreatePlayerSessionInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', 'PlayerId', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerData' => [ 'shape' => 'PlayerData', ], ], ], 'CreatePlayerSessionOutput' => [ 'type' => 'structure', 'members' => [ 'PlayerSession' => [ 'shape' => 'PlayerSession', ], ], ], 'CreatePlayerSessionsInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', 'PlayerIds', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'PlayerIds' => [ 'shape' => 'PlayerIdList', ], 'PlayerDataMap' => [ 'shape' => 'PlayerDataMap', ], ], ], 'CreatePlayerSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'PlayerSessions' => [ 'shape' => 'PlayerSessionList', ], ], ], 'CreateVpcPeeringAuthorizationInput' => [ 'type' => 'structure', 'required' => [ 'GameLiftAwsAccountId', 'PeerVpcId', ], 'members' => [ 'GameLiftAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'CreateVpcPeeringAuthorizationOutput' => [ 'type' => 'structure', 'members' => [ 'VpcPeeringAuthorization' => [ 'shape' => 'VpcPeeringAuthorization', ], ], ], 'CreateVpcPeeringConnectionInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'PeerVpcAwsAccountId', 'PeerVpcId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'PeerVpcAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'CreateVpcPeeringConnectionOutput' => [ 'type' => 'structure', 'members' => [], ], 'CustomEventData' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'DeleteAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], ], ], 'DeleteBuildInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], ], ], 'DeleteFleetInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DeleteGameSessionQueueInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], ], ], 'DeleteGameSessionQueueOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMatchmakingConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], ], ], 'DeleteMatchmakingConfigurationOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMatchmakingRuleSetInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], ], ], 'DeleteMatchmakingRuleSetOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'FleetId', ], 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DeleteVpcPeeringAuthorizationInput' => [ 'type' => 'structure', 'required' => [ 'GameLiftAwsAccountId', 'PeerVpcId', ], 'members' => [ 'GameLiftAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DeleteVpcPeeringAuthorizationOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVpcPeeringConnectionInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'VpcPeeringConnectionId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'VpcPeeringConnectionId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DeleteVpcPeeringConnectionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], ], ], 'DescribeAliasOutput' => [ 'type' => 'structure', 'members' => [ 'Alias' => [ 'shape' => 'Alias', ], ], ], 'DescribeBuildInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], ], ], 'DescribeBuildOutput' => [ 'type' => 'structure', 'members' => [ 'Build' => [ 'shape' => 'Build', ], ], ], 'DescribeEC2InstanceLimitsInput' => [ 'type' => 'structure', 'members' => [ 'EC2InstanceType' => [ 'shape' => 'EC2InstanceType', ], ], ], 'DescribeEC2InstanceLimitsOutput' => [ 'type' => 'structure', 'members' => [ 'EC2InstanceLimits' => [ 'shape' => 'EC2InstanceLimitList', ], ], ], 'DescribeFleetAttributesInput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetAttributesOutput' => [ 'type' => 'structure', 'members' => [ 'FleetAttributes' => [ 'shape' => 'FleetAttributesList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetCapacityInput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetCapacityOutput' => [ 'type' => 'structure', 'members' => [ 'FleetCapacity' => [ 'shape' => 'FleetCapacityList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetEventsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetEventsOutput' => [ 'type' => 'structure', 'members' => [ 'Events' => [ 'shape' => 'EventList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetPortSettingsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DescribeFleetPortSettingsOutput' => [ 'type' => 'structure', 'members' => [ 'InboundPermissions' => [ 'shape' => 'IpPermissionsList', ], ], ], 'DescribeFleetUtilizationInput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetUtilizationOutput' => [ 'type' => 'structure', 'members' => [ 'FleetUtilization' => [ 'shape' => 'FleetUtilizationList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionDetailsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'StatusFilter' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionDetailsOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionDetails' => [ 'shape' => 'GameSessionDetailList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionPlacementInput' => [ 'type' => 'structure', 'required' => [ 'PlacementId', ], 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], ], ], 'DescribeGameSessionPlacementOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionPlacement' => [ 'shape' => 'GameSessionPlacement', ], ], ], 'DescribeGameSessionQueuesInput' => [ 'type' => 'structure', 'members' => [ 'Names' => [ 'shape' => 'GameSessionQueueNameList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionQueuesOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionQueues' => [ 'shape' => 'GameSessionQueueList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'StatusFilter' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessions' => [ 'shape' => 'GameSessionList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeInstancesInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'Instances' => [ 'shape' => 'InstanceList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingConfigurationsInput' => [ 'type' => 'structure', 'members' => [ 'Names' => [ 'shape' => 'MatchmakingIdList', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'Configurations' => [ 'shape' => 'MatchmakingConfigurationList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingInput' => [ 'type' => 'structure', 'required' => [ 'TicketIds', ], 'members' => [ 'TicketIds' => [ 'shape' => 'MatchmakingIdList', ], ], ], 'DescribeMatchmakingOutput' => [ 'type' => 'structure', 'members' => [ 'TicketList' => [ 'shape' => 'MatchmakingTicketList', ], ], ], 'DescribeMatchmakingRuleSetsInput' => [ 'type' => 'structure', 'members' => [ 'Names' => [ 'shape' => 'MatchmakingRuleSetNameList', ], 'Limit' => [ 'shape' => 'RuleSetLimit', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingRuleSetsOutput' => [ 'type' => 'structure', 'required' => [ 'RuleSets', ], 'members' => [ 'RuleSets' => [ 'shape' => 'MatchmakingRuleSetList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribePlayerSessionsInput' => [ 'type' => 'structure', 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], 'PlayerSessionStatusFilter' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribePlayerSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'PlayerSessions' => [ 'shape' => 'PlayerSessionList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeRuntimeConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DescribeRuntimeConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], ], ], 'DescribeScalingPoliciesInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'StatusFilter' => [ 'shape' => 'ScalingStatusType', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeScalingPoliciesOutput' => [ 'type' => 'structure', 'members' => [ 'ScalingPolicies' => [ 'shape' => 'ScalingPolicyList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeVpcPeeringAuthorizationsInput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeVpcPeeringAuthorizationsOutput' => [ 'type' => 'structure', 'members' => [ 'VpcPeeringAuthorizations' => [ 'shape' => 'VpcPeeringAuthorizationList', ], ], ], 'DescribeVpcPeeringConnectionsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DescribeVpcPeeringConnectionsOutput' => [ 'type' => 'structure', 'members' => [ 'VpcPeeringConnections' => [ 'shape' => 'VpcPeeringConnectionList', ], ], ], 'DesiredPlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerData' => [ 'shape' => 'PlayerData', ], ], ], 'DesiredPlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredPlayerSession', ], ], 'Double' => [ 'type' => 'double', ], 'DoubleObject' => [ 'type' => 'double', ], 'EC2InstanceCounts' => [ 'type' => 'structure', 'members' => [ 'DESIRED' => [ 'shape' => 'WholeNumber', ], 'MINIMUM' => [ 'shape' => 'WholeNumber', ], 'MAXIMUM' => [ 'shape' => 'WholeNumber', ], 'PENDING' => [ 'shape' => 'WholeNumber', ], 'ACTIVE' => [ 'shape' => 'WholeNumber', ], 'IDLE' => [ 'shape' => 'WholeNumber', ], 'TERMINATING' => [ 'shape' => 'WholeNumber', ], ], ], 'EC2InstanceLimit' => [ 'type' => 'structure', 'members' => [ 'EC2InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'CurrentInstances' => [ 'shape' => 'WholeNumber', ], 'InstanceLimit' => [ 'shape' => 'WholeNumber', ], ], ], 'EC2InstanceLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2InstanceLimit', ], ], 'EC2InstanceType' => [ 'type' => 'string', 'enum' => [ 't2.micro', 't2.small', 't2.medium', 't2.large', 'c3.large', 'c3.xlarge', 'c3.2xlarge', 'c3.4xlarge', 'c3.8xlarge', 'c4.large', 'c4.xlarge', 'c4.2xlarge', 'c4.4xlarge', 'c4.8xlarge', 'r3.large', 'r3.xlarge', 'r3.2xlarge', 'r3.4xlarge', 'r3.8xlarge', 'r4.large', 'r4.xlarge', 'r4.2xlarge', 'r4.4xlarge', 'r4.8xlarge', 'r4.16xlarge', 'm3.medium', 'm3.large', 'm3.xlarge', 'm3.2xlarge', 'm4.large', 'm4.xlarge', 'm4.2xlarge', 'm4.4xlarge', 'm4.10xlarge', ], ], 'Event' => [ 'type' => 'structure', 'members' => [ 'EventId' => [ 'shape' => 'NonZeroAndMaxString', ], 'ResourceId' => [ 'shape' => 'NonZeroAndMaxString', ], 'EventCode' => [ 'shape' => 'EventCode', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'EventTime' => [ 'shape' => 'Timestamp', ], 'PreSignedLogUrl' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'EventCode' => [ 'type' => 'string', 'enum' => [ 'GENERIC_EVENT', 'FLEET_CREATED', 'FLEET_DELETED', 'FLEET_SCALING_EVENT', 'FLEET_STATE_DOWNLOADING', 'FLEET_STATE_VALIDATING', 'FLEET_STATE_BUILDING', 'FLEET_STATE_ACTIVATING', 'FLEET_STATE_ACTIVE', 'FLEET_STATE_ERROR', 'FLEET_INITIALIZATION_FAILED', 'FLEET_BINARY_DOWNLOAD_FAILED', 'FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND', 'FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE', 'FLEET_VALIDATION_TIMED_OUT', 'FLEET_ACTIVATION_FAILED', 'FLEET_ACTIVATION_FAILED_NO_INSTANCES', 'FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED', 'SERVER_PROCESS_INVALID_PATH', 'SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT', 'SERVER_PROCESS_PROCESS_READY_TIMEOUT', 'SERVER_PROCESS_CRASHED', 'SERVER_PROCESS_TERMINATED_UNHEALTHY', 'SERVER_PROCESS_FORCE_TERMINATED', 'SERVER_PROCESS_PROCESS_EXIT_TIMEOUT', 'GAME_SESSION_ACTIVATION_TIMEOUT', 'FLEET_CREATION_EXTRACTING_BUILD', 'FLEET_CREATION_RUNNING_INSTALLER', 'FLEET_CREATION_VALIDATING_RUNTIME_CONFIG', 'FLEET_VPC_PEERING_SUCCEEDED', 'FLEET_VPC_PEERING_FAILED', 'FLEET_VPC_PEERING_DELETED', 'INSTANCE_INTERRUPTED', ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', ], ], 'FleetAction' => [ 'type' => 'string', 'enum' => [ 'AUTO_SCALING', ], ], 'FleetActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetAction', ], 'max' => 1, 'min' => 1, ], 'FleetAttributes' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'FleetArn' => [ 'shape' => 'ArnStringModel', ], 'FleetType' => [ 'shape' => 'FleetType', ], 'InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TerminationTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'FleetStatus', ], 'BuildId' => [ 'shape' => 'BuildId', ], 'ServerLaunchPath' => [ 'shape' => 'NonZeroAndMaxString', ], 'ServerLaunchParameters' => [ 'shape' => 'NonZeroAndMaxString', ], 'LogPaths' => [ 'shape' => 'StringList', ], 'NewGameSessionProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'ResourceCreationLimitPolicy' => [ 'shape' => 'ResourceCreationLimitPolicy', ], 'MetricGroups' => [ 'shape' => 'MetricGroupList', ], 'StoppedActions' => [ 'shape' => 'FleetActionList', ], ], ], 'FleetAttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetAttributes', ], ], 'FleetCapacity' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'InstanceCounts' => [ 'shape' => 'EC2InstanceCounts', ], ], ], 'FleetCapacityExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'FleetCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetCapacity', ], ], 'FleetId' => [ 'type' => 'string', 'pattern' => '^fleet-\\S+', ], 'FleetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetId', ], 'min' => 1, ], 'FleetStatus' => [ 'type' => 'string', 'enum' => [ 'NEW', 'DOWNLOADING', 'VALIDATING', 'BUILDING', 'ACTIVATING', 'ACTIVE', 'DELETING', 'ERROR', 'TERMINATED', ], ], 'FleetType' => [ 'type' => 'string', 'enum' => [ 'ON_DEMAND', 'SPOT', ], ], 'FleetUtilization' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'ActiveServerProcessCount' => [ 'shape' => 'WholeNumber', ], 'ActiveGameSessionCount' => [ 'shape' => 'WholeNumber', ], 'CurrentPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], ], ], 'FleetUtilizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetUtilization', ], ], 'Float' => [ 'type' => 'float', ], 'FreeText' => [ 'type' => 'string', ], 'GameProperty' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'GamePropertyKey', ], 'Value' => [ 'shape' => 'GamePropertyValue', ], ], ], 'GamePropertyKey' => [ 'type' => 'string', 'max' => 32, ], 'GamePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameProperty', ], 'max' => 16, ], 'GamePropertyValue' => [ 'type' => 'string', 'max' => 96, ], 'GameSession' => [ 'type' => 'structure', 'members' => [ 'GameSessionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TerminationTime' => [ 'shape' => 'Timestamp', ], 'CurrentPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'Status' => [ 'shape' => 'GameSessionStatus', ], 'StatusReason' => [ 'shape' => 'GameSessionStatusReason', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Port' => [ 'shape' => 'PortNumber', ], 'PlayerSessionCreationPolicy' => [ 'shape' => 'PlayerSessionCreationPolicy', ], 'CreatorId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], 'MatchmakerData' => [ 'shape' => 'MatchmakerData', ], ], ], 'GameSessionActivationTimeoutSeconds' => [ 'type' => 'integer', 'max' => 600, 'min' => 1, ], 'GameSessionConnectionInfo' => [ 'type' => 'structure', 'members' => [ 'GameSessionArn' => [ 'shape' => 'ArnStringModel', ], 'IpAddress' => [ 'shape' => 'StringModel', ], 'Port' => [ 'shape' => 'PositiveInteger', ], 'MatchedPlayerSessions' => [ 'shape' => 'MatchedPlayerSessionList', ], ], ], 'GameSessionData' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'GameSessionDetail' => [ 'type' => 'structure', 'members' => [ 'GameSession' => [ 'shape' => 'GameSession', ], 'ProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], ], ], 'GameSessionDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionDetail', ], ], 'GameSessionFullException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'GameSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSession', ], ], 'GameSessionPlacement' => [ 'type' => 'structure', 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], 'GameSessionQueueName' => [ 'shape' => 'GameSessionQueueName', ], 'Status' => [ 'shape' => 'GameSessionPlacementState', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'GameSessionName' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionArn' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionRegion' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerLatencies' => [ 'shape' => 'PlayerLatencyList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Port' => [ 'shape' => 'PortNumber', ], 'PlacedPlayerSessions' => [ 'shape' => 'PlacedPlayerSessionList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], 'MatchmakerData' => [ 'shape' => 'MatchmakerData', ], ], ], 'GameSessionPlacementState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'FULFILLED', 'CANCELLED', 'TIMED_OUT', ], ], 'GameSessionQueue' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], 'GameSessionQueueArn' => [ 'shape' => 'ArnStringModel', ], 'TimeoutInSeconds' => [ 'shape' => 'WholeNumber', ], 'PlayerLatencyPolicies' => [ 'shape' => 'PlayerLatencyPolicyList', ], 'Destinations' => [ 'shape' => 'GameSessionQueueDestinationList', ], ], ], 'GameSessionQueueDestination' => [ 'type' => 'structure', 'members' => [ 'DestinationArn' => [ 'shape' => 'ArnStringModel', ], ], ], 'GameSessionQueueDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionQueueDestination', ], ], 'GameSessionQueueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionQueue', ], ], 'GameSessionQueueName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9-]+', ], 'GameSessionQueueNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionQueueName', ], ], 'GameSessionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'ACTIVATING', 'TERMINATED', 'TERMINATING', 'ERROR', ], ], 'GameSessionStatusReason' => [ 'type' => 'string', 'enum' => [ 'INTERRUPTED', ], ], 'GetGameSessionLogUrlInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], ], ], 'GetGameSessionLogUrlOutput' => [ 'type' => 'structure', 'members' => [ 'PreSignedUrl' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'GetInstanceAccessInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'InstanceId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], ], ], 'GetInstanceAccessOutput' => [ 'type' => 'structure', 'members' => [ 'InstanceAccess' => [ 'shape' => 'InstanceAccess', ], ], ], 'IdStringModel' => [ 'type' => 'string', 'max' => 48, 'min' => 1, 'pattern' => '[a-zA-Z0-9-]+', ], 'IdempotentParameterMismatchException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'Type' => [ 'shape' => 'EC2InstanceType', ], 'Status' => [ 'shape' => 'InstanceStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'InstanceAccess' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'Credentials' => [ 'shape' => 'InstanceCredentials', ], ], ], 'InstanceCredentials' => [ 'type' => 'structure', 'members' => [ 'UserName' => [ 'shape' => 'NonEmptyString', ], 'Secret' => [ 'shape' => 'NonEmptyString', ], ], 'sensitive' => true, ], 'InstanceId' => [ 'type' => 'string', 'pattern' => '[a-zA-Z0-9\\.-]+', ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ACTIVE', 'TERMINATING', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServiceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, 'fault' => true, ], 'InvalidFleetStatusException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'InvalidGameSessionStatusException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', ], 'IpPermission' => [ 'type' => 'structure', 'required' => [ 'FromPort', 'ToPort', 'IpRange', 'Protocol', ], 'members' => [ 'FromPort' => [ 'shape' => 'PortNumber', ], 'ToPort' => [ 'shape' => 'PortNumber', ], 'IpRange' => [ 'shape' => 'NonBlankString', ], 'Protocol' => [ 'shape' => 'IpProtocol', ], ], ], 'IpPermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpPermission', ], 'max' => 50, ], 'IpProtocol' => [ 'type' => 'string', 'enum' => [ 'TCP', 'UDP', ], ], 'LatencyMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonEmptyString', ], 'value' => [ 'shape' => 'PositiveInteger', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'ListAliasesInput' => [ 'type' => 'structure', 'members' => [ 'RoutingStrategyType' => [ 'shape' => 'RoutingStrategyType', ], 'Name' => [ 'shape' => 'NonEmptyString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListAliasesOutput' => [ 'type' => 'structure', 'members' => [ 'Aliases' => [ 'shape' => 'AliasList', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListBuildsInput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BuildStatus', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListBuildsOutput' => [ 'type' => 'structure', 'members' => [ 'Builds' => [ 'shape' => 'BuildList', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListFleetsInput' => [ 'type' => 'structure', 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'ListFleetsOutput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'MatchedPlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], ], ], 'MatchedPlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchedPlayerSession', ], ], 'MatchmakerData' => [ 'type' => 'string', 'max' => 390000, 'min' => 1, ], 'MatchmakingAcceptanceTimeoutInteger' => [ 'type' => 'integer', 'max' => 600, 'min' => 1, ], 'MatchmakingConfiguration' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionQueueArns' => [ 'shape' => 'QueueArnsList', ], 'RequestTimeoutSeconds' => [ 'shape' => 'MatchmakingRequestTimeoutInteger', ], 'AcceptanceTimeoutSeconds' => [ 'shape' => 'MatchmakingAcceptanceTimeoutInteger', ], 'AcceptanceRequired' => [ 'shape' => 'BooleanModel', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'NotificationTarget' => [ 'shape' => 'SnsArnStringModel', ], 'AdditionalPlayerCount' => [ 'shape' => 'WholeNumber', ], 'CustomEventData' => [ 'shape' => 'CustomEventData', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'MatchmakingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingConfiguration', ], ], 'MatchmakingConfigurationStatus' => [ 'type' => 'string', 'enum' => [ 'CANCELLED', 'COMPLETED', 'FAILED', 'PLACING', 'QUEUED', 'REQUIRES_ACCEPTANCE', 'SEARCHING', 'TIMED_OUT', ], ], 'MatchmakingIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingIdStringModel', ], ], 'MatchmakingIdStringModel' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9-\\.]+', ], 'MatchmakingRequestTimeoutInteger' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1, ], 'MatchmakingRuleSet' => [ 'type' => 'structure', 'required' => [ 'RuleSetBody', ], 'members' => [ 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'RuleSetBody' => [ 'shape' => 'RuleSetBody', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'MatchmakingRuleSetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingRuleSet', ], ], 'MatchmakingRuleSetNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingIdStringModel', ], 'max' => 10, 'min' => 1, ], 'MatchmakingTicket' => [ 'type' => 'structure', 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'ConfigurationName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Status' => [ 'shape' => 'MatchmakingConfigurationStatus', ], 'StatusReason' => [ 'shape' => 'StringModel', ], 'StatusMessage' => [ 'shape' => 'StringModel', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Players' => [ 'shape' => 'PlayerList', ], 'GameSessionConnectionInfo' => [ 'shape' => 'GameSessionConnectionInfo', ], 'EstimatedWaitTime' => [ 'shape' => 'WholeNumber', ], ], ], 'MatchmakingTicketList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingTicket', ], ], 'MaxConcurrentGameSessionActivations' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => 1, ], 'MetricGroup' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'MetricGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricGroup', ], 'max' => 1, ], 'MetricName' => [ 'type' => 'string', 'enum' => [ 'ActivatingGameSessions', 'ActiveGameSessions', 'ActiveInstances', 'AvailableGameSessions', 'AvailablePlayerSessions', 'CurrentPlayerSessions', 'IdleInstances', 'PercentAvailableGameSessions', 'PercentIdleInstances', 'QueueDepth', 'WaitTime', ], ], 'NonBlankAndLengthConstraintString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '[^\\s]+', ], 'NonEmptyString' => [ 'type' => 'string', 'min' => 1, ], 'NonZeroAndMaxString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'OperatingSystem' => [ 'type' => 'string', 'enum' => [ 'WINDOWS_2012', 'AMAZON_LINUX', ], ], 'PlacedPlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], ], ], 'PlacedPlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacedPlayerSession', ], ], 'Player' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerAttributes' => [ 'shape' => 'PlayerAttributeMap', ], 'Team' => [ 'shape' => 'NonZeroAndMaxString', ], 'LatencyInMs' => [ 'shape' => 'LatencyMap', ], ], ], 'PlayerAttributeMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonZeroAndMaxString', ], 'value' => [ 'shape' => 'AttributeValue', ], ], 'PlayerData' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'PlayerDataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonZeroAndMaxString', ], 'value' => [ 'shape' => 'PlayerData', ], ], 'PlayerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonZeroAndMaxString', ], 'max' => 25, 'min' => 1, ], 'PlayerLatency' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'RegionIdentifier' => [ 'shape' => 'NonZeroAndMaxString', ], 'LatencyInMilliseconds' => [ 'shape' => 'Float', ], ], ], 'PlayerLatencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlayerLatency', ], ], 'PlayerLatencyPolicy' => [ 'type' => 'structure', 'members' => [ 'MaximumIndividualPlayerLatencyMilliseconds' => [ 'shape' => 'WholeNumber', ], 'PolicyDurationSeconds' => [ 'shape' => 'WholeNumber', ], ], ], 'PlayerLatencyPolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlayerLatencyPolicy', ], ], 'PlayerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Player', ], ], 'PlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TerminationTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'PlayerSessionStatus', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Port' => [ 'shape' => 'PortNumber', ], 'PlayerData' => [ 'shape' => 'PlayerData', ], ], ], 'PlayerSessionCreationPolicy' => [ 'type' => 'string', 'enum' => [ 'ACCEPT_ALL', 'DENY_ALL', ], ], 'PlayerSessionId' => [ 'type' => 'string', 'pattern' => '^psess-\\S+', ], 'PlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlayerSession', ], ], 'PlayerSessionStatus' => [ 'type' => 'string', 'enum' => [ 'RESERVED', 'ACTIVE', 'COMPLETED', 'TIMEDOUT', ], ], 'PolicyType' => [ 'type' => 'string', 'enum' => [ 'RuleBased', 'TargetBased', ], ], 'PortNumber' => [ 'type' => 'integer', 'max' => 60000, 'min' => 1, ], 'PositiveInteger' => [ 'type' => 'integer', 'min' => 1, ], 'PositiveLong' => [ 'type' => 'long', 'min' => 1, ], 'ProtectionPolicy' => [ 'type' => 'string', 'enum' => [ 'NoProtection', 'FullProtection', ], ], 'PutScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'FleetId', 'MetricName', ], 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'ScalingAdjustment' => [ 'shape' => 'Integer', ], 'ScalingAdjustmentType' => [ 'shape' => 'ScalingAdjustmentType', ], 'Threshold' => [ 'shape' => 'Double', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperatorType', ], 'EvaluationPeriods' => [ 'shape' => 'PositiveInteger', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'PolicyType' => [ 'shape' => 'PolicyType', ], 'TargetConfiguration' => [ 'shape' => 'TargetConfiguration', ], ], ], 'PutScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'QueueArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArnStringModel', ], ], 'RequestUploadCredentialsInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], ], ], 'RequestUploadCredentialsOutput' => [ 'type' => 'structure', 'members' => [ 'UploadCredentials' => [ 'shape' => 'AwsCredentials', ], 'StorageLocation' => [ 'shape' => 'S3Location', ], ], ], 'ResolveAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], ], ], 'ResolveAliasOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'ResourceCreationLimitPolicy' => [ 'type' => 'structure', 'members' => [ 'NewGameSessionsPerCreator' => [ 'shape' => 'WholeNumber', ], 'PolicyPeriodInMinutes' => [ 'shape' => 'WholeNumber', ], ], ], 'RoutingStrategy' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'RoutingStrategyType', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'Message' => [ 'shape' => 'FreeText', ], ], ], 'RoutingStrategyType' => [ 'type' => 'string', 'enum' => [ 'SIMPLE', 'TERMINAL', ], ], 'RuleSetBody' => [ 'type' => 'string', 'max' => 65535, 'min' => 1, ], 'RuleSetLimit' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'RuntimeConfiguration' => [ 'type' => 'structure', 'members' => [ 'ServerProcesses' => [ 'shape' => 'ServerProcessList', ], 'MaxConcurrentGameSessionActivations' => [ 'shape' => 'MaxConcurrentGameSessionActivations', ], 'GameSessionActivationTimeoutSeconds' => [ 'shape' => 'GameSessionActivationTimeoutSeconds', ], ], ], 'S3Location' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'NonEmptyString', ], 'Key' => [ 'shape' => 'NonEmptyString', ], 'RoleArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'ScalingAdjustmentType' => [ 'type' => 'string', 'enum' => [ 'ChangeInCapacity', 'ExactCapacity', 'PercentChangeInCapacity', ], ], 'ScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Status' => [ 'shape' => 'ScalingStatusType', ], 'ScalingAdjustment' => [ 'shape' => 'Integer', ], 'ScalingAdjustmentType' => [ 'shape' => 'ScalingAdjustmentType', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperatorType', ], 'Threshold' => [ 'shape' => 'Double', ], 'EvaluationPeriods' => [ 'shape' => 'PositiveInteger', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'PolicyType' => [ 'shape' => 'PolicyType', ], 'TargetConfiguration' => [ 'shape' => 'TargetConfiguration', ], ], ], 'ScalingPolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingPolicy', ], ], 'ScalingStatusType' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'UPDATE_REQUESTED', 'UPDATING', 'DELETE_REQUESTED', 'DELETING', 'DELETED', 'ERROR', ], ], 'SearchGameSessionsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'FilterExpression' => [ 'shape' => 'NonZeroAndMaxString', ], 'SortExpression' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'SearchGameSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessions' => [ 'shape' => 'GameSessionList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'ServerProcess' => [ 'type' => 'structure', 'required' => [ 'LaunchPath', 'ConcurrentExecutions', ], 'members' => [ 'LaunchPath' => [ 'shape' => 'NonZeroAndMaxString', ], 'Parameters' => [ 'shape' => 'NonZeroAndMaxString', ], 'ConcurrentExecutions' => [ 'shape' => 'PositiveInteger', ], ], ], 'ServerProcessList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerProcess', ], 'max' => 50, 'min' => 1, ], 'SnsArnStringModel' => [ 'type' => 'string', 'max' => 300, 'min' => 0, 'pattern' => '[a-zA-Z0-9:_/-]*', ], 'StartFleetActionsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'Actions', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Actions' => [ 'shape' => 'FleetActionList', ], ], ], 'StartFleetActionsOutput' => [ 'type' => 'structure', 'members' => [], ], 'StartGameSessionPlacementInput' => [ 'type' => 'structure', 'required' => [ 'PlacementId', 'GameSessionQueueName', 'MaximumPlayerSessionCount', ], 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], 'GameSessionQueueName' => [ 'shape' => 'GameSessionQueueName', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'GameSessionName' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerLatencies' => [ 'shape' => 'PlayerLatencyList', ], 'DesiredPlayerSessions' => [ 'shape' => 'DesiredPlayerSessionList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'StartGameSessionPlacementOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionPlacement' => [ 'shape' => 'GameSessionPlacement', ], ], ], 'StartMatchBackfillInput' => [ 'type' => 'structure', 'required' => [ 'ConfigurationName', 'GameSessionArn', 'Players', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'ConfigurationName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'GameSessionArn' => [ 'shape' => 'ArnStringModel', ], 'Players' => [ 'shape' => 'PlayerList', ], ], ], 'StartMatchBackfillOutput' => [ 'type' => 'structure', 'members' => [ 'MatchmakingTicket' => [ 'shape' => 'MatchmakingTicket', ], ], ], 'StartMatchmakingInput' => [ 'type' => 'structure', 'required' => [ 'ConfigurationName', 'Players', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'ConfigurationName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Players' => [ 'shape' => 'PlayerList', ], ], ], 'StartMatchmakingOutput' => [ 'type' => 'structure', 'members' => [ 'MatchmakingTicket' => [ 'shape' => 'MatchmakingTicket', ], ], ], 'StopFleetActionsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'Actions', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Actions' => [ 'shape' => 'FleetActionList', ], ], ], 'StopFleetActionsOutput' => [ 'type' => 'structure', 'members' => [], ], 'StopGameSessionPlacementInput' => [ 'type' => 'structure', 'required' => [ 'PlacementId', ], 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], ], ], 'StopGameSessionPlacementOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionPlacement' => [ 'shape' => 'GameSessionPlacement', ], ], ], 'StopMatchmakingInput' => [ 'type' => 'structure', 'required' => [ 'TicketId', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], ], ], 'StopMatchmakingOutput' => [ 'type' => 'structure', 'members' => [], ], 'StringDoubleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonZeroAndMaxString', ], 'value' => [ 'shape' => 'DoubleObject', ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonZeroAndMaxString', ], ], 'StringModel' => [ 'type' => 'string', ], 'TargetConfiguration' => [ 'type' => 'structure', 'required' => [ 'TargetValue', ], 'members' => [ 'TargetValue' => [ 'shape' => 'Double', ], ], ], 'TerminalRoutingStrategyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UnauthorizedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'UnsupportedRegionException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'UpdateAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], 'Name' => [ 'shape' => 'NonBlankAndLengthConstraintString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'UpdateAliasOutput' => [ 'type' => 'structure', 'members' => [ 'Alias' => [ 'shape' => 'Alias', ], ], ], 'UpdateBuildInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Version' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'UpdateBuildOutput' => [ 'type' => 'structure', 'members' => [ 'Build' => [ 'shape' => 'Build', ], ], ], 'UpdateFleetAttributesInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'NewGameSessionProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], 'ResourceCreationLimitPolicy' => [ 'shape' => 'ResourceCreationLimitPolicy', ], 'MetricGroups' => [ 'shape' => 'MetricGroupList', ], ], ], 'UpdateFleetAttributesOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'UpdateFleetCapacityInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'DesiredInstances' => [ 'shape' => 'WholeNumber', ], 'MinSize' => [ 'shape' => 'WholeNumber', ], 'MaxSize' => [ 'shape' => 'WholeNumber', ], ], ], 'UpdateFleetCapacityOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'UpdateFleetPortSettingsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InboundPermissionAuthorizations' => [ 'shape' => 'IpPermissionsList', ], 'InboundPermissionRevocations' => [ 'shape' => 'IpPermissionsList', ], ], ], 'UpdateFleetPortSettingsOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'UpdateGameSessionInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionCreationPolicy' => [ 'shape' => 'PlayerSessionCreationPolicy', ], 'ProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], ], ], 'UpdateGameSessionOutput' => [ 'type' => 'structure', 'members' => [ 'GameSession' => [ 'shape' => 'GameSession', ], ], ], 'UpdateGameSessionQueueInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], 'TimeoutInSeconds' => [ 'shape' => 'WholeNumber', ], 'PlayerLatencyPolicies' => [ 'shape' => 'PlayerLatencyPolicyList', ], 'Destinations' => [ 'shape' => 'GameSessionQueueDestinationList', ], ], ], 'UpdateGameSessionQueueOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionQueue' => [ 'shape' => 'GameSessionQueue', ], ], ], 'UpdateMatchmakingConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionQueueArns' => [ 'shape' => 'QueueArnsList', ], 'RequestTimeoutSeconds' => [ 'shape' => 'MatchmakingRequestTimeoutInteger', ], 'AcceptanceTimeoutSeconds' => [ 'shape' => 'MatchmakingAcceptanceTimeoutInteger', ], 'AcceptanceRequired' => [ 'shape' => 'BooleanModel', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'NotificationTarget' => [ 'shape' => 'SnsArnStringModel', ], 'AdditionalPlayerCount' => [ 'shape' => 'WholeNumber', ], 'CustomEventData' => [ 'shape' => 'CustomEventData', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'UpdateMatchmakingConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Configuration' => [ 'shape' => 'MatchmakingConfiguration', ], ], ], 'UpdateRuntimeConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'RuntimeConfiguration', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], ], ], 'UpdateRuntimeConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], ], ], 'ValidateMatchmakingRuleSetInput' => [ 'type' => 'structure', 'required' => [ 'RuleSetBody', ], 'members' => [ 'RuleSetBody' => [ 'shape' => 'RuleSetBody', ], ], ], 'ValidateMatchmakingRuleSetOutput' => [ 'type' => 'structure', 'members' => [ 'Valid' => [ 'shape' => 'BooleanModel', ], ], ], 'VpcPeeringAuthorization' => [ 'type' => 'structure', 'members' => [ 'GameLiftAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ExpirationTime' => [ 'shape' => 'Timestamp', ], ], ], 'VpcPeeringAuthorizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcPeeringAuthorization', ], ], 'VpcPeeringConnection' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'IpV4CidrBlock' => [ 'shape' => 'NonZeroAndMaxString', ], 'VpcPeeringConnectionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'Status' => [ 'shape' => 'VpcPeeringConnectionStatus', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameLiftVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'VpcPeeringConnectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcPeeringConnection', ], ], 'VpcPeeringConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'NonZeroAndMaxString', ], 'Message' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'WholeNumber' => [ 'type' => 'integer', 'min' => 0, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2015-10-01', 'endpointPrefix' => 'gamelift', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon GameLift', 'serviceId' => 'GameLift', 'signatureVersion' => 'v4', 'targetPrefix' => 'GameLift', 'uid' => 'gamelift-2015-10-01', ], 'operations' => [ 'AcceptMatch' => [ 'name' => 'AcceptMatch', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AcceptMatchInput', ], 'output' => [ 'shape' => 'AcceptMatchOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'CreateAlias' => [ 'name' => 'CreateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAliasInput', ], 'output' => [ 'shape' => 'CreateAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateBuild' => [ 'name' => 'CreateBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBuildInput', ], 'output' => [ 'shape' => 'CreateBuildOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateFleet' => [ 'name' => 'CreateFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFleetInput', ], 'output' => [ 'shape' => 'CreateFleetOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'CreateGameSession' => [ 'name' => 'CreateGameSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGameSessionInput', ], 'output' => [ 'shape' => 'CreateGameSessionOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'FleetCapacityExceededException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'IdempotentParameterMismatchException', ], ], ], 'CreateGameSessionQueue' => [ 'name' => 'CreateGameSessionQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGameSessionQueueInput', ], 'output' => [ 'shape' => 'CreateGameSessionQueueOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateMatchmakingConfiguration' => [ 'name' => 'CreateMatchmakingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMatchmakingConfigurationInput', ], 'output' => [ 'shape' => 'CreateMatchmakingConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'CreateMatchmakingRuleSet' => [ 'name' => 'CreateMatchmakingRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMatchmakingRuleSetInput', ], 'output' => [ 'shape' => 'CreateMatchmakingRuleSetOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'CreatePlayerSession' => [ 'name' => 'CreatePlayerSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePlayerSessionInput', ], 'output' => [ 'shape' => 'CreatePlayerSessionOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidGameSessionStatusException', ], [ 'shape' => 'GameSessionFullException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], ], ], 'CreatePlayerSessions' => [ 'name' => 'CreatePlayerSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePlayerSessionsInput', ], 'output' => [ 'shape' => 'CreatePlayerSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidGameSessionStatusException', ], [ 'shape' => 'GameSessionFullException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], ], ], 'CreateVpcPeeringAuthorization' => [ 'name' => 'CreateVpcPeeringAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVpcPeeringAuthorizationInput', ], 'output' => [ 'shape' => 'CreateVpcPeeringAuthorizationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateVpcPeeringConnection' => [ 'name' => 'CreateVpcPeeringConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVpcPeeringConnectionInput', ], 'output' => [ 'shape' => 'CreateVpcPeeringConnectionOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteAlias' => [ 'name' => 'DeleteAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAliasInput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteBuild' => [ 'name' => 'DeleteBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBuildInput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteFleet' => [ 'name' => 'DeleteFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFleetInput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteGameSessionQueue' => [ 'name' => 'DeleteGameSessionQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGameSessionQueueInput', ], 'output' => [ 'shape' => 'DeleteGameSessionQueueOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DeleteMatchmakingConfiguration' => [ 'name' => 'DeleteMatchmakingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMatchmakingConfigurationInput', ], 'output' => [ 'shape' => 'DeleteMatchmakingConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DeleteMatchmakingRuleSet' => [ 'name' => 'DeleteMatchmakingRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMatchmakingRuleSetInput', ], 'output' => [ 'shape' => 'DeleteMatchmakingRuleSetOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteScalingPolicy' => [ 'name' => 'DeleteScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteScalingPolicyInput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteVpcPeeringAuthorization' => [ 'name' => 'DeleteVpcPeeringAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVpcPeeringAuthorizationInput', ], 'output' => [ 'shape' => 'DeleteVpcPeeringAuthorizationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteVpcPeeringConnection' => [ 'name' => 'DeleteVpcPeeringConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVpcPeeringConnectionInput', ], 'output' => [ 'shape' => 'DeleteVpcPeeringConnectionOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeAlias' => [ 'name' => 'DescribeAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAliasInput', ], 'output' => [ 'shape' => 'DescribeAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeBuild' => [ 'name' => 'DescribeBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBuildInput', ], 'output' => [ 'shape' => 'DescribeBuildOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeEC2InstanceLimits' => [ 'name' => 'DescribeEC2InstanceLimits', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEC2InstanceLimitsInput', ], 'output' => [ 'shape' => 'DescribeEC2InstanceLimitsOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetAttributes' => [ 'name' => 'DescribeFleetAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetAttributesInput', ], 'output' => [ 'shape' => 'DescribeFleetAttributesOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetCapacity' => [ 'name' => 'DescribeFleetCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetCapacityInput', ], 'output' => [ 'shape' => 'DescribeFleetCapacityOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetEvents' => [ 'name' => 'DescribeFleetEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetEventsInput', ], 'output' => [ 'shape' => 'DescribeFleetEventsOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeFleetPortSettings' => [ 'name' => 'DescribeFleetPortSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetPortSettingsInput', ], 'output' => [ 'shape' => 'DescribeFleetPortSettingsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeFleetUtilization' => [ 'name' => 'DescribeFleetUtilization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFleetUtilizationInput', ], 'output' => [ 'shape' => 'DescribeFleetUtilizationOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeGameSessionDetails' => [ 'name' => 'DescribeGameSessionDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionDetailsInput', ], 'output' => [ 'shape' => 'DescribeGameSessionDetailsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], ], ], 'DescribeGameSessionPlacement' => [ 'name' => 'DescribeGameSessionPlacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionPlacementInput', ], 'output' => [ 'shape' => 'DescribeGameSessionPlacementOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeGameSessionQueues' => [ 'name' => 'DescribeGameSessionQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionQueuesInput', ], 'output' => [ 'shape' => 'DescribeGameSessionQueuesOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeGameSessions' => [ 'name' => 'DescribeGameSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGameSessionsInput', ], 'output' => [ 'shape' => 'DescribeGameSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], ], ], 'DescribeInstances' => [ 'name' => 'DescribeInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInstancesInput', ], 'output' => [ 'shape' => 'DescribeInstancesOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeMatchmaking' => [ 'name' => 'DescribeMatchmaking', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMatchmakingInput', ], 'output' => [ 'shape' => 'DescribeMatchmakingOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DescribeMatchmakingConfigurations' => [ 'name' => 'DescribeMatchmakingConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMatchmakingConfigurationsInput', ], 'output' => [ 'shape' => 'DescribeMatchmakingConfigurationsOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DescribeMatchmakingRuleSets' => [ 'name' => 'DescribeMatchmakingRuleSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMatchmakingRuleSetsInput', ], 'output' => [ 'shape' => 'DescribeMatchmakingRuleSetsOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'DescribePlayerSessions' => [ 'name' => 'DescribePlayerSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePlayerSessionsInput', ], 'output' => [ 'shape' => 'DescribePlayerSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'DescribeRuntimeConfiguration' => [ 'name' => 'DescribeRuntimeConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRuntimeConfigurationInput', ], 'output' => [ 'shape' => 'DescribeRuntimeConfigurationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeScalingPolicies' => [ 'name' => 'DescribeScalingPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeScalingPoliciesInput', ], 'output' => [ 'shape' => 'DescribeScalingPoliciesOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DescribeVpcPeeringAuthorizations' => [ 'name' => 'DescribeVpcPeeringAuthorizations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVpcPeeringAuthorizationsInput', ], 'output' => [ 'shape' => 'DescribeVpcPeeringAuthorizationsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeVpcPeeringConnections' => [ 'name' => 'DescribeVpcPeeringConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVpcPeeringConnectionsInput', ], 'output' => [ 'shape' => 'DescribeVpcPeeringConnectionsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetGameSessionLogUrl' => [ 'name' => 'GetGameSessionLogUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetGameSessionLogUrlInput', ], 'output' => [ 'shape' => 'GetGameSessionLogUrlOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetInstanceAccess' => [ 'name' => 'GetInstanceAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceAccessInput', ], 'output' => [ 'shape' => 'GetInstanceAccessOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesInput', ], 'output' => [ 'shape' => 'ListAliasesOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListBuilds' => [ 'name' => 'ListBuilds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBuildsInput', ], 'output' => [ 'shape' => 'ListBuildsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListFleets' => [ 'name' => 'ListFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFleetsInput', ], 'output' => [ 'shape' => 'ListFleetsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'PutScalingPolicy' => [ 'name' => 'PutScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutScalingPolicyInput', ], 'output' => [ 'shape' => 'PutScalingPolicyOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'RequestUploadCredentials' => [ 'name' => 'RequestUploadCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RequestUploadCredentialsInput', ], 'output' => [ 'shape' => 'RequestUploadCredentialsOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ResolveAlias' => [ 'name' => 'ResolveAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResolveAliasInput', ], 'output' => [ 'shape' => 'ResolveAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchGameSessions' => [ 'name' => 'SearchGameSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchGameSessionsInput', ], 'output' => [ 'shape' => 'SearchGameSessionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'TerminalRoutingStrategyException', ], ], ], 'StartFleetActions' => [ 'name' => 'StartFleetActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartFleetActionsInput', ], 'output' => [ 'shape' => 'StartFleetActionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'StartGameSessionPlacement' => [ 'name' => 'StartGameSessionPlacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartGameSessionPlacementInput', ], 'output' => [ 'shape' => 'StartGameSessionPlacementOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'StartMatchBackfill' => [ 'name' => 'StartMatchBackfill', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMatchBackfillInput', ], 'output' => [ 'shape' => 'StartMatchBackfillOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'StartMatchmaking' => [ 'name' => 'StartMatchmaking', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMatchmakingInput', ], 'output' => [ 'shape' => 'StartMatchmakingOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'StopFleetActions' => [ 'name' => 'StopFleetActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopFleetActionsInput', ], 'output' => [ 'shape' => 'StopFleetActionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'StopGameSessionPlacement' => [ 'name' => 'StopGameSessionPlacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopGameSessionPlacementInput', ], 'output' => [ 'shape' => 'StopGameSessionPlacementOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'StopMatchmaking' => [ 'name' => 'StopMatchmaking', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMatchmakingInput', ], 'output' => [ 'shape' => 'StopMatchmakingOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'UpdateAlias' => [ 'name' => 'UpdateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAliasInput', ], 'output' => [ 'shape' => 'UpdateAliasOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateBuild' => [ 'name' => 'UpdateBuild', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateBuildInput', ], 'output' => [ 'shape' => 'UpdateBuildOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateFleetAttributes' => [ 'name' => 'UpdateFleetAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFleetAttributesInput', ], 'output' => [ 'shape' => 'UpdateFleetAttributesOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateFleetCapacity' => [ 'name' => 'UpdateFleetCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFleetCapacityInput', ], 'output' => [ 'shape' => 'UpdateFleetCapacityOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateFleetPortSettings' => [ 'name' => 'UpdateFleetPortSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFleetPortSettingsInput', ], 'output' => [ 'shape' => 'UpdateFleetPortSettingsOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InvalidFleetStatusException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateGameSession' => [ 'name' => 'UpdateGameSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateGameSessionInput', ], 'output' => [ 'shape' => 'UpdateGameSessionOutput', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'InvalidGameSessionStatusException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'UpdateGameSessionQueue' => [ 'name' => 'UpdateGameSessionQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateGameSessionQueueInput', ], 'output' => [ 'shape' => 'UpdateGameSessionQueueOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthorizedException', ], ], ], 'UpdateMatchmakingConfiguration' => [ 'name' => 'UpdateMatchmakingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMatchmakingConfigurationInput', ], 'output' => [ 'shape' => 'UpdateMatchmakingConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], ], ], 'UpdateRuntimeConfiguration' => [ 'name' => 'UpdateRuntimeConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRuntimeConfigurationInput', ], 'output' => [ 'shape' => 'UpdateRuntimeConfigurationOutput', ], 'errors' => [ [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidFleetStatusException', ], ], ], 'ValidateMatchmakingRuleSet' => [ 'name' => 'ValidateMatchmakingRuleSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ValidateMatchmakingRuleSetInput', ], 'output' => [ 'shape' => 'ValidateMatchmakingRuleSetOutput', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'UnsupportedRegionException', ], [ 'shape' => 'InvalidRequestException', ], ], ], ], 'shapes' => [ 'AcceptMatchInput' => [ 'type' => 'structure', 'required' => [ 'TicketId', 'PlayerIds', 'AcceptanceType', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'PlayerIds' => [ 'shape' => 'StringList', ], 'AcceptanceType' => [ 'shape' => 'AcceptanceType', ], ], ], 'AcceptMatchOutput' => [ 'type' => 'structure', 'members' => [], ], 'AcceptanceType' => [ 'type' => 'string', 'enum' => [ 'ACCEPT', 'REJECT', ], ], 'Alias' => [ 'type' => 'structure', 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], 'Name' => [ 'shape' => 'NonBlankAndLengthConstraintString', ], 'AliasArn' => [ 'shape' => 'ArnStringModel', ], 'Description' => [ 'shape' => 'FreeText', ], 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AliasId' => [ 'type' => 'string', 'pattern' => '^alias-\\S+', ], 'AliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alias', ], ], 'ArnStringModel' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9:/-]+', ], 'AttributeValue' => [ 'type' => 'structure', 'members' => [ 'S' => [ 'shape' => 'NonZeroAndMaxString', ], 'N' => [ 'shape' => 'DoubleObject', ], 'SL' => [ 'shape' => 'StringList', ], 'SDM' => [ 'shape' => 'StringDoubleMap', ], ], ], 'AwsCredentials' => [ 'type' => 'structure', 'members' => [ 'AccessKeyId' => [ 'shape' => 'NonEmptyString', ], 'SecretAccessKey' => [ 'shape' => 'NonEmptyString', ], 'SessionToken' => [ 'shape' => 'NonEmptyString', ], ], 'sensitive' => true, ], 'BooleanModel' => [ 'type' => 'boolean', ], 'Build' => [ 'type' => 'structure', 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], 'Name' => [ 'shape' => 'FreeText', ], 'Version' => [ 'shape' => 'FreeText', ], 'Status' => [ 'shape' => 'BuildStatus', ], 'SizeOnDisk' => [ 'shape' => 'PositiveLong', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'BuildId' => [ 'type' => 'string', 'pattern' => '^build-\\S+', ], 'BuildList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Build', ], ], 'BuildStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'READY', 'FAILED', ], ], 'ComparisonOperatorType' => [ 'type' => 'string', 'enum' => [ 'GreaterThanOrEqualToThreshold', 'GreaterThanThreshold', 'LessThanThreshold', 'LessThanOrEqualToThreshold', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'CreateAliasInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'RoutingStrategy', ], 'members' => [ 'Name' => [ 'shape' => 'NonBlankAndLengthConstraintString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'CreateAliasOutput' => [ 'type' => 'structure', 'members' => [ 'Alias' => [ 'shape' => 'Alias', ], ], ], 'CreateBuildInput' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Version' => [ 'shape' => 'NonZeroAndMaxString', ], 'StorageLocation' => [ 'shape' => 'S3Location', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], ], ], 'CreateBuildOutput' => [ 'type' => 'structure', 'members' => [ 'Build' => [ 'shape' => 'Build', ], 'UploadCredentials' => [ 'shape' => 'AwsCredentials', ], 'StorageLocation' => [ 'shape' => 'S3Location', ], ], ], 'CreateFleetInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'BuildId', 'EC2InstanceType', ], 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'BuildId' => [ 'shape' => 'BuildId', ], 'ServerLaunchPath' => [ 'shape' => 'NonZeroAndMaxString', ], 'ServerLaunchParameters' => [ 'shape' => 'NonZeroAndMaxString', ], 'LogPaths' => [ 'shape' => 'StringList', ], 'EC2InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'EC2InboundPermissions' => [ 'shape' => 'IpPermissionsList', ], 'NewGameSessionProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], 'ResourceCreationLimitPolicy' => [ 'shape' => 'ResourceCreationLimitPolicy', ], 'MetricGroups' => [ 'shape' => 'MetricGroupList', ], 'PeerVpcAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetType' => [ 'shape' => 'FleetType', ], 'InstanceRoleArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'CreateFleetOutput' => [ 'type' => 'structure', 'members' => [ 'FleetAttributes' => [ 'shape' => 'FleetAttributes', ], ], ], 'CreateGameSessionInput' => [ 'type' => 'structure', 'required' => [ 'MaximumPlayerSessionCount', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'CreatorId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionId' => [ 'shape' => 'IdStringModel', ], 'IdempotencyToken' => [ 'shape' => 'IdStringModel', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'CreateGameSessionOutput' => [ 'type' => 'structure', 'members' => [ 'GameSession' => [ 'shape' => 'GameSession', ], ], ], 'CreateGameSessionQueueInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], 'TimeoutInSeconds' => [ 'shape' => 'WholeNumber', ], 'PlayerLatencyPolicies' => [ 'shape' => 'PlayerLatencyPolicyList', ], 'Destinations' => [ 'shape' => 'GameSessionQueueDestinationList', ], ], ], 'CreateGameSessionQueueOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionQueue' => [ 'shape' => 'GameSessionQueue', ], ], ], 'CreateMatchmakingConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'GameSessionQueueArns', 'RequestTimeoutSeconds', 'AcceptanceRequired', 'RuleSetName', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionQueueArns' => [ 'shape' => 'QueueArnsList', ], 'RequestTimeoutSeconds' => [ 'shape' => 'MatchmakingRequestTimeoutInteger', ], 'AcceptanceTimeoutSeconds' => [ 'shape' => 'MatchmakingAcceptanceTimeoutInteger', ], 'AcceptanceRequired' => [ 'shape' => 'BooleanModel', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'NotificationTarget' => [ 'shape' => 'SnsArnStringModel', ], 'AdditionalPlayerCount' => [ 'shape' => 'WholeNumber', ], 'CustomEventData' => [ 'shape' => 'CustomEventData', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'CreateMatchmakingConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Configuration' => [ 'shape' => 'MatchmakingConfiguration', ], ], ], 'CreateMatchmakingRuleSetInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'RuleSetBody', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'RuleSetBody' => [ 'shape' => 'RuleSetBody', ], ], ], 'CreateMatchmakingRuleSetOutput' => [ 'type' => 'structure', 'required' => [ 'RuleSet', ], 'members' => [ 'RuleSet' => [ 'shape' => 'MatchmakingRuleSet', ], ], ], 'CreatePlayerSessionInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', 'PlayerId', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerData' => [ 'shape' => 'PlayerData', ], ], ], 'CreatePlayerSessionOutput' => [ 'type' => 'structure', 'members' => [ 'PlayerSession' => [ 'shape' => 'PlayerSession', ], ], ], 'CreatePlayerSessionsInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', 'PlayerIds', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'PlayerIds' => [ 'shape' => 'PlayerIdList', ], 'PlayerDataMap' => [ 'shape' => 'PlayerDataMap', ], ], ], 'CreatePlayerSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'PlayerSessions' => [ 'shape' => 'PlayerSessionList', ], ], ], 'CreateVpcPeeringAuthorizationInput' => [ 'type' => 'structure', 'required' => [ 'GameLiftAwsAccountId', 'PeerVpcId', ], 'members' => [ 'GameLiftAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'CreateVpcPeeringAuthorizationOutput' => [ 'type' => 'structure', 'members' => [ 'VpcPeeringAuthorization' => [ 'shape' => 'VpcPeeringAuthorization', ], ], ], 'CreateVpcPeeringConnectionInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'PeerVpcAwsAccountId', 'PeerVpcId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'PeerVpcAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'CreateVpcPeeringConnectionOutput' => [ 'type' => 'structure', 'members' => [], ], 'CustomEventData' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'DeleteAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], ], ], 'DeleteBuildInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], ], ], 'DeleteFleetInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DeleteGameSessionQueueInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], ], ], 'DeleteGameSessionQueueOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMatchmakingConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], ], ], 'DeleteMatchmakingConfigurationOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMatchmakingRuleSetInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], ], ], 'DeleteMatchmakingRuleSetOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'FleetId', ], 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DeleteVpcPeeringAuthorizationInput' => [ 'type' => 'structure', 'required' => [ 'GameLiftAwsAccountId', 'PeerVpcId', ], 'members' => [ 'GameLiftAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DeleteVpcPeeringAuthorizationOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVpcPeeringConnectionInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'VpcPeeringConnectionId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'VpcPeeringConnectionId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DeleteVpcPeeringConnectionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], ], ], 'DescribeAliasOutput' => [ 'type' => 'structure', 'members' => [ 'Alias' => [ 'shape' => 'Alias', ], ], ], 'DescribeBuildInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], ], ], 'DescribeBuildOutput' => [ 'type' => 'structure', 'members' => [ 'Build' => [ 'shape' => 'Build', ], ], ], 'DescribeEC2InstanceLimitsInput' => [ 'type' => 'structure', 'members' => [ 'EC2InstanceType' => [ 'shape' => 'EC2InstanceType', ], ], ], 'DescribeEC2InstanceLimitsOutput' => [ 'type' => 'structure', 'members' => [ 'EC2InstanceLimits' => [ 'shape' => 'EC2InstanceLimitList', ], ], ], 'DescribeFleetAttributesInput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetAttributesOutput' => [ 'type' => 'structure', 'members' => [ 'FleetAttributes' => [ 'shape' => 'FleetAttributesList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetCapacityInput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetCapacityOutput' => [ 'type' => 'structure', 'members' => [ 'FleetCapacity' => [ 'shape' => 'FleetCapacityList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetEventsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetEventsOutput' => [ 'type' => 'structure', 'members' => [ 'Events' => [ 'shape' => 'EventList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetPortSettingsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DescribeFleetPortSettingsOutput' => [ 'type' => 'structure', 'members' => [ 'InboundPermissions' => [ 'shape' => 'IpPermissionsList', ], ], ], 'DescribeFleetUtilizationInput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeFleetUtilizationOutput' => [ 'type' => 'structure', 'members' => [ 'FleetUtilization' => [ 'shape' => 'FleetUtilizationList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionDetailsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'StatusFilter' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionDetailsOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionDetails' => [ 'shape' => 'GameSessionDetailList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionPlacementInput' => [ 'type' => 'structure', 'required' => [ 'PlacementId', ], 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], ], ], 'DescribeGameSessionPlacementOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionPlacement' => [ 'shape' => 'GameSessionPlacement', ], ], ], 'DescribeGameSessionQueuesInput' => [ 'type' => 'structure', 'members' => [ 'Names' => [ 'shape' => 'GameSessionQueueNameList', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionQueuesOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionQueues' => [ 'shape' => 'GameSessionQueueList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'StatusFilter' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeGameSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessions' => [ 'shape' => 'GameSessionList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeInstancesInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'Instances' => [ 'shape' => 'InstanceList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingConfigurationsInput' => [ 'type' => 'structure', 'members' => [ 'Names' => [ 'shape' => 'MatchmakingIdList', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'Configurations' => [ 'shape' => 'MatchmakingConfigurationList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingInput' => [ 'type' => 'structure', 'required' => [ 'TicketIds', ], 'members' => [ 'TicketIds' => [ 'shape' => 'MatchmakingIdList', ], ], ], 'DescribeMatchmakingOutput' => [ 'type' => 'structure', 'members' => [ 'TicketList' => [ 'shape' => 'MatchmakingTicketList', ], ], ], 'DescribeMatchmakingRuleSetsInput' => [ 'type' => 'structure', 'members' => [ 'Names' => [ 'shape' => 'MatchmakingRuleSetNameList', ], 'Limit' => [ 'shape' => 'RuleSetLimit', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeMatchmakingRuleSetsOutput' => [ 'type' => 'structure', 'required' => [ 'RuleSets', ], 'members' => [ 'RuleSets' => [ 'shape' => 'MatchmakingRuleSetList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribePlayerSessionsInput' => [ 'type' => 'structure', 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], 'PlayerSessionStatusFilter' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribePlayerSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'PlayerSessions' => [ 'shape' => 'PlayerSessionList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeRuntimeConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DescribeRuntimeConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], ], ], 'DescribeScalingPoliciesInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'StatusFilter' => [ 'shape' => 'ScalingStatusType', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeScalingPoliciesOutput' => [ 'type' => 'structure', 'members' => [ 'ScalingPolicies' => [ 'shape' => 'ScalingPolicyList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'DescribeVpcPeeringAuthorizationsInput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeVpcPeeringAuthorizationsOutput' => [ 'type' => 'structure', 'members' => [ 'VpcPeeringAuthorizations' => [ 'shape' => 'VpcPeeringAuthorizationList', ], ], ], 'DescribeVpcPeeringConnectionsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'DescribeVpcPeeringConnectionsOutput' => [ 'type' => 'structure', 'members' => [ 'VpcPeeringConnections' => [ 'shape' => 'VpcPeeringConnectionList', ], ], ], 'DesiredPlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerData' => [ 'shape' => 'PlayerData', ], ], ], 'DesiredPlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredPlayerSession', ], ], 'Double' => [ 'type' => 'double', ], 'DoubleObject' => [ 'type' => 'double', ], 'EC2InstanceCounts' => [ 'type' => 'structure', 'members' => [ 'DESIRED' => [ 'shape' => 'WholeNumber', ], 'MINIMUM' => [ 'shape' => 'WholeNumber', ], 'MAXIMUM' => [ 'shape' => 'WholeNumber', ], 'PENDING' => [ 'shape' => 'WholeNumber', ], 'ACTIVE' => [ 'shape' => 'WholeNumber', ], 'IDLE' => [ 'shape' => 'WholeNumber', ], 'TERMINATING' => [ 'shape' => 'WholeNumber', ], ], ], 'EC2InstanceLimit' => [ 'type' => 'structure', 'members' => [ 'EC2InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'CurrentInstances' => [ 'shape' => 'WholeNumber', ], 'InstanceLimit' => [ 'shape' => 'WholeNumber', ], ], ], 'EC2InstanceLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2InstanceLimit', ], ], 'EC2InstanceType' => [ 'type' => 'string', 'enum' => [ 't2.micro', 't2.small', 't2.medium', 't2.large', 'c3.large', 'c3.xlarge', 'c3.2xlarge', 'c3.4xlarge', 'c3.8xlarge', 'c4.large', 'c4.xlarge', 'c4.2xlarge', 'c4.4xlarge', 'c4.8xlarge', 'r3.large', 'r3.xlarge', 'r3.2xlarge', 'r3.4xlarge', 'r3.8xlarge', 'r4.large', 'r4.xlarge', 'r4.2xlarge', 'r4.4xlarge', 'r4.8xlarge', 'r4.16xlarge', 'm3.medium', 'm3.large', 'm3.xlarge', 'm3.2xlarge', 'm4.large', 'm4.xlarge', 'm4.2xlarge', 'm4.4xlarge', 'm4.10xlarge', ], ], 'Event' => [ 'type' => 'structure', 'members' => [ 'EventId' => [ 'shape' => 'NonZeroAndMaxString', ], 'ResourceId' => [ 'shape' => 'NonZeroAndMaxString', ], 'EventCode' => [ 'shape' => 'EventCode', ], 'Message' => [ 'shape' => 'NonEmptyString', ], 'EventTime' => [ 'shape' => 'Timestamp', ], 'PreSignedLogUrl' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'EventCode' => [ 'type' => 'string', 'enum' => [ 'GENERIC_EVENT', 'FLEET_CREATED', 'FLEET_DELETED', 'FLEET_SCALING_EVENT', 'FLEET_STATE_DOWNLOADING', 'FLEET_STATE_VALIDATING', 'FLEET_STATE_BUILDING', 'FLEET_STATE_ACTIVATING', 'FLEET_STATE_ACTIVE', 'FLEET_STATE_ERROR', 'FLEET_INITIALIZATION_FAILED', 'FLEET_BINARY_DOWNLOAD_FAILED', 'FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND', 'FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE', 'FLEET_VALIDATION_TIMED_OUT', 'FLEET_ACTIVATION_FAILED', 'FLEET_ACTIVATION_FAILED_NO_INSTANCES', 'FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED', 'SERVER_PROCESS_INVALID_PATH', 'SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT', 'SERVER_PROCESS_PROCESS_READY_TIMEOUT', 'SERVER_PROCESS_CRASHED', 'SERVER_PROCESS_TERMINATED_UNHEALTHY', 'SERVER_PROCESS_FORCE_TERMINATED', 'SERVER_PROCESS_PROCESS_EXIT_TIMEOUT', 'GAME_SESSION_ACTIVATION_TIMEOUT', 'FLEET_CREATION_EXTRACTING_BUILD', 'FLEET_CREATION_RUNNING_INSTALLER', 'FLEET_CREATION_VALIDATING_RUNTIME_CONFIG', 'FLEET_VPC_PEERING_SUCCEEDED', 'FLEET_VPC_PEERING_FAILED', 'FLEET_VPC_PEERING_DELETED', 'INSTANCE_INTERRUPTED', ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', ], ], 'FleetAction' => [ 'type' => 'string', 'enum' => [ 'AUTO_SCALING', ], ], 'FleetActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetAction', ], 'max' => 1, 'min' => 1, ], 'FleetAttributes' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'FleetArn' => [ 'shape' => 'ArnStringModel', ], 'FleetType' => [ 'shape' => 'FleetType', ], 'InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TerminationTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'FleetStatus', ], 'BuildId' => [ 'shape' => 'BuildId', ], 'ServerLaunchPath' => [ 'shape' => 'NonZeroAndMaxString', ], 'ServerLaunchParameters' => [ 'shape' => 'NonZeroAndMaxString', ], 'LogPaths' => [ 'shape' => 'StringList', ], 'NewGameSessionProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'ResourceCreationLimitPolicy' => [ 'shape' => 'ResourceCreationLimitPolicy', ], 'MetricGroups' => [ 'shape' => 'MetricGroupList', ], 'StoppedActions' => [ 'shape' => 'FleetActionList', ], 'InstanceRoleArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'FleetAttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetAttributes', ], ], 'FleetCapacity' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceType' => [ 'shape' => 'EC2InstanceType', ], 'InstanceCounts' => [ 'shape' => 'EC2InstanceCounts', ], ], ], 'FleetCapacityExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'FleetCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetCapacity', ], ], 'FleetId' => [ 'type' => 'string', 'pattern' => '^fleet-\\S+', ], 'FleetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetId', ], 'min' => 1, ], 'FleetStatus' => [ 'type' => 'string', 'enum' => [ 'NEW', 'DOWNLOADING', 'VALIDATING', 'BUILDING', 'ACTIVATING', 'ACTIVE', 'DELETING', 'ERROR', 'TERMINATED', ], ], 'FleetType' => [ 'type' => 'string', 'enum' => [ 'ON_DEMAND', 'SPOT', ], ], 'FleetUtilization' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'ActiveServerProcessCount' => [ 'shape' => 'WholeNumber', ], 'ActiveGameSessionCount' => [ 'shape' => 'WholeNumber', ], 'CurrentPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], ], ], 'FleetUtilizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FleetUtilization', ], ], 'Float' => [ 'type' => 'float', ], 'FreeText' => [ 'type' => 'string', ], 'GameProperty' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'GamePropertyKey', ], 'Value' => [ 'shape' => 'GamePropertyValue', ], ], ], 'GamePropertyKey' => [ 'type' => 'string', 'max' => 32, ], 'GamePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameProperty', ], 'max' => 16, ], 'GamePropertyValue' => [ 'type' => 'string', 'max' => 96, ], 'GameSession' => [ 'type' => 'structure', 'members' => [ 'GameSessionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TerminationTime' => [ 'shape' => 'Timestamp', ], 'CurrentPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'Status' => [ 'shape' => 'GameSessionStatus', ], 'StatusReason' => [ 'shape' => 'GameSessionStatusReason', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Port' => [ 'shape' => 'PortNumber', ], 'PlayerSessionCreationPolicy' => [ 'shape' => 'PlayerSessionCreationPolicy', ], 'CreatorId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], 'MatchmakerData' => [ 'shape' => 'MatchmakerData', ], ], ], 'GameSessionActivationTimeoutSeconds' => [ 'type' => 'integer', 'max' => 600, 'min' => 1, ], 'GameSessionConnectionInfo' => [ 'type' => 'structure', 'members' => [ 'GameSessionArn' => [ 'shape' => 'ArnStringModel', ], 'IpAddress' => [ 'shape' => 'StringModel', ], 'Port' => [ 'shape' => 'PositiveInteger', ], 'MatchedPlayerSessions' => [ 'shape' => 'MatchedPlayerSessionList', ], ], ], 'GameSessionData' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'GameSessionDetail' => [ 'type' => 'structure', 'members' => [ 'GameSession' => [ 'shape' => 'GameSession', ], 'ProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], ], ], 'GameSessionDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionDetail', ], ], 'GameSessionFullException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'GameSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSession', ], ], 'GameSessionPlacement' => [ 'type' => 'structure', 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], 'GameSessionQueueName' => [ 'shape' => 'GameSessionQueueName', ], 'Status' => [ 'shape' => 'GameSessionPlacementState', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'GameSessionName' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionArn' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionRegion' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerLatencies' => [ 'shape' => 'PlayerLatencyList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Port' => [ 'shape' => 'PortNumber', ], 'PlacedPlayerSessions' => [ 'shape' => 'PlacedPlayerSessionList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], 'MatchmakerData' => [ 'shape' => 'MatchmakerData', ], ], ], 'GameSessionPlacementState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'FULFILLED', 'CANCELLED', 'TIMED_OUT', ], ], 'GameSessionQueue' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], 'GameSessionQueueArn' => [ 'shape' => 'ArnStringModel', ], 'TimeoutInSeconds' => [ 'shape' => 'WholeNumber', ], 'PlayerLatencyPolicies' => [ 'shape' => 'PlayerLatencyPolicyList', ], 'Destinations' => [ 'shape' => 'GameSessionQueueDestinationList', ], ], ], 'GameSessionQueueDestination' => [ 'type' => 'structure', 'members' => [ 'DestinationArn' => [ 'shape' => 'ArnStringModel', ], ], ], 'GameSessionQueueDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionQueueDestination', ], ], 'GameSessionQueueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionQueue', ], ], 'GameSessionQueueName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9-]+', ], 'GameSessionQueueNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GameSessionQueueName', ], ], 'GameSessionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'ACTIVATING', 'TERMINATED', 'TERMINATING', 'ERROR', ], ], 'GameSessionStatusReason' => [ 'type' => 'string', 'enum' => [ 'INTERRUPTED', ], ], 'GetGameSessionLogUrlInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], ], ], 'GetGameSessionLogUrlOutput' => [ 'type' => 'structure', 'members' => [ 'PreSignedUrl' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'GetInstanceAccessInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'InstanceId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], ], ], 'GetInstanceAccessOutput' => [ 'type' => 'structure', 'members' => [ 'InstanceAccess' => [ 'shape' => 'InstanceAccess', ], ], ], 'IdStringModel' => [ 'type' => 'string', 'max' => 48, 'min' => 1, 'pattern' => '[a-zA-Z0-9-]+', ], 'IdempotentParameterMismatchException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'Type' => [ 'shape' => 'EC2InstanceType', ], 'Status' => [ 'shape' => 'InstanceStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'InstanceAccess' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], 'Credentials' => [ 'shape' => 'InstanceCredentials', ], ], ], 'InstanceCredentials' => [ 'type' => 'structure', 'members' => [ 'UserName' => [ 'shape' => 'NonEmptyString', ], 'Secret' => [ 'shape' => 'NonEmptyString', ], ], 'sensitive' => true, ], 'InstanceId' => [ 'type' => 'string', 'pattern' => '[a-zA-Z0-9\\.-]+', ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ACTIVE', 'TERMINATING', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServiceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, 'fault' => true, ], 'InvalidFleetStatusException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'InvalidGameSessionStatusException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', ], 'IpPermission' => [ 'type' => 'structure', 'required' => [ 'FromPort', 'ToPort', 'IpRange', 'Protocol', ], 'members' => [ 'FromPort' => [ 'shape' => 'PortNumber', ], 'ToPort' => [ 'shape' => 'PortNumber', ], 'IpRange' => [ 'shape' => 'NonBlankString', ], 'Protocol' => [ 'shape' => 'IpProtocol', ], ], ], 'IpPermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpPermission', ], 'max' => 50, ], 'IpProtocol' => [ 'type' => 'string', 'enum' => [ 'TCP', 'UDP', ], ], 'LatencyMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonEmptyString', ], 'value' => [ 'shape' => 'PositiveInteger', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'ListAliasesInput' => [ 'type' => 'structure', 'members' => [ 'RoutingStrategyType' => [ 'shape' => 'RoutingStrategyType', ], 'Name' => [ 'shape' => 'NonEmptyString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListAliasesOutput' => [ 'type' => 'structure', 'members' => [ 'Aliases' => [ 'shape' => 'AliasList', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListBuildsInput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BuildStatus', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListBuildsOutput' => [ 'type' => 'structure', 'members' => [ 'Builds' => [ 'shape' => 'BuildList', ], 'NextToken' => [ 'shape' => 'NonEmptyString', ], ], ], 'ListFleetsInput' => [ 'type' => 'structure', 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'ListFleetsOutput' => [ 'type' => 'structure', 'members' => [ 'FleetIds' => [ 'shape' => 'FleetIdList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'MatchedPlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], ], ], 'MatchedPlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchedPlayerSession', ], ], 'MatchmakerData' => [ 'type' => 'string', 'max' => 390000, 'min' => 1, ], 'MatchmakingAcceptanceTimeoutInteger' => [ 'type' => 'integer', 'max' => 600, 'min' => 1, ], 'MatchmakingConfiguration' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionQueueArns' => [ 'shape' => 'QueueArnsList', ], 'RequestTimeoutSeconds' => [ 'shape' => 'MatchmakingRequestTimeoutInteger', ], 'AcceptanceTimeoutSeconds' => [ 'shape' => 'MatchmakingAcceptanceTimeoutInteger', ], 'AcceptanceRequired' => [ 'shape' => 'BooleanModel', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'NotificationTarget' => [ 'shape' => 'SnsArnStringModel', ], 'AdditionalPlayerCount' => [ 'shape' => 'WholeNumber', ], 'CustomEventData' => [ 'shape' => 'CustomEventData', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'MatchmakingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingConfiguration', ], ], 'MatchmakingConfigurationStatus' => [ 'type' => 'string', 'enum' => [ 'CANCELLED', 'COMPLETED', 'FAILED', 'PLACING', 'QUEUED', 'REQUIRES_ACCEPTANCE', 'SEARCHING', 'TIMED_OUT', ], ], 'MatchmakingIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingIdStringModel', ], ], 'MatchmakingIdStringModel' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9-\\.]+', ], 'MatchmakingRequestTimeoutInteger' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1, ], 'MatchmakingRuleSet' => [ 'type' => 'structure', 'required' => [ 'RuleSetBody', ], 'members' => [ 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'RuleSetBody' => [ 'shape' => 'RuleSetBody', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'MatchmakingRuleSetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingRuleSet', ], ], 'MatchmakingRuleSetNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingIdStringModel', ], 'max' => 10, 'min' => 1, ], 'MatchmakingTicket' => [ 'type' => 'structure', 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'ConfigurationName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Status' => [ 'shape' => 'MatchmakingConfigurationStatus', ], 'StatusReason' => [ 'shape' => 'StringModel', ], 'StatusMessage' => [ 'shape' => 'StringModel', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Players' => [ 'shape' => 'PlayerList', ], 'GameSessionConnectionInfo' => [ 'shape' => 'GameSessionConnectionInfo', ], 'EstimatedWaitTime' => [ 'shape' => 'WholeNumber', ], ], ], 'MatchmakingTicketList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MatchmakingTicket', ], ], 'MaxConcurrentGameSessionActivations' => [ 'type' => 'integer', 'max' => 2147483647, 'min' => 1, ], 'MetricGroup' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'MetricGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricGroup', ], 'max' => 1, ], 'MetricName' => [ 'type' => 'string', 'enum' => [ 'ActivatingGameSessions', 'ActiveGameSessions', 'ActiveInstances', 'AvailableGameSessions', 'AvailablePlayerSessions', 'CurrentPlayerSessions', 'IdleInstances', 'PercentAvailableGameSessions', 'PercentIdleInstances', 'QueueDepth', 'WaitTime', ], ], 'NonBlankAndLengthConstraintString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.*\\S.*', ], 'NonBlankString' => [ 'type' => 'string', 'pattern' => '[^\\s]+', ], 'NonEmptyString' => [ 'type' => 'string', 'min' => 1, ], 'NonZeroAndMaxString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'OperatingSystem' => [ 'type' => 'string', 'enum' => [ 'WINDOWS_2012', 'AMAZON_LINUX', ], ], 'PlacedPlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], ], ], 'PlacedPlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacedPlayerSession', ], ], 'Player' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerAttributes' => [ 'shape' => 'PlayerAttributeMap', ], 'Team' => [ 'shape' => 'NonZeroAndMaxString', ], 'LatencyInMs' => [ 'shape' => 'LatencyMap', ], ], ], 'PlayerAttributeMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonZeroAndMaxString', ], 'value' => [ 'shape' => 'AttributeValue', ], ], 'PlayerData' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'PlayerDataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonZeroAndMaxString', ], 'value' => [ 'shape' => 'PlayerData', ], ], 'PlayerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonZeroAndMaxString', ], 'max' => 25, 'min' => 1, ], 'PlayerLatency' => [ 'type' => 'structure', 'members' => [ 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'RegionIdentifier' => [ 'shape' => 'NonZeroAndMaxString', ], 'LatencyInMilliseconds' => [ 'shape' => 'Float', ], ], ], 'PlayerLatencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlayerLatency', ], ], 'PlayerLatencyPolicy' => [ 'type' => 'structure', 'members' => [ 'MaximumIndividualPlayerLatencyMilliseconds' => [ 'shape' => 'WholeNumber', ], 'PolicyDurationSeconds' => [ 'shape' => 'WholeNumber', ], ], ], 'PlayerLatencyPolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlayerLatencyPolicy', ], ], 'PlayerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Player', ], ], 'PlayerSession' => [ 'type' => 'structure', 'members' => [ 'PlayerSessionId' => [ 'shape' => 'PlayerSessionId', ], 'PlayerId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TerminationTime' => [ 'shape' => 'Timestamp', ], 'Status' => [ 'shape' => 'PlayerSessionStatus', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Port' => [ 'shape' => 'PortNumber', ], 'PlayerData' => [ 'shape' => 'PlayerData', ], ], ], 'PlayerSessionCreationPolicy' => [ 'type' => 'string', 'enum' => [ 'ACCEPT_ALL', 'DENY_ALL', ], ], 'PlayerSessionId' => [ 'type' => 'string', 'pattern' => '^psess-\\S+', ], 'PlayerSessionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlayerSession', ], ], 'PlayerSessionStatus' => [ 'type' => 'string', 'enum' => [ 'RESERVED', 'ACTIVE', 'COMPLETED', 'TIMEDOUT', ], ], 'PolicyType' => [ 'type' => 'string', 'enum' => [ 'RuleBased', 'TargetBased', ], ], 'PortNumber' => [ 'type' => 'integer', 'max' => 60000, 'min' => 1, ], 'PositiveInteger' => [ 'type' => 'integer', 'min' => 1, ], 'PositiveLong' => [ 'type' => 'long', 'min' => 1, ], 'ProtectionPolicy' => [ 'type' => 'string', 'enum' => [ 'NoProtection', 'FullProtection', ], ], 'PutScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'FleetId', 'MetricName', ], 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'ScalingAdjustment' => [ 'shape' => 'Integer', ], 'ScalingAdjustmentType' => [ 'shape' => 'ScalingAdjustmentType', ], 'Threshold' => [ 'shape' => 'Double', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperatorType', ], 'EvaluationPeriods' => [ 'shape' => 'PositiveInteger', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'PolicyType' => [ 'shape' => 'PolicyType', ], 'TargetConfiguration' => [ 'shape' => 'TargetConfiguration', ], ], ], 'PutScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'QueueArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArnStringModel', ], ], 'RequestUploadCredentialsInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], ], ], 'RequestUploadCredentialsOutput' => [ 'type' => 'structure', 'members' => [ 'UploadCredentials' => [ 'shape' => 'AwsCredentials', ], 'StorageLocation' => [ 'shape' => 'S3Location', ], ], ], 'ResolveAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], ], ], 'ResolveAliasOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'ResourceCreationLimitPolicy' => [ 'type' => 'structure', 'members' => [ 'NewGameSessionsPerCreator' => [ 'shape' => 'WholeNumber', ], 'PolicyPeriodInMinutes' => [ 'shape' => 'WholeNumber', ], ], ], 'RoutingStrategy' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'RoutingStrategyType', ], 'FleetId' => [ 'shape' => 'FleetId', ], 'Message' => [ 'shape' => 'FreeText', ], ], ], 'RoutingStrategyType' => [ 'type' => 'string', 'enum' => [ 'SIMPLE', 'TERMINAL', ], ], 'RuleSetBody' => [ 'type' => 'string', 'max' => 65535, 'min' => 1, ], 'RuleSetLimit' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'RuntimeConfiguration' => [ 'type' => 'structure', 'members' => [ 'ServerProcesses' => [ 'shape' => 'ServerProcessList', ], 'MaxConcurrentGameSessionActivations' => [ 'shape' => 'MaxConcurrentGameSessionActivations', ], 'GameSessionActivationTimeoutSeconds' => [ 'shape' => 'GameSessionActivationTimeoutSeconds', ], ], ], 'S3Location' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'NonEmptyString', ], 'Key' => [ 'shape' => 'NonEmptyString', ], 'RoleArn' => [ 'shape' => 'NonEmptyString', ], ], ], 'ScalingAdjustmentType' => [ 'type' => 'string', 'enum' => [ 'ChangeInCapacity', 'ExactCapacity', 'PercentChangeInCapacity', ], ], 'ScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Status' => [ 'shape' => 'ScalingStatusType', ], 'ScalingAdjustment' => [ 'shape' => 'Integer', ], 'ScalingAdjustmentType' => [ 'shape' => 'ScalingAdjustmentType', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperatorType', ], 'Threshold' => [ 'shape' => 'Double', ], 'EvaluationPeriods' => [ 'shape' => 'PositiveInteger', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'PolicyType' => [ 'shape' => 'PolicyType', ], 'TargetConfiguration' => [ 'shape' => 'TargetConfiguration', ], ], ], 'ScalingPolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingPolicy', ], ], 'ScalingStatusType' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'UPDATE_REQUESTED', 'UPDATING', 'DELETE_REQUESTED', 'DELETING', 'DELETED', 'ERROR', ], ], 'SearchGameSessionsInput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'AliasId' => [ 'shape' => 'AliasId', ], 'FilterExpression' => [ 'shape' => 'NonZeroAndMaxString', ], 'SortExpression' => [ 'shape' => 'NonZeroAndMaxString', ], 'Limit' => [ 'shape' => 'PositiveInteger', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'SearchGameSessionsOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessions' => [ 'shape' => 'GameSessionList', ], 'NextToken' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'ServerProcess' => [ 'type' => 'structure', 'required' => [ 'LaunchPath', 'ConcurrentExecutions', ], 'members' => [ 'LaunchPath' => [ 'shape' => 'NonZeroAndMaxString', ], 'Parameters' => [ 'shape' => 'NonZeroAndMaxString', ], 'ConcurrentExecutions' => [ 'shape' => 'PositiveInteger', ], ], ], 'ServerProcessList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerProcess', ], 'max' => 50, 'min' => 1, ], 'SnsArnStringModel' => [ 'type' => 'string', 'max' => 300, 'min' => 0, 'pattern' => '[a-zA-Z0-9:_/-]*', ], 'StartFleetActionsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'Actions', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Actions' => [ 'shape' => 'FleetActionList', ], ], ], 'StartFleetActionsOutput' => [ 'type' => 'structure', 'members' => [], ], 'StartGameSessionPlacementInput' => [ 'type' => 'structure', 'required' => [ 'PlacementId', 'GameSessionQueueName', 'MaximumPlayerSessionCount', ], 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], 'GameSessionQueueName' => [ 'shape' => 'GameSessionQueueName', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'GameSessionName' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerLatencies' => [ 'shape' => 'PlayerLatencyList', ], 'DesiredPlayerSessions' => [ 'shape' => 'DesiredPlayerSessionList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'StartGameSessionPlacementOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionPlacement' => [ 'shape' => 'GameSessionPlacement', ], ], ], 'StartMatchBackfillInput' => [ 'type' => 'structure', 'required' => [ 'ConfigurationName', 'GameSessionArn', 'Players', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'ConfigurationName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'GameSessionArn' => [ 'shape' => 'ArnStringModel', ], 'Players' => [ 'shape' => 'PlayerList', ], ], ], 'StartMatchBackfillOutput' => [ 'type' => 'structure', 'members' => [ 'MatchmakingTicket' => [ 'shape' => 'MatchmakingTicket', ], ], ], 'StartMatchmakingInput' => [ 'type' => 'structure', 'required' => [ 'ConfigurationName', 'Players', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], 'ConfigurationName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Players' => [ 'shape' => 'PlayerList', ], ], ], 'StartMatchmakingOutput' => [ 'type' => 'structure', 'members' => [ 'MatchmakingTicket' => [ 'shape' => 'MatchmakingTicket', ], ], ], 'StopFleetActionsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'Actions', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Actions' => [ 'shape' => 'FleetActionList', ], ], ], 'StopFleetActionsOutput' => [ 'type' => 'structure', 'members' => [], ], 'StopGameSessionPlacementInput' => [ 'type' => 'structure', 'required' => [ 'PlacementId', ], 'members' => [ 'PlacementId' => [ 'shape' => 'IdStringModel', ], ], ], 'StopGameSessionPlacementOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionPlacement' => [ 'shape' => 'GameSessionPlacement', ], ], ], 'StopMatchmakingInput' => [ 'type' => 'structure', 'required' => [ 'TicketId', ], 'members' => [ 'TicketId' => [ 'shape' => 'MatchmakingIdStringModel', ], ], ], 'StopMatchmakingOutput' => [ 'type' => 'structure', 'members' => [], ], 'StringDoubleMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonZeroAndMaxString', ], 'value' => [ 'shape' => 'DoubleObject', ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonZeroAndMaxString', ], ], 'StringModel' => [ 'type' => 'string', ], 'TargetConfiguration' => [ 'type' => 'structure', 'required' => [ 'TargetValue', ], 'members' => [ 'TargetValue' => [ 'shape' => 'Double', ], ], ], 'TerminalRoutingStrategyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UnauthorizedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'UnsupportedRegionException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'NonEmptyString', ], ], 'exception' => true, ], 'UpdateAliasInput' => [ 'type' => 'structure', 'required' => [ 'AliasId', ], 'members' => [ 'AliasId' => [ 'shape' => 'AliasId', ], 'Name' => [ 'shape' => 'NonBlankAndLengthConstraintString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'UpdateAliasOutput' => [ 'type' => 'structure', 'members' => [ 'Alias' => [ 'shape' => 'Alias', ], ], ], 'UpdateBuildInput' => [ 'type' => 'structure', 'required' => [ 'BuildId', ], 'members' => [ 'BuildId' => [ 'shape' => 'BuildId', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Version' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'UpdateBuildOutput' => [ 'type' => 'structure', 'members' => [ 'Build' => [ 'shape' => 'Build', ], ], ], 'UpdateFleetAttributesInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'NewGameSessionProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], 'ResourceCreationLimitPolicy' => [ 'shape' => 'ResourceCreationLimitPolicy', ], 'MetricGroups' => [ 'shape' => 'MetricGroupList', ], ], ], 'UpdateFleetAttributesOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'UpdateFleetCapacityInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'DesiredInstances' => [ 'shape' => 'WholeNumber', ], 'MinSize' => [ 'shape' => 'WholeNumber', ], 'MaxSize' => [ 'shape' => 'WholeNumber', ], ], ], 'UpdateFleetCapacityOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'UpdateFleetPortSettingsInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'InboundPermissionAuthorizations' => [ 'shape' => 'IpPermissionsList', ], 'InboundPermissionRevocations' => [ 'shape' => 'IpPermissionsList', ], ], ], 'UpdateFleetPortSettingsOutput' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], ], ], 'UpdateGameSessionInput' => [ 'type' => 'structure', 'required' => [ 'GameSessionId', ], 'members' => [ 'GameSessionId' => [ 'shape' => 'ArnStringModel', ], 'MaximumPlayerSessionCount' => [ 'shape' => 'WholeNumber', ], 'Name' => [ 'shape' => 'NonZeroAndMaxString', ], 'PlayerSessionCreationPolicy' => [ 'shape' => 'PlayerSessionCreationPolicy', ], 'ProtectionPolicy' => [ 'shape' => 'ProtectionPolicy', ], ], ], 'UpdateGameSessionOutput' => [ 'type' => 'structure', 'members' => [ 'GameSession' => [ 'shape' => 'GameSession', ], ], ], 'UpdateGameSessionQueueInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'GameSessionQueueName', ], 'TimeoutInSeconds' => [ 'shape' => 'WholeNumber', ], 'PlayerLatencyPolicies' => [ 'shape' => 'PlayerLatencyPolicyList', ], 'Destinations' => [ 'shape' => 'GameSessionQueueDestinationList', ], ], ], 'UpdateGameSessionQueueOutput' => [ 'type' => 'structure', 'members' => [ 'GameSessionQueue' => [ 'shape' => 'GameSessionQueue', ], ], ], 'UpdateMatchmakingConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'MatchmakingIdStringModel', ], 'Description' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameSessionQueueArns' => [ 'shape' => 'QueueArnsList', ], 'RequestTimeoutSeconds' => [ 'shape' => 'MatchmakingRequestTimeoutInteger', ], 'AcceptanceTimeoutSeconds' => [ 'shape' => 'MatchmakingAcceptanceTimeoutInteger', ], 'AcceptanceRequired' => [ 'shape' => 'BooleanModel', ], 'RuleSetName' => [ 'shape' => 'MatchmakingIdStringModel', ], 'NotificationTarget' => [ 'shape' => 'SnsArnStringModel', ], 'AdditionalPlayerCount' => [ 'shape' => 'WholeNumber', ], 'CustomEventData' => [ 'shape' => 'CustomEventData', ], 'GameProperties' => [ 'shape' => 'GamePropertyList', ], 'GameSessionData' => [ 'shape' => 'GameSessionData', ], ], ], 'UpdateMatchmakingConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Configuration' => [ 'shape' => 'MatchmakingConfiguration', ], ], ], 'UpdateRuntimeConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'FleetId', 'RuntimeConfiguration', ], 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], ], ], 'UpdateRuntimeConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'RuntimeConfiguration' => [ 'shape' => 'RuntimeConfiguration', ], ], ], 'ValidateMatchmakingRuleSetInput' => [ 'type' => 'structure', 'required' => [ 'RuleSetBody', ], 'members' => [ 'RuleSetBody' => [ 'shape' => 'RuleSetBody', ], ], ], 'ValidateMatchmakingRuleSetOutput' => [ 'type' => 'structure', 'members' => [ 'Valid' => [ 'shape' => 'BooleanModel', ], ], ], 'VpcPeeringAuthorization' => [ 'type' => 'structure', 'members' => [ 'GameLiftAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcAwsAccountId' => [ 'shape' => 'NonZeroAndMaxString', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ExpirationTime' => [ 'shape' => 'Timestamp', ], ], ], 'VpcPeeringAuthorizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcPeeringAuthorization', ], ], 'VpcPeeringConnection' => [ 'type' => 'structure', 'members' => [ 'FleetId' => [ 'shape' => 'FleetId', ], 'IpV4CidrBlock' => [ 'shape' => 'NonZeroAndMaxString', ], 'VpcPeeringConnectionId' => [ 'shape' => 'NonZeroAndMaxString', ], 'Status' => [ 'shape' => 'VpcPeeringConnectionStatus', ], 'PeerVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], 'GameLiftVpcId' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'VpcPeeringConnectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcPeeringConnection', ], ], 'VpcPeeringConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'NonZeroAndMaxString', ], 'Message' => [ 'shape' => 'NonZeroAndMaxString', ], ], ], 'WholeNumber' => [ 'type' => 'integer', 'min' => 0, ], ],]; diff --git a/src/data/gamelift/2015-10-01/docs-2.json b/src/data/gamelift/2015-10-01/docs-2.json index 311c4731ef..0dd49466e9 100644 --- a/src/data/gamelift/2015-10-01/docs-2.json +++ b/src/data/gamelift/2015-10-01/docs-2.json @@ -4,8 +4,8 @@ "operations": { "AcceptMatch": "

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.

", "CreateAlias": "

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias.

", - "CreateBuild": "

Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.

Game server binaries must be combined into a .zip file for use with Amazon GameLift. See Uploading Your Game for more information.

To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. See Upload Build Files to Amazon GameLift for more help.

The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:

If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.

", - "CreateFleet": "

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You set up a fleet to use instances with certain hardware specifications (see Amazon EC2 Instance Types), and deploy your game build to the fleet.

To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type, (3) the build ID for your game build, and (4) a run-time configuration, which specifies the server processes to run on each instance in the fleet. If fleet type is not set, the new fleet will use on-demand instances by default.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

Learn more

See Amazon GameLift Developer Guide topics in Working with Fleets.

Related operations

", + "CreateBuild": "

Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.

Game server binaries must be combined into a .zip file for use with Amazon GameLift.

To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions.

The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:

If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

Related operations

", + "CreateFleet": "

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You set up a fleet to use instances with certain hardware specifications (see Amazon EC2 Instance Types), and deploy your game build to the fleet.

To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type, (3) the build ID for your game build, and (4) a run-time configuration, which specifies the server processes to run on each instance in the fleet. If fleet type is not set, the new fleet will use on-demand instances by default.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

Learn more

Working with Fleets.

Related operations

", "CreateGameSession": "

Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified.

Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.

Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.

Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

", "CreateGameSessionQueue": "

Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.

Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.

Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.

To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.

", "CreateMatchmakingConfiguration": "

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used.

To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.

Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept.

Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking). Since notifications promise only \"best effort\" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds.

", @@ -15,8 +15,8 @@ "CreateVpcPeeringAuthorization": "

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions.

To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.

", "CreateVpcPeeringConnection": "

Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents.

", "DeleteAlias": "

Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

", - "DeleteBuild": "

Deletes a build. This action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

", - "DeleteFleet": "

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.

This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

", + "DeleteBuild": "

Deletes a build. This action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

Learn more

Working with Builds

Related operations

", + "DeleteFleet": "

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.

This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

Learn more

Working with Fleets.

Related operations

", "DeleteGameSessionQueue": "

Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.

", "DeleteMatchmakingConfiguration": "

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

", "DeleteMatchmakingRuleSet": "

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

Related operations

", @@ -24,13 +24,13 @@ "DeleteVpcPeeringAuthorization": "

Cancels a pending VPC peering authorization for the specified VPC. If the authorization has already been used to create a peering connection, call DeleteVpcPeeringConnection to remove the connection.

", "DeleteVpcPeeringConnection": "

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.

Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

", "DescribeAlias": "

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

", - "DescribeBuild": "

Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned.

", - "DescribeEC2InstanceLimits": "

Retrieves the following information for the specified EC2 instance type:

Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).

", - "DescribeFleetAttributes": "

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

 ", - "DescribeFleetCapacity": "

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

 ", - "DescribeFleetEvents": "

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

", - "DescribeFleetPortSettings": "

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

", - "DescribeFleetUtilization": "

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

 ", + "DescribeBuild": "

Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned.

Learn more

Working with Builds

Related operations

", + "DescribeEC2InstanceLimits": "

Retrieves the following information for the specified EC2 instance type:

Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).

Learn more

Working with Fleets.

Related operations

", + "DescribeFleetAttributes": "

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

", + "DescribeFleetCapacity": "

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

", + "DescribeFleetEvents": "

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Learn more

Working with Fleets.

Related operations

", + "DescribeFleetPortSettings": "

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Learn more

Working with Fleets.

Related operations

", + "DescribeFleetUtilization": "

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

", "DescribeGameSessionDetails": "

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

", "DescribeGameSessionPlacement": "

Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.

", "DescribeGameSessionQueues": "

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region.

", @@ -40,35 +40,35 @@ "DescribeMatchmakingConfigurations": "

Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

", "DescribeMatchmakingRuleSets": "

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

Related operations

", "DescribePlayerSessions": "

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

Available in Amazon GameLift Local.

", - "DescribeRuntimeConfiguration": "

Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.

", + "DescribeRuntimeConfiguration": "

Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.

Learn more

Working with Fleets.

Related operations

", "DescribeScalingPolicies": "

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended (StopFleetActions). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.

", "DescribeVpcPeeringAuthorizations": "

Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

", "DescribeVpcPeeringConnections": "

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

", "GetGameSessionLogUrl": "

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

 ", "GetInstanceAccess": "

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.

Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.

", "ListAliases": "

Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Returned aliases are not listed in any particular order.

 ", - "ListBuilds": "

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

 ", - "ListFleets": "

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in any particular order.

 ", + "ListBuilds": "

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

Learn more

Working with Builds

Related operations

", + "ListFleets": "

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in any particular order.

Learn more

Working with Fleets.

Related operations

", "PutScalingPolicy": "

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

", - "RequestUploadCredentials": "

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

", + "RequestUploadCredentials": "

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more

Uploading Your Game

Related operations

", "ResolveAlias": "

Retrieves the fleet ID that a specified alias is currently pointing to.

", "SearchGameSessions": "

Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes:

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages.

You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails.

", - "StartFleetActions": "

Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity.

To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes.

", + "StartFleetActions": "

Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity.

To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes.

Learn more

Working with Fleets.

Related operations

", "StartGameSessionPlacement": "

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region's average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

", "StartMatchBackfill": "

Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.

To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch.

The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works.

", "StartMatchmaking": "

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration. For complete information on setting up and using FlexMatch, see the topic Adding FlexMatch to Your Game.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED. Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches.

Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests:

Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows:

  1. Your client code submits a StartMatchmaking request for one or more players and tracks the status of the request ticket.

  2. FlexMatch uses this ticket and others in process to build an acceptable match. When a potential match is identified, all tickets in the proposed match are advanced to the next status.

  3. If the match requires player acceptance (set in the matchmaking configuration), the tickets move into status REQUIRES_ACCEPTANCE. This status triggers your client code to solicit acceptance from all players in every ticket involved in the match, and then call AcceptMatch for each player. If any player rejects or fails to accept the match before a specified timeout, the proposed match is dropped (see AcceptMatch for more details).

  4. Once a match is proposed and accepted, the matchmaking tickets move into status PLACING. FlexMatch locates resources for a new game session using the game session queue (set in the matchmaking configuration) and creates the game session based on the match data.

  5. When the match is successfully placed, the matchmaking tickets move into COMPLETED status. Connection information (including game session endpoint and player session) is added to the matchmaking tickets. Matched players can use the connection information to join the game.

", - "StopFleetActions": "

Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes.

To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting (FleetCapacity. Changes to the fleet's capacity must be done manually using UpdateFleetCapacity.

", + "StopFleetActions": "

Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes.

To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting (FleetCapacity. Changes to the fleet's capacity must be done manually using UpdateFleetCapacity.

Learn more

Working with Fleets.

Related operations

", "StopGameSessionPlacement": "

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

", "StopMatchmaking": "

Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

", "UpdateAlias": "

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

", - "UpdateBuild": "

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

", - "UpdateFleetAttributes": "

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

", - "UpdateFleetCapacity": "

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.

", - "UpdateFleetPortSettings": "

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

", + "UpdateBuild": "

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Learn more

Working with Builds

Related operations

", + "UpdateFleetAttributes": "

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

Learn more

Working with Fleets.

Related operations

", + "UpdateFleetCapacity": "

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.

Learn more

Working with Fleets.

Related operations

", + "UpdateFleetPortSettings": "

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

Learn more

Working with Fleets.

Related operations

", "UpdateGameSession": "

Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.

", "UpdateGameSessionQueue": "

Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

", "UpdateMatchmakingConfiguration": "

Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings.

", - "UpdateRuntimeConfiguration": "

Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift's normal process recycling activity.

", + "UpdateRuntimeConfiguration": "

Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift's normal process recycling activity.

Learn more

Working with Fleets.

Related operations

", "ValidateMatchmakingRuleSet": "

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.

Learn more

Related operations

" }, "shapes": { @@ -1314,7 +1314,9 @@ "AwsCredentials$SecretAccessKey": "

Temporary secret key allowing access to the Amazon GameLift S3 account.

", "AwsCredentials$SessionToken": "

Token used to associate a specific build ID with the files uploaded using these credentials.

", "ConflictException$Message": null, + "CreateFleetInput$InstanceRoleArn": "

Unique identifier for an AWS IAM role that manages access to your AWS services. Any application that runs on an instance in this fleet can assume the role, including install scripts, server processs, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

", "Event$Message": "

Additional information related to the event.

", + "FleetAttributes$InstanceRoleArn": "

Unique identifier for an AWS IAM role that manages access to your AWS services. Any application that runs on an instance in this fleet can assume the role, including install scripts, server processs, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

", "FleetCapacityExceededException$Message": null, "GameSessionFullException$Message": null, "IdempotentParameterMismatchException$Message": null, diff --git a/src/data/gamelift/2015-10-01/docs-2.json.php b/src/data/gamelift/2015-10-01/docs-2.json.php index 201bf761b3..41bc871445 100644 --- a/src/data/gamelift/2015-10-01/docs-2.json.php +++ b/src/data/gamelift/2015-10-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon GameLift Service

Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage.

The Amazon GameLift service API includes two important function sets:

This reference guide describes the low-level service API for Amazon GameLift. You can use the API functionality with these tools:

Learn more

API SUMMARY

This list offers a functional overview of the Amazon GameLift service API.

Managing Games and Players

Use these actions to start new game sessions, find existing game sessions, track game session status and other information, and enable player access to game sessions.

Setting Up and Managing Game Servers

When setting up Amazon GameLift resources for your game, you first create a game build and upload it to Amazon GameLift. You can then use these actions to configure and manage a fleet of resources to run your game servers, scale capacity to meet player demand, access performance and utilization metrics, and more.

', 'operations' => [ 'AcceptMatch' => '

Registers a player\'s acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.

', 'CreateAlias' => '

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias.

', 'CreateBuild' => '

Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.

Game server binaries must be combined into a .zip file for use with Amazon GameLift. See Uploading Your Game for more information.

To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. See Upload Build Files to Amazon GameLift for more help.

The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:

If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.

', 'CreateFleet' => '

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You set up a fleet to use instances with certain hardware specifications (see Amazon EC2 Instance Types), and deploy your game build to the fleet.

To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type, (3) the build ID for your game build, and (4) a run-time configuration, which specifies the server processes to run on each instance in the fleet. If fleet type is not set, the new fleet will use on-demand instances by default.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

Learn more

See Amazon GameLift Developer Guide topics in Working with Fleets.

Related operations

', 'CreateGameSession' => '

Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified.

Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.

Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.

Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session\'s player session creation policy.

Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

', 'CreateGameSessionQueue' => '

Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.

Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue\'s default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.

Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy\'s maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.

To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.

', 'CreateMatchmakingConfiguration' => '

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used.

To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.

Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept.

Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking). Since notifications promise only "best effort" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds.

', 'CreateMatchmakingRuleSet' => '

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same region as the matchmaking configuration they will be used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

Related operations

', 'CreatePlayerSession' => '

Adds a player to a game session and creates a player session record. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions.

To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new PlayerSession object is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

', 'CreatePlayerSessions' => '

Adds a group of players to a game session. This action is useful with a team matching feature. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession.

To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, the players are added to the game session and a set of new PlayerSession objects is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

', 'CreateVpcPeeringAuthorization' => '

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you\'ve received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions.

To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.

', 'CreateVpcPeeringConnection' => '

Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request\'s status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents.

', 'DeleteAlias' => '

Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

', 'DeleteBuild' => '

Deletes a build. This action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

', 'DeleteFleet' => '

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet\'s desired capacity to zero. See UpdateFleetCapacity.

This action removes the fleet\'s resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

', 'DeleteGameSessionQueue' => '

Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.

', 'DeleteMatchmakingConfiguration' => '

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

', 'DeleteMatchmakingRuleSet' => '

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

Related operations

', 'DeleteScalingPolicy' => '

Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet.

', 'DeleteVpcPeeringAuthorization' => '

Cancels a pending VPC peering authorization for the specified VPC. If the authorization has already been used to create a peering connection, call DeleteVpcPeeringConnection to remove the connection.

', 'DeleteVpcPeeringConnection' => '

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.

Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

', 'DescribeAlias' => '

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias\'s target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

', 'DescribeBuild' => '

Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned.

', 'DescribeEC2InstanceLimits' => '

Retrieves the following information for the specified EC2 instance type:

Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).

', 'DescribeFleetAttributes' => '

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

 ', 'DescribeFleetCapacity' => '

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

 ', 'DescribeFleetEvents' => '

Retrieves entries from the specified fleet\'s event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

', 'DescribeFleetPortSettings' => '

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet\'s inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

', 'DescribeFleetUtilization' => '

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

 ', 'DescribeGameSessionDetails' => '

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

', 'DescribeGameSessionPlacement' => '

Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.

', 'DescribeGameSessionQueues' => '

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region.

', 'DescribeGameSessions' => '

Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.

To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.

Available in Amazon GameLift Local.

', 'DescribeInstances' => '

Retrieves information about a fleet\'s instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

', 'DescribeMatchmaking' => '

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.

You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking.

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

', 'DescribeMatchmakingConfigurations' => '

Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

', 'DescribeMatchmakingRuleSets' => '

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

Related operations

', 'DescribePlayerSessions' => '

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

Available in Amazon GameLift Local.

', 'DescribeRuntimeConfiguration' => '

Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.

', 'DescribeScalingPolicies' => '

Retrieves all scaling policies applied to a fleet.

To get a fleet\'s scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended (StopFleetActions). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet\'s scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.

', 'DescribeVpcPeeringAuthorizations' => '

Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

', 'DescribeVpcPeeringConnections' => '

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

', 'GetGameSessionLogUrl' => '

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

 ', 'GetInstanceAccess' => '

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.

Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you\'re making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet\'s instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned containing the instance\'s IP address and a set of credentials.

', 'ListAliases' => '

Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Returned aliases are not listed in any particular order.

 ', 'ListBuilds' => '

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

 ', 'ListFleets' => '

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in any particular order.

 ', 'PutScalingPolicy' => '

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet\'s hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet\'s capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet\'s hosting capacity is ready to host game sessions but is not currently in use. This is the fleet\'s buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet\'s available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it\'s successfully created. If the fleet\'s auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."

A policy\'s rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they\'re successfully created. If the fleet\'s auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

', 'RequestUploadCredentials' => '

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift\'s Amazon S3. This is done as part of the build creation process; see CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

', 'ResolveAlias' => '

Retrieves the fleet ID that a specified alias is currently pointing to.

', 'SearchGameSessions' => '

Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes:

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages.

You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails.

', 'StartFleetActions' => '

Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet\'s auto-scaling activity.

To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet\'s scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet\'s stopped actions using DescribeFleetAttributes.

', 'StartGameSessionPlacement' => '

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue\'s destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue\'s destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region\'s average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement and check the request\'s status. If the status is FULFILLED, a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

', 'StartMatchBackfill' => '

Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.

To request a match backfill, specify a unique ticket ID, the existing game session\'s ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker\'s ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch.

The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session\'s connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works.

', 'StartMatchmaking' => '

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration. For complete information on setting up and using FlexMatch, see the topic Adding FlexMatch to Your Game.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED. Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches.

Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests:

Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows:

  1. Your client code submits a StartMatchmaking request for one or more players and tracks the status of the request ticket.

  2. FlexMatch uses this ticket and others in process to build an acceptable match. When a potential match is identified, all tickets in the proposed match are advanced to the next status.

  3. If the match requires player acceptance (set in the matchmaking configuration), the tickets move into status REQUIRES_ACCEPTANCE. This status triggers your client code to solicit acceptance from all players in every ticket involved in the match, and then call AcceptMatch for each player. If any player rejects or fails to accept the match before a specified timeout, the proposed match is dropped (see AcceptMatch for more details).

  4. Once a match is proposed and accepted, the matchmaking tickets move into status PLACING. FlexMatch locates resources for a new game session using the game session queue (set in the matchmaking configuration) and creates the game session based on the match data.

  5. When the match is successfully placed, the matchmaking tickets move into COMPLETED status. Connection information (including game session endpoint and player session) is added to the matchmaking tickets. Matched players can use the connection information to join the game.

', 'StopFleetActions' => '

Suspends activity on a fleet. Currently, this operation is used to stop a fleet\'s auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet\'s scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet\'s stopped actions using DescribeFleetAttributes.

To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet\'s desired instances setting (FleetCapacity. Changes to the fleet\'s capacity must be done manually using UpdateFleetCapacity.

', 'StopGameSessionPlacement' => '

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

', 'StopMatchmaking' => '

Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

', 'UpdateAlias' => '

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

', 'UpdateBuild' => '

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

', 'UpdateFleetAttributes' => '

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

', 'UpdateFleetCapacity' => '

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet\'s EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet\'s active instance count matches the desired instance count. You can view a fleet\'s current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type\'s limit, the "Limit Exceeded" exception occurs.

', 'UpdateFleetPortSettings' => '

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

', 'UpdateGameSession' => '

Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.

', 'UpdateGameSessionQueue' => '

Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

', 'UpdateMatchmakingConfiguration' => '

Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings.

', 'UpdateRuntimeConfiguration' => '

Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet\'s run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift\'s normal process recycling activity.

', 'ValidateMatchmakingRuleSet' => '

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.

Learn more

Related operations

', ], 'shapes' => [ 'AcceptMatchInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'AcceptMatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'AcceptanceType' => [ 'base' => NULL, 'refs' => [ 'AcceptMatchInput$AcceptanceType' => '

Player response to the proposed match.

', ], ], 'Alias' => [ 'base' => '

Properties describing a fleet alias.

', 'refs' => [ 'AliasList$member' => NULL, 'CreateAliasOutput$Alias' => '

Object that describes the newly created alias record.

', 'DescribeAliasOutput$Alias' => '

Object that contains the requested alias.

', 'UpdateAliasOutput$Alias' => '

Object that contains the updated alias configuration.

', ], ], 'AliasId' => [ 'base' => NULL, 'refs' => [ 'Alias$AliasId' => '

Unique identifier for an alias; alias IDs are unique within a region.

', 'CreateGameSessionInput$AliasId' => '

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

', 'DeleteAliasInput$AliasId' => '

Unique identifier for a fleet alias. Specify the alias you want to delete.

', 'DescribeAliasInput$AliasId' => '

Unique identifier for a fleet alias. Specify the alias you want to retrieve.

', 'DescribeGameSessionDetailsInput$AliasId' => '

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

', 'DescribeGameSessionsInput$AliasId' => '

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

', 'ResolveAliasInput$AliasId' => '

Unique identifier for the alias you want to resolve.

', 'SearchGameSessionsInput$AliasId' => '

Unique identifier for an alias associated with the fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

', 'UpdateAliasInput$AliasId' => '

Unique identifier for a fleet alias. Specify the alias you want to update.

', ], ], 'AliasList' => [ 'base' => NULL, 'refs' => [ 'ListAliasesOutput$Aliases' => '

Collection of alias records that match the list request.

', ], ], 'ArnStringModel' => [ 'base' => NULL, 'refs' => [ 'Alias$AliasArn' => '

Unique identifier for an alias; alias ARNs are unique across all regions.

', 'CreatePlayerSessionInput$GameSessionId' => '

Unique identifier for the game session to add a player to.

', 'CreatePlayerSessionsInput$GameSessionId' => '

Unique identifier for the game session to add players to.

', 'DescribeGameSessionDetailsInput$GameSessionId' => '

Unique identifier for the game session to retrieve.

', 'DescribeGameSessionsInput$GameSessionId' => '

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

', 'DescribePlayerSessionsInput$GameSessionId' => '

Unique identifier for the game session to retrieve player sessions for.

', 'FleetAttributes$FleetArn' => '

Identifier for a fleet that is unique across all regions.

', 'GameSessionConnectionInfo$GameSessionArn' => '

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

', 'GameSessionQueue$GameSessionQueueArn' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

', 'GameSessionQueueDestination$DestinationArn' => '

Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.

', 'GetGameSessionLogUrlInput$GameSessionId' => '

Unique identifier for the game session to get logs for.

', 'QueueArnsList$member' => NULL, 'StartMatchBackfillInput$GameSessionArn' => '

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

', 'UpdateGameSessionInput$GameSessionId' => '

Unique identifier for the game session to update.

', ], ], 'AttributeValue' => [ 'base' => '

Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.

', 'refs' => [ 'PlayerAttributeMap$value' => NULL, ], ], 'AwsCredentials' => [ 'base' => '

Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.

', 'refs' => [ 'CreateBuildOutput$UploadCredentials' => '

This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.

', 'RequestUploadCredentialsOutput$UploadCredentials' => '

AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

', ], ], 'BooleanModel' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$AcceptanceRequired' => '

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

', 'MatchmakingConfiguration$AcceptanceRequired' => '

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

', 'UpdateMatchmakingConfigurationInput$AcceptanceRequired' => '

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

', 'ValidateMatchmakingRuleSetOutput$Valid' => '

Response indicating whether or not the rule set is valid.

', ], ], 'Build' => [ 'base' => '

Properties describing a game build.

', 'refs' => [ 'BuildList$member' => NULL, 'CreateBuildOutput$Build' => '

The newly created build record, including a unique build ID and status.

', 'DescribeBuildOutput$Build' => '

Set of properties describing the requested build.

', 'UpdateBuildOutput$Build' => '

Object that contains the updated build record.

', ], ], 'BuildId' => [ 'base' => NULL, 'refs' => [ 'Build$BuildId' => '

Unique identifier for a build.

', 'CreateFleetInput$BuildId' => '

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

', 'DeleteBuildInput$BuildId' => '

Unique identifier for a build to delete.

', 'DescribeBuildInput$BuildId' => '

Unique identifier for a build to retrieve properties for.

', 'FleetAttributes$BuildId' => '

Unique identifier for a build.

', 'ListFleetsInput$BuildId' => '

Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

', 'RequestUploadCredentialsInput$BuildId' => '

Unique identifier for a build to get credentials for.

', 'UpdateBuildInput$BuildId' => '

Unique identifier for a build to update.

', ], ], 'BuildList' => [ 'base' => NULL, 'refs' => [ 'ListBuildsOutput$Builds' => '

Collection of build records that match the request.

', ], ], 'BuildStatus' => [ 'base' => NULL, 'refs' => [ 'Build$Status' => '

Current status of the build.

Possible build statuses include the following:

', 'ListBuildsInput$Status' => '

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

', ], ], 'ComparisonOperatorType' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$ComparisonOperator' => '

Comparison operator to use when measuring the metric against the threshold value.

', 'ScalingPolicy$ComparisonOperator' => '

Comparison operator to use when measuring a metric against the threshold value.

', ], ], 'ConflictException' => [ 'base' => '

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

', 'refs' => [], ], 'CreateAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateBuildOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateFleetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateFleetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateGameSessionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateGameSessionOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateGameSessionQueueInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateGameSessionQueueOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateMatchmakingConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateMatchmakingConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateMatchmakingRuleSetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateMatchmakingRuleSetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreatePlayerSessionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreatePlayerSessionOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreatePlayerSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreatePlayerSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateVpcPeeringAuthorizationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateVpcPeeringAuthorizationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateVpcPeeringConnectionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateVpcPeeringConnectionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CustomEventData' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$CustomEventData' => '

Information to attached to all events related to the matchmaking configuration.

', 'MatchmakingConfiguration$CustomEventData' => '

Information to attached to all events related to the matchmaking configuration.

', 'UpdateMatchmakingConfigurationInput$CustomEventData' => '

Information to attached to all events related to the matchmaking configuration.

', ], ], 'DeleteAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteFleetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteGameSessionQueueInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteGameSessionQueueOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMatchmakingConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteMatchmakingConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMatchmakingRuleSetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteMatchmakingRuleSetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DeleteScalingPolicyInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteVpcPeeringAuthorizationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteVpcPeeringAuthorizationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVpcPeeringConnectionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteVpcPeeringConnectionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeBuildOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeEC2InstanceLimitsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeEC2InstanceLimitsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetAttributesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetAttributesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetCapacityInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetCapacityOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetEventsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetEventsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetPortSettingsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetPortSettingsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetUtilizationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetUtilizationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionDetailsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionDetailsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionPlacementInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionPlacementOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionQueuesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionQueuesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeInstancesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeInstancesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeMatchmakingConfigurationsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeMatchmakingConfigurationsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeMatchmakingInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeMatchmakingOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeMatchmakingRuleSetsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeMatchmakingRuleSetsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribePlayerSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribePlayerSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeRuntimeConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeRuntimeConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeScalingPoliciesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeScalingPoliciesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeVpcPeeringAuthorizationsInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcPeeringAuthorizationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcPeeringConnectionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeVpcPeeringConnectionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DesiredPlayerSession' => [ 'base' => '

Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement.

', 'refs' => [ 'DesiredPlayerSessionList$member' => NULL, ], ], 'DesiredPlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'StartGameSessionPlacementInput$DesiredPlayerSessions' => '

Set of information on each player to create a player session for.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$Threshold' => '

Metric value used to trigger a scaling event.

', 'ScalingPolicy$Threshold' => '

Metric value used to trigger a scaling event.

', 'TargetConfiguration$TargetValue' => '

Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet\'s buffer (the percent of capacity that should be idle and ready for new game sessions).

', ], ], 'DoubleObject' => [ 'base' => NULL, 'refs' => [ 'AttributeValue$N' => '

For number values, expressed as double.

', 'StringDoubleMap$value' => NULL, ], ], 'EC2InstanceCounts' => [ 'base' => '

Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.

', 'refs' => [ 'FleetCapacity$InstanceCounts' => '

Current status of fleet capacity.

', ], ], 'EC2InstanceLimit' => [ 'base' => '

Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.

', 'refs' => [ 'EC2InstanceLimitList$member' => NULL, ], ], 'EC2InstanceLimitList' => [ 'base' => NULL, 'refs' => [ 'DescribeEC2InstanceLimitsOutput$EC2InstanceLimits' => '

Object that contains the maximum number of instances for the specified instance type.

', ], ], 'EC2InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$EC2InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

', 'DescribeEC2InstanceLimitsInput$EC2InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.

', 'EC2InstanceLimit$EC2InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

', 'FleetAttributes$InstanceType' => '

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

', 'FleetCapacity$InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

', 'Instance$Type' => '

EC2 instance type that defines the computing resources of this instance.

', ], ], 'Event' => [ 'base' => '

Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCode' => [ 'base' => NULL, 'refs' => [ 'Event$EventCode' => '

Type of event being logged. The following events are currently in use:

Fleet creation events:

VPC peering events:

Spot instance events:

Other fleet events:

', ], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetEventsOutput$Events' => '

Collection of objects containing event log entries for the specified fleet.

', ], ], 'FleetAction' => [ 'base' => NULL, 'refs' => [ 'FleetActionList$member' => NULL, ], ], 'FleetActionList' => [ 'base' => NULL, 'refs' => [ 'FleetAttributes$StoppedActions' => '

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

', 'StartFleetActionsInput$Actions' => '

List of actions to restart on the fleet.

', 'StopFleetActionsInput$Actions' => '

List of actions to suspend on the fleet.

', ], ], 'FleetAttributes' => [ 'base' => '

General properties describing a fleet.

', 'refs' => [ 'CreateFleetOutput$FleetAttributes' => '

Properties for the newly created fleet.

', 'FleetAttributesList$member' => NULL, ], ], 'FleetAttributesList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetAttributesOutput$FleetAttributes' => '

Collection of objects containing attribute metadata for each requested fleet ID.

', ], ], 'FleetCapacity' => [ 'base' => '

Information about the fleet\'s capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet\'s instance type.

', 'refs' => [ 'FleetCapacityList$member' => NULL, ], ], 'FleetCapacityExceededException' => [ 'base' => '

The specified fleet has no available instances to fulfill a CreateGameSession request. Clients can retry such requests immediately or after a waiting period.

', 'refs' => [], ], 'FleetCapacityList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetCapacityOutput$FleetCapacity' => '

Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.

', ], ], 'FleetId' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$FleetId' => '

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

', 'CreateVpcPeeringConnectionInput$FleetId' => '

Unique identifier for a fleet. This tells Amazon GameLift which GameLift VPC to peer with.

', 'DeleteFleetInput$FleetId' => '

Unique identifier for a fleet to be deleted.

', 'DeleteScalingPolicyInput$FleetId' => '

Unique identifier for a fleet to be deleted.

', 'DeleteVpcPeeringConnectionInput$FleetId' => '

Unique identifier for a fleet. This value must match the fleet ID referenced in the VPC peering connection record.

', 'DescribeFleetEventsInput$FleetId' => '

Unique identifier for a fleet to get event logs for.

', 'DescribeFleetPortSettingsInput$FleetId' => '

Unique identifier for a fleet to retrieve port settings for.

', 'DescribeGameSessionDetailsInput$FleetId' => '

Unique identifier for a fleet to retrieve all game sessions active on the fleet.

', 'DescribeGameSessionsInput$FleetId' => '

Unique identifier for a fleet to retrieve all game sessions for.

', 'DescribeInstancesInput$FleetId' => '

Unique identifier for a fleet to retrieve instance information for.

', 'DescribeRuntimeConfigurationInput$FleetId' => '

Unique identifier for a fleet to get the run-time configuration for.

', 'DescribeScalingPoliciesInput$FleetId' => '

Unique identifier for a fleet to retrieve scaling policies for.

', 'DescribeVpcPeeringConnectionsInput$FleetId' => '

Unique identifier for a fleet.

', 'FleetAttributes$FleetId' => '

Unique identifier for a fleet.

', 'FleetCapacity$FleetId' => '

Unique identifier for a fleet.

', 'FleetIdList$member' => NULL, 'FleetUtilization$FleetId' => '

Unique identifier for a fleet.

', 'GameSession$FleetId' => '

Unique identifier for a fleet that the game session is running on.

', 'GetInstanceAccessInput$FleetId' => '

Unique identifier for a fleet that contains the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.

', 'Instance$FleetId' => '

Unique identifier for a fleet that the instance is in.

', 'InstanceAccess$FleetId' => '

Unique identifier for a fleet containing the instance being accessed.

', 'PlayerSession$FleetId' => '

Unique identifier for a fleet that the player\'s game session is running on.

', 'PutScalingPolicyInput$FleetId' => '

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

', 'ResolveAliasOutput$FleetId' => '

Fleet identifier that is associated with the requested alias.

', 'RoutingStrategy$FleetId' => '

Unique identifier for a fleet that the alias points to.

', 'ScalingPolicy$FleetId' => '

Unique identifier for a fleet that is associated with this scaling policy.

', 'SearchGameSessionsInput$FleetId' => '

Unique identifier for a fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

', 'StartFleetActionsInput$FleetId' => '

Unique identifier for a fleet

', 'StopFleetActionsInput$FleetId' => '

Unique identifier for a fleet

', 'UpdateFleetAttributesInput$FleetId' => '

Unique identifier for a fleet to update attribute metadata for.

', 'UpdateFleetAttributesOutput$FleetId' => '

Unique identifier for a fleet that was updated.

', 'UpdateFleetCapacityInput$FleetId' => '

Unique identifier for a fleet to update capacity for.

', 'UpdateFleetCapacityOutput$FleetId' => '

Unique identifier for a fleet that was updated.

', 'UpdateFleetPortSettingsInput$FleetId' => '

Unique identifier for a fleet to update port settings for.

', 'UpdateFleetPortSettingsOutput$FleetId' => '

Unique identifier for a fleet that was updated.

', 'UpdateRuntimeConfigurationInput$FleetId' => '

Unique identifier for a fleet to update run-time configuration for.

', 'VpcPeeringConnection$FleetId' => '

Unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

', ], ], 'FleetIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetAttributesInput$FleetIds' => '

Unique identifier for a fleet(s) to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.

', 'DescribeFleetCapacityInput$FleetIds' => '

Unique identifier for a fleet(s) to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

', 'DescribeFleetUtilizationInput$FleetIds' => '

Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.

', 'ListFleetsOutput$FleetIds' => '

Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization.

', ], ], 'FleetStatus' => [ 'base' => NULL, 'refs' => [ 'FleetAttributes$Status' => '

Current status of the fleet.

Possible fleet statuses include the following:

', ], ], 'FleetType' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$FleetType' => '

Indicates whether to use on-demand instances or spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations, based on the instance type selected for this fleet. You can acquire on-demand instances at any time for a fixed price and keep them as long as you need them. Spot instances have lower prices, but spot pricing is variable, and while in use they can be interrupted (with a two-minute notification). Learn more about Amazon GameLift spot instances with at Set up Access to External Services.

', 'FleetAttributes$FleetType' => '

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

', ], ], 'FleetUtilization' => [ 'base' => '

Current status of fleet utilization, including the number of game and player sessions being hosted.

', 'refs' => [ 'FleetUtilizationList$member' => NULL, ], ], 'FleetUtilizationList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetUtilizationOutput$FleetUtilization' => '

Collection of objects containing utilization information for each requested fleet ID.

', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'PlayerLatency$LatencyInMilliseconds' => '

Amount of time that represents the time lag experienced by the player when connected to the specified region.

', ], ], 'FreeText' => [ 'base' => NULL, 'refs' => [ 'Alias$Description' => '

Human-readable description of an alias.

', 'Build$Name' => '

Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

', 'Build$Version' => '

Version that is associated with this build. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

', 'RoutingStrategy$Message' => '

Message text to be used with a terminal routing strategy.

', ], ], 'GameProperty' => [ 'base' => '

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide.

', 'refs' => [ 'GamePropertyList$member' => NULL, ], ], 'GamePropertyKey' => [ 'base' => NULL, 'refs' => [ 'GameProperty$Key' => '

Game property identifier.

', ], ], 'GamePropertyList' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'CreateMatchmakingConfigurationInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'GameSession$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions.

', 'GameSessionPlacement$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'MatchmakingConfiguration$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'StartGameSessionPlacementInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'UpdateMatchmakingConfigurationInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', ], ], 'GamePropertyValue' => [ 'base' => NULL, 'refs' => [ 'GameProperty$Value' => '

Game property value.

', ], ], 'GameSession' => [ 'base' => '

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

', 'refs' => [ 'CreateGameSessionOutput$GameSession' => '

Object that describes the newly created game session record.

', 'GameSessionDetail$GameSession' => '

Object that describes a game session.

', 'GameSessionList$member' => NULL, 'UpdateGameSessionOutput$GameSession' => '

Object that contains the updated game session metadata.

', ], ], 'GameSessionActivationTimeoutSeconds' => [ 'base' => NULL, 'refs' => [ 'RuntimeConfiguration$GameSessionActivationTimeoutSeconds' => '

Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.

', ], ], 'GameSessionConnectionInfo' => [ 'base' => '

Connection information for the new game session that is created with matchmaking. (with StartMatchmaking). Once a match is set, the FlexMatch engine places the match and creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.

', 'refs' => [ 'MatchmakingTicket$GameSessionConnectionInfo' => '

Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.

', ], ], 'GameSessionData' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'CreateMatchmakingConfigurationInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'GameSession$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'GameSessionPlacement$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'MatchmakingConfiguration$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'StartGameSessionPlacementInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'UpdateMatchmakingConfigurationInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', ], ], 'GameSessionDetail' => [ 'base' => '

A game session\'s properties plus the protection policy currently in force.

', 'refs' => [ 'GameSessionDetailList$member' => NULL, ], ], 'GameSessionDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionDetailsOutput$GameSessionDetails' => '

Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.

', ], ], 'GameSessionFullException' => [ 'base' => '

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

', 'refs' => [], ], 'GameSessionList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionsOutput$GameSessions' => '

Collection of objects containing game session properties for each session matching the request.

', 'SearchGameSessionsOutput$GameSessions' => '

Collection of objects containing game session properties for each session matching the request.

', ], ], 'GameSessionPlacement' => [ 'base' => '

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

', 'refs' => [ 'DescribeGameSessionPlacementOutput$GameSessionPlacement' => '

Object that describes the requested game session placement.

', 'StartGameSessionPlacementOutput$GameSessionPlacement' => '

Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status.

', 'StopGameSessionPlacementOutput$GameSessionPlacement' => '

Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

', ], ], 'GameSessionPlacementState' => [ 'base' => NULL, 'refs' => [ 'GameSessionPlacement$Status' => '

Current status of the game session placement request.

', ], ], 'GameSessionQueue' => [ 'base' => '

Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:

', 'refs' => [ 'CreateGameSessionQueueOutput$GameSessionQueue' => '

Object that describes the newly created game session queue.

', 'GameSessionQueueList$member' => NULL, 'UpdateGameSessionQueueOutput$GameSessionQueue' => '

Object that describes the newly updated game session queue.

', ], ], 'GameSessionQueueDestination' => [ 'base' => '

Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.

', 'refs' => [ 'GameSessionQueueDestinationList$member' => NULL, ], ], 'GameSessionQueueDestinationList' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionQueueInput$Destinations' => '

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

', 'GameSessionQueue$Destinations' => '

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

', 'UpdateGameSessionQueueInput$Destinations' => '

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.

', ], ], 'GameSessionQueueList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionQueuesOutput$GameSessionQueues' => '

Collection of objects that describes the requested game session queues.

', ], ], 'GameSessionQueueName' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionQueueInput$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'DeleteGameSessionQueueInput$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'GameSessionPlacement$GameSessionQueueName' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'GameSessionQueue$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'GameSessionQueueNameList$member' => NULL, 'StartGameSessionPlacementInput$GameSessionQueueName' => '

Name of the queue to use to place the new game session.

', 'UpdateGameSessionQueueInput$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', ], ], 'GameSessionQueueNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionQueuesInput$Names' => '

List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty.

', ], ], 'GameSessionStatus' => [ 'base' => NULL, 'refs' => [ 'GameSession$Status' => '

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

', ], ], 'GameSessionStatusReason' => [ 'base' => NULL, 'refs' => [ 'GameSession$StatusReason' => '

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

', ], ], 'GetGameSessionLogUrlInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'GetGameSessionLogUrlOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'GetInstanceAccessInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'GetInstanceAccessOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'IdStringModel' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$GameSessionId' => '

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session\'s ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

', 'CreateGameSessionInput$IdempotencyToken' => '

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session\'s ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

', 'DescribeGameSessionPlacementInput$PlacementId' => '

Unique identifier for a game session placement to retrieve.

', 'GameSessionPlacement$PlacementId' => '

Unique identifier for a game session placement.

', 'StartGameSessionPlacementInput$PlacementId' => '

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

', 'StopGameSessionPlacementInput$PlacementId' => '

Unique identifier for a game session placement to cancel.

', ], ], 'IdempotentParameterMismatchException' => [ 'base' => '

A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.

', 'refs' => [], ], 'Instance' => [ 'base' => '

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.

', 'refs' => [ 'InstanceList$member' => NULL, ], ], 'InstanceAccess' => [ 'base' => '

Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.

', 'refs' => [ 'GetInstanceAccessOutput$InstanceAccess' => '

Object that contains connection information for a fleet instance, including IP address and access credentials.

', ], ], 'InstanceCredentials' => [ 'base' => '

Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.

', 'refs' => [ 'InstanceAccess$Credentials' => '

Credentials required to access the instance.

', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'DescribeInstancesInput$InstanceId' => '

Unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

', 'GetInstanceAccessInput$InstanceId' => '

Unique identifier for an instance you want to get access to. You can access an instance in any status.

', 'Instance$InstanceId' => '

Unique identifier for an instance.

', 'InstanceAccess$InstanceId' => '

Unique identifier for an instance being accessed.

', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeInstancesOutput$Instances' => '

Collection of objects containing properties for each instance returned.

', ], ], 'InstanceStatus' => [ 'base' => NULL, 'refs' => [ 'Instance$Status' => '

Current status of the instance. Possible statuses include the following:

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$ScalingAdjustment' => '

Amount of adjustment to make, based on the scaling adjustment type.

', 'ScalingPolicy$ScalingAdjustment' => '

Amount of adjustment to make, based on the scaling adjustment type.

', ], ], 'InternalServiceException' => [ 'base' => '

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

', 'refs' => [], ], 'InvalidFleetStatusException' => [ 'base' => '

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

', 'refs' => [], ], 'InvalidGameSessionStatusException' => [ 'base' => '

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

', 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'GameSession$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'GameSessionPlacement$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

', 'Instance$IpAddress' => '

IP address assigned to the instance.

', 'InstanceAccess$IpAddress' => '

IP address assigned to the instance.

', 'PlayerSession$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', ], ], 'IpPermission' => [ 'base' => '

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet\'s allowed ranges. This combination is included in the GameSession object.

', 'refs' => [ 'IpPermissionsList$member' => NULL, ], ], 'IpPermissionsList' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$EC2InboundPermissions' => '

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

', 'DescribeFleetPortSettingsOutput$InboundPermissions' => '

Object that contains port settings for the requested fleet ID.

', 'UpdateFleetPortSettingsInput$InboundPermissionAuthorizations' => '

Collection of port settings to be added to the fleet record.

', 'UpdateFleetPortSettingsInput$InboundPermissionRevocations' => '

Collection of port settings to be removed from the fleet record.

', ], ], 'IpProtocol' => [ 'base' => NULL, 'refs' => [ 'IpPermission$Protocol' => '

Network communication protocol used by the fleet.

', ], ], 'LatencyMap' => [ 'base' => NULL, 'refs' => [ 'Player$LatencyInMs' => '

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.

If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.

', ], ], 'LimitExceededException' => [ 'base' => '

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

', 'refs' => [], ], 'ListAliasesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ListAliasesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ListBuildsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ListBuildsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ListFleetsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ListFleetsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'MatchedPlayerSession' => [ 'base' => '

Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.

When players connect to the match\'s game session, they must include both player ID and player session ID in order to claim their assigned player slot.

', 'refs' => [ 'MatchedPlayerSessionList$member' => NULL, ], ], 'MatchedPlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'GameSessionConnectionInfo$MatchedPlayerSessions' => '

Collection of player session IDs, one for each player ID that was included in the original matchmaking request.

', ], ], 'MatchmakerData' => [ 'base' => NULL, 'refs' => [ 'GameSession$MatchmakerData' => '

Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

', 'GameSessionPlacement$MatchmakerData' => '

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

', ], ], 'MatchmakingAcceptanceTimeoutInteger' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$AcceptanceTimeoutSeconds' => '

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

', 'MatchmakingConfiguration$AcceptanceTimeoutSeconds' => '

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

', 'UpdateMatchmakingConfigurationInput$AcceptanceTimeoutSeconds' => '

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

', ], ], 'MatchmakingConfiguration' => [ 'base' => '

Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.

', 'refs' => [ 'CreateMatchmakingConfigurationOutput$Configuration' => '

Object that describes the newly created matchmaking configuration.

', 'MatchmakingConfigurationList$member' => NULL, 'UpdateMatchmakingConfigurationOutput$Configuration' => '

Object that describes the updated matchmaking configuration.

', ], ], 'MatchmakingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingConfigurationsOutput$Configurations' => '

Collection of requested matchmaking configuration objects.

', ], ], 'MatchmakingConfigurationStatus' => [ 'base' => NULL, 'refs' => [ 'MatchmakingTicket$Status' => '

Current status of the matchmaking request.

Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.

', ], ], 'MatchmakingIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingConfigurationsInput$Names' => '

Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty.

', 'DescribeMatchmakingInput$TicketIds' => '

Unique identifier for a matchmaking ticket. You can include up to 10 ID values.

', ], ], 'MatchmakingIdStringModel' => [ 'base' => NULL, 'refs' => [ 'AcceptMatchInput$TicketId' => '

Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

', 'CreateMatchmakingConfigurationInput$Name' => '

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

', 'CreateMatchmakingConfigurationInput$RuleSetName' => '

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

', 'CreateMatchmakingRuleSetInput$Name' => '

Unique identifier for a matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. (Note: The rule set name is different from the optional "name" field in the rule set body.)

', 'DeleteMatchmakingConfigurationInput$Name' => '

Unique identifier for a matchmaking configuration

', 'DeleteMatchmakingRuleSetInput$Name' => '

Unique identifier for a matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.)

', 'DescribeMatchmakingConfigurationsInput$RuleSetName' => '

Unique identifier for a matchmaking rule set. Use this parameter to retrieve all matchmaking configurations that use this rule set.

', 'MatchmakingConfiguration$Name' => '

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

', 'MatchmakingConfiguration$RuleSetName' => '

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

', 'MatchmakingIdList$member' => NULL, 'MatchmakingRuleSet$RuleSetName' => '

Unique identifier for a matchmaking rule set

', 'MatchmakingRuleSetNameList$member' => NULL, 'MatchmakingTicket$TicketId' => '

Unique identifier for a matchmaking ticket.

', 'MatchmakingTicket$ConfigurationName' => '

Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

', 'StartMatchBackfillInput$TicketId' => '

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

', 'StartMatchBackfillInput$ConfigurationName' => '

Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4", the matchmaking configuration name is "MM-4v4".) Use only the name for this parameter.

', 'StartMatchmakingInput$TicketId' => '

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

', 'StartMatchmakingInput$ConfigurationName' => '

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

', 'StopMatchmakingInput$TicketId' => '

Unique identifier for a matchmaking ticket.

', 'UpdateMatchmakingConfigurationInput$Name' => '

Unique identifier for a matchmaking configuration to update.

', 'UpdateMatchmakingConfigurationInput$RuleSetName' => '

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

', ], ], 'MatchmakingRequestTimeoutInteger' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$RequestTimeoutSeconds' => '

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

', 'MatchmakingConfiguration$RequestTimeoutSeconds' => '

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

', 'UpdateMatchmakingConfigurationInput$RequestTimeoutSeconds' => '

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

', ], ], 'MatchmakingRuleSet' => [ 'base' => '

Set of rule statements, used with FlexMatch, that determine how to build a certain kind of player match. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.

A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch Rule Set.

', 'refs' => [ 'CreateMatchmakingRuleSetOutput$RuleSet' => '

Object that describes the newly created matchmaking rule set.

', 'MatchmakingRuleSetList$member' => NULL, ], ], 'MatchmakingRuleSetList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingRuleSetsOutput$RuleSets' => '

Collection of requested matchmaking rule set objects.

', ], ], 'MatchmakingRuleSetNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingRuleSetsInput$Names' => '

List of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.)

', ], ], 'MatchmakingTicket' => [ 'base' => '

Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.

', 'refs' => [ 'MatchmakingTicketList$member' => NULL, 'StartMatchBackfillOutput$MatchmakingTicket' => '

Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

', 'StartMatchmakingOutput$MatchmakingTicket' => '

Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.

', ], ], 'MatchmakingTicketList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingOutput$TicketList' => '

Collection of existing matchmaking ticket objects matching the request.

', ], ], 'MaxConcurrentGameSessionActivations' => [ 'base' => NULL, 'refs' => [ 'RuntimeConfiguration$MaxConcurrentGameSessionActivations' => '

Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.

', ], ], 'MetricGroup' => [ 'base' => NULL, 'refs' => [ 'MetricGroupList$member' => NULL, ], ], 'MetricGroupList' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$MetricGroups' => '

Name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.

', 'FleetAttributes$MetricGroups' => '

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

', 'UpdateFleetAttributesInput$MetricGroups' => '

Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$MetricName' => '

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

', 'ScalingPolicy$MetricName' => '

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

', ], ], 'NonBlankAndLengthConstraintString' => [ 'base' => NULL, 'refs' => [ 'Alias$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', 'CreateAliasInput$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', 'UpdateAliasInput$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', ], ], 'NonBlankString' => [ 'base' => NULL, 'refs' => [ 'IpPermission$IpRange' => '

Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AwsCredentials$AccessKeyId' => '

Temporary key allowing access to the Amazon GameLift S3 account.

', 'AwsCredentials$SecretAccessKey' => '

Temporary secret key allowing access to the Amazon GameLift S3 account.

', 'AwsCredentials$SessionToken' => '

Token used to associate a specific build ID with the files uploaded using these credentials.

', 'ConflictException$Message' => NULL, 'Event$Message' => '

Additional information related to the event.

', 'FleetCapacityExceededException$Message' => NULL, 'GameSessionFullException$Message' => NULL, 'IdempotentParameterMismatchException$Message' => NULL, 'InstanceCredentials$UserName' => '

User login string.

', 'InstanceCredentials$Secret' => '

Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux instances, it is a private key (which must be saved as a .pem file) for use with SSH.

', 'InternalServiceException$Message' => NULL, 'InvalidFleetStatusException$Message' => NULL, 'InvalidGameSessionStatusException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'LatencyMap$key' => NULL, 'LimitExceededException$Message' => NULL, 'ListAliasesInput$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', 'ListAliasesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'ListAliasesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'ListBuildsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'ListBuildsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'NotFoundException$Message' => NULL, 'S3Location$Bucket' => '

Amazon S3 bucket identifier. This is the name of your S3 bucket.

', 'S3Location$Key' => '

Name of the zip file containing your build files.

', 'S3Location$RoleArn' => '

Amazon Resource Name (ARN) for the access role that allows Amazon GameLift to access your S3 bucket.

', 'TerminalRoutingStrategyException$Message' => NULL, 'UnauthorizedException$Message' => NULL, 'UnsupportedRegionException$Message' => NULL, ], ], 'NonZeroAndMaxString' => [ 'base' => NULL, 'refs' => [ 'AttributeValue$S' => '

For single string values. Maximum string length is 100 characters.

', 'CreateAliasInput$Description' => '

Human-readable description of an alias.

', 'CreateBuildInput$Name' => '

Descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

', 'CreateBuildInput$Version' => '

Version that is associated with this build. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

', 'CreateFleetInput$Name' => '

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

', 'CreateFleetInput$Description' => '

Human-readable description of a fleet.

', 'CreateFleetInput$ServerLaunchPath' => '

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

', 'CreateFleetInput$ServerLaunchParameters' => '

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

', 'CreateFleetInput$PeerVpcAwsAccountId' => '

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

', 'CreateFleetInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'CreateGameSessionInput$Name' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'CreateGameSessionInput$CreatorId' => '

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

', 'CreateMatchmakingConfigurationInput$Description' => '

Meaningful description of the matchmaking configuration.

', 'CreatePlayerSessionInput$PlayerId' => '

Unique identifier for a player. Player IDs are developer-defined.

', 'CreateVpcPeeringAuthorizationInput$GameLiftAwsAccountId' => '

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

', 'CreateVpcPeeringAuthorizationInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'CreateVpcPeeringConnectionInput$PeerVpcAwsAccountId' => '

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

', 'CreateVpcPeeringConnectionInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'DeleteScalingPolicyInput$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

', 'DeleteVpcPeeringAuthorizationInput$GameLiftAwsAccountId' => '

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

', 'DeleteVpcPeeringAuthorizationInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'DeleteVpcPeeringConnectionInput$VpcPeeringConnectionId' => '

Unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

', 'DescribeFleetAttributesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetAttributesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeFleetCapacityInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetCapacityOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeFleetEventsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeFleetEventsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeFleetUtilizationInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetUtilizationOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeGameSessionDetailsInput$StatusFilter' => '

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

', 'DescribeGameSessionDetailsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeGameSessionDetailsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeGameSessionQueuesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeGameSessionQueuesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeGameSessionsInput$StatusFilter' => '

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

', 'DescribeGameSessionsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeGameSessionsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeInstancesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeInstancesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeMatchmakingConfigurationsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeMatchmakingConfigurationsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeMatchmakingRuleSetsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeMatchmakingRuleSetsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribePlayerSessionsInput$PlayerId' => '

Unique identifier for a player to retrieve player sessions for.

', 'DescribePlayerSessionsInput$PlayerSessionStatusFilter' => '

Player session status to filter results on.

Possible player session statuses include the following:

', 'DescribePlayerSessionsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

', 'DescribePlayerSessionsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeScalingPoliciesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeScalingPoliciesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DesiredPlayerSession$PlayerId' => '

Unique identifier for a player to associate with the player session.

', 'Event$EventId' => '

Unique identifier for a fleet event.

', 'Event$ResourceId' => '

Unique identifier for an event resource, such as a fleet ID.

', 'Event$PreSignedLogUrl' => '

Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.

', 'FleetAttributes$Description' => '

Human-readable description of the fleet.

', 'FleetAttributes$Name' => '

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

', 'FleetAttributes$ServerLaunchPath' => '

Path to a game server executable in the fleet\'s build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet\'s RuntimeConfiguration.

', 'FleetAttributes$ServerLaunchParameters' => '

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet\'s RuntimeConfiguration.

', 'GameSession$GameSessionId' => '

Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

', 'GameSession$Name' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'GameSession$CreatorId' => '

Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

', 'GameSessionPlacement$GameSessionName' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'GameSessionPlacement$GameSessionId' => '

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

', 'GameSessionPlacement$GameSessionArn' => '

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

', 'GameSessionPlacement$GameSessionRegion' => '

Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

', 'GetGameSessionLogUrlOutput$PreSignedUrl' => '

Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.

', 'ListFleetsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'ListFleetsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'MatchedPlayerSession$PlayerId' => '

Unique identifier for a player

', 'MatchmakingConfiguration$Description' => '

Descriptive label that is associated with matchmaking configuration.

', 'PlacedPlayerSession$PlayerId' => '

Unique identifier for a player that is associated with this player session.

', 'Player$PlayerId' => '

Unique identifier for a player

', 'Player$Team' => '

Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

', 'PlayerAttributeMap$key' => NULL, 'PlayerDataMap$key' => NULL, 'PlayerIdList$member' => NULL, 'PlayerLatency$PlayerId' => '

Unique identifier for a player associated with the latency data.

', 'PlayerLatency$RegionIdentifier' => '

Name of the region that is associated with the latency value.

', 'PlayerSession$PlayerId' => '

Unique identifier for a player that is associated with this player session.

', 'PlayerSession$GameSessionId' => '

Unique identifier for the game session that the player session is connected to.

', 'PutScalingPolicyInput$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

', 'PutScalingPolicyOutput$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

', 'ScalingPolicy$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

', 'SearchGameSessionsInput$FilterExpression' => '

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

', 'SearchGameSessionsInput$SortExpression' => '

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

', 'SearchGameSessionsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'SearchGameSessionsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'ServerProcess$LaunchPath' => '

Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\\game, and for Linux instances /local/game. A Windows game build with an executable file located at MyGame\\latest\\server.exe must have a launch path of "C:\\game\\MyGame\\latest\\server.exe". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe".

', 'ServerProcess$Parameters' => '

Optional list of parameters to pass to the server executable on launch.

', 'StartGameSessionPlacementInput$GameSessionName' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'StringDoubleMap$key' => NULL, 'StringList$member' => NULL, 'UpdateAliasInput$Description' => '

Human-readable description of an alias.

', 'UpdateBuildInput$Name' => '

Descriptive label that is associated with a build. Build names do not need to be unique.

', 'UpdateBuildInput$Version' => '

Version that is associated with this build. Version strings do not need to be unique.

', 'UpdateFleetAttributesInput$Name' => '

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

', 'UpdateFleetAttributesInput$Description' => '

Human-readable description of a fleet.

', 'UpdateGameSessionInput$Name' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'UpdateMatchmakingConfigurationInput$Description' => '

Descriptive label that is associated with matchmaking configuration.

', 'VpcPeeringAuthorization$GameLiftAwsAccountId' => '

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

', 'VpcPeeringAuthorization$PeerVpcAwsAccountId' => '

', 'VpcPeeringAuthorization$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'VpcPeeringConnection$IpV4CidrBlock' => '

CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

', 'VpcPeeringConnection$VpcPeeringConnectionId' => '

Unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection.

', 'VpcPeeringConnection$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'VpcPeeringConnection$GameLiftVpcId' => '

Unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.

', 'VpcPeeringConnectionStatus$Code' => '

Code indicating the status of a VPC peering connection.

', 'VpcPeeringConnectionStatus$Message' => '

Additional messaging associated with the connection status.

', ], ], 'NotFoundException' => [ 'base' => '

A service resource associated with the request could not be found. Clients should not retry such requests.

', 'refs' => [], ], 'OperatingSystem' => [ 'base' => NULL, 'refs' => [ 'Build$OperatingSystem' => '

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

', 'CreateBuildInput$OperatingSystem' => '

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

', 'FleetAttributes$OperatingSystem' => '

Operating system of the fleet\'s computing resources. A fleet\'s operating system depends on the OS specified for the build that is deployed on this fleet.

', 'Instance$OperatingSystem' => '

Operating system that is running on this instance.

', 'InstanceAccess$OperatingSystem' => '

Operating system that is running on the instance.

', ], ], 'PlacedPlayerSession' => [ 'base' => '

Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.

', 'refs' => [ 'PlacedPlayerSessionList$member' => NULL, ], ], 'PlacedPlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'GameSessionPlacement$PlacedPlayerSessions' => '

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

', ], ], 'Player' => [ 'base' => '

Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.

', 'refs' => [ 'PlayerList$member' => NULL, ], ], 'PlayerAttributeMap' => [ 'base' => NULL, 'refs' => [ 'Player$PlayerAttributes' => '

Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

', ], ], 'PlayerData' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionInput$PlayerData' => '

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

', 'DesiredPlayerSession$PlayerData' => '

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

', 'PlayerDataMap$value' => NULL, 'PlayerSession$PlayerData' => '

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

', ], ], 'PlayerDataMap' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionsInput$PlayerDataMap' => '

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data strings for player IDs not included in the PlayerIds parameter are ignored.

', ], ], 'PlayerIdList' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionsInput$PlayerIds' => '

List of unique identifiers for the players to be added.

', ], ], 'PlayerLatency' => [ 'base' => '

Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player\'s latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.

', 'refs' => [ 'PlayerLatencyList$member' => NULL, ], ], 'PlayerLatencyList' => [ 'base' => NULL, 'refs' => [ 'GameSessionPlacement$PlayerLatencies' => '

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

', 'StartGameSessionPlacementInput$PlayerLatencies' => '

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

', ], ], 'PlayerLatencyPolicy' => [ 'base' => '

Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

', 'refs' => [ 'PlayerLatencyPolicyList$member' => NULL, ], ], 'PlayerLatencyPolicyList' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionQueueInput$PlayerLatencyPolicies' => '

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

', 'GameSessionQueue$PlayerLatencyPolicies' => '

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

', 'UpdateGameSessionQueueInput$PlayerLatencyPolicies' => '

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.

', ], ], 'PlayerList' => [ 'base' => NULL, 'refs' => [ 'MatchmakingTicket$Players' => '

A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

', 'StartMatchBackfillInput$Players' => '

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

', 'StartMatchmakingInput$Players' => '

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

', ], ], 'PlayerSession' => [ 'base' => '

Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED) or actual player activity in a game session (status ACTIVE). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.

When a player disconnects, the player session status changes to COMPLETED. Once the session ends, the player session object is retained for 30 days and then removed.

', 'refs' => [ 'CreatePlayerSessionOutput$PlayerSession' => '

Object that describes the newly created player session record.

', 'PlayerSessionList$member' => NULL, ], ], 'PlayerSessionCreationPolicy' => [ 'base' => NULL, 'refs' => [ 'GameSession$PlayerSessionCreationPolicy' => '

Indicates whether or not the game session is accepting new players.

', 'UpdateGameSessionInput$PlayerSessionCreationPolicy' => '

Policy determining whether or not the game session accepts new players.

', ], ], 'PlayerSessionId' => [ 'base' => NULL, 'refs' => [ 'DescribePlayerSessionsInput$PlayerSessionId' => '

Unique identifier for a player session to retrieve.

', 'MatchedPlayerSession$PlayerSessionId' => '

Unique identifier for a player session

', 'PlacedPlayerSession$PlayerSessionId' => '

Unique identifier for a player session.

', 'PlayerSession$PlayerSessionId' => '

Unique identifier for a player session.

', ], ], 'PlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionsOutput$PlayerSessions' => '

Collection of player session objects created for the added players.

', 'DescribePlayerSessionsOutput$PlayerSessions' => '

Collection of objects containing properties for each player session that matches the request.

', ], ], 'PlayerSessionStatus' => [ 'base' => NULL, 'refs' => [ 'PlayerSession$Status' => '

Current status of the player session.

Possible player session statuses include the following:

', ], ], 'PolicyType' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$PolicyType' => '

Type of scaling policy to create. For a target-based policy, set the parameter MetricName to \'PercentAvailableGameSessions\' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

', 'ScalingPolicy$PolicyType' => '

Type of scaling policy to create. For a target-based policy, set the parameter MetricName to \'PercentAvailableGameSessions\' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

', ], ], 'PortNumber' => [ 'base' => NULL, 'refs' => [ 'GameSession$Port' => '

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'GameSessionPlacement$Port' => '

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

', 'IpPermission$FromPort' => '

Starting value for a range of allowed port numbers.

', 'IpPermission$ToPort' => '

Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

', 'PlayerSession$Port' => '

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetAttributesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetCapacityInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetEventsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeFleetUtilizationInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeGameSessionDetailsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeGameSessionQueuesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeGameSessionsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeInstancesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeMatchmakingConfigurationsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10.

', 'DescribePlayerSessionsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

', 'DescribeScalingPoliciesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'GameSessionConnectionInfo$Port' => '

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'LatencyMap$value' => NULL, 'ListAliasesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'ListBuildsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'ListFleetsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'PutScalingPolicyInput$EvaluationPeriods' => '

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

', 'ScalingPolicy$EvaluationPeriods' => '

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

', 'SearchGameSessionsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

', 'ServerProcess$ConcurrentExecutions' => '

Number of server processes using this configuration to run concurrently on an instance.

', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'Build$SizeOnDisk' => '

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

', ], ], 'ProtectionPolicy' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$NewGameSessionProtectionPolicy' => '

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet\'s protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

', 'FleetAttributes$NewGameSessionProtectionPolicy' => '

Type of game session protection to set for all new instances started in the fleet.

', 'GameSessionDetail$ProtectionPolicy' => '

Current status of protection for the game session.

', 'UpdateFleetAttributesInput$NewGameSessionProtectionPolicy' => '

Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

', 'UpdateGameSessionInput$ProtectionPolicy' => '

Game session protection policy to apply to this game session only.

', ], ], 'PutScalingPolicyInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'PutScalingPolicyOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'QueueArnsList' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$GameSessionQueueArns' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

', 'MatchmakingConfiguration$GameSessionQueueArns' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

', 'UpdateMatchmakingConfigurationInput$GameSessionQueueArns' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

', ], ], 'RequestUploadCredentialsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'RequestUploadCredentialsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ResolveAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ResolveAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ResourceCreationLimitPolicy' => [ 'base' => '

Policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example, with a policy of 10 new game sessions and a time period of 60 minutes, on receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

', 'refs' => [ 'CreateFleetInput$ResourceCreationLimitPolicy' => '

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

', 'FleetAttributes$ResourceCreationLimitPolicy' => '

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

', 'UpdateFleetAttributesInput$ResourceCreationLimitPolicy' => '

Policy that limits the number of game sessions an individual player can create over a span of time.

', ], ], 'RoutingStrategy' => [ 'base' => '

Routing configuration for a fleet alias.

', 'refs' => [ 'Alias$RoutingStrategy' => '

Alias configuration for the alias, including routing type and settings.

', 'CreateAliasInput$RoutingStrategy' => '

Object that specifies the fleet and routing type to use for the alias.

', 'UpdateAliasInput$RoutingStrategy' => '

Object that specifies the fleet and routing type to use for the alias.

', ], ], 'RoutingStrategyType' => [ 'base' => NULL, 'refs' => [ 'ListAliasesInput$RoutingStrategyType' => '

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

', 'RoutingStrategy$Type' => '

Type of routing strategy.

Possible routing types include the following:

', ], ], 'RuleSetBody' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingRuleSetInput$RuleSetBody' => '

Collection of matchmaking rules, formatted as a JSON string. Note that comments are not allowed in JSON, but most elements support a description field.

', 'MatchmakingRuleSet$RuleSetBody' => '

Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)

', 'ValidateMatchmakingRuleSetInput$RuleSetBody' => '

Collection of matchmaking rules to validate, formatted as a JSON string.

', ], ], 'RuleSetLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingRuleSetsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', ], ], 'RuntimeConfiguration' => [ 'base' => '

A collection of server process configurations that describe what processes to run on each instance in a fleet. All fleets must have a run-time configuration. Each instance in the fleet launches the server processes specified in the run-time configuration and launches new ones as existing processes end. Each instance regularly checks for an updated run-time configuration and follows the new instructions.

The run-time configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different build executables, such as your game server executable and a related program, or two or more different versions of a game server. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.

A Amazon GameLift instance is limited to 50 processes running simultaneously. A run-time configuration must specify fewer than this limit. To calculate the total number of processes specified in a run-time configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the run-time configuration.

', 'refs' => [ 'CreateFleetInput$RuntimeConfiguration' => '

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

', 'DescribeRuntimeConfigurationOutput$RuntimeConfiguration' => '

Instructions describing how server processes should be launched and maintained on each instance in the fleet.

', 'UpdateRuntimeConfigurationInput$RuntimeConfiguration' => '

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.

', 'UpdateRuntimeConfigurationOutput$RuntimeConfiguration' => '

The run-time configuration currently in force. If the update was successful, this object matches the one in the request.

', ], ], 'S3Location' => [ 'base' => '

Location in Amazon Simple Storage Service (Amazon S3) where build files can be stored for access by Amazon GameLift. This location is specified in a CreateBuild request. For more details, see the Create a Build with Files in Amazon S3.

', 'refs' => [ 'CreateBuildInput$StorageLocation' => '

Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key, as well as a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in.

', 'CreateBuildOutput$StorageLocation' => '

Amazon S3 location for your game build file, including bucket name and key.

', 'RequestUploadCredentialsOutput$StorageLocation' => '

Amazon S3 path and key, identifying where the game build files are stored.

', ], ], 'ScalingAdjustmentType' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$ScalingAdjustmentType' => '

Type of adjustment to make to a fleet\'s instance count (see FleetCapacity):

', 'ScalingPolicy$ScalingAdjustmentType' => '

Type of adjustment to make to a fleet\'s instance count (see FleetCapacity):

', ], ], 'ScalingPolicy' => [ 'base' => '

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

', 'refs' => [ 'ScalingPolicyList$member' => NULL, ], ], 'ScalingPolicyList' => [ 'base' => NULL, 'refs' => [ 'DescribeScalingPoliciesOutput$ScalingPolicies' => '

Collection of objects containing the scaling policies matching the request.

', ], ], 'ScalingStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribeScalingPoliciesInput$StatusFilter' => '

Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

', 'ScalingPolicy$Status' => '

Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet\'s stopped actions by calling DescribeFleetCapacity.

', ], ], 'SearchGameSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'SearchGameSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ServerProcess' => [ 'base' => '

A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet\'s RuntimeConfiguration .

', 'refs' => [ 'ServerProcessList$member' => NULL, ], ], 'ServerProcessList' => [ 'base' => NULL, 'refs' => [ 'RuntimeConfiguration$ServerProcesses' => '

Collection of server process configurations that describe which server processes to run on each instance in a fleet.

', ], ], 'SnsArnStringModel' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$NotificationTarget' => '

SNS topic ARN that is set up to receive matchmaking notifications.

', 'MatchmakingConfiguration$NotificationTarget' => '

SNS topic ARN that is set up to receive matchmaking notifications.

', 'UpdateMatchmakingConfigurationInput$NotificationTarget' => '

SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

', ], ], 'StartFleetActionsInput' => [ 'base' => NULL, 'refs' => [], ], 'StartFleetActionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'StartGameSessionPlacementInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StartGameSessionPlacementOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StartMatchBackfillInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StartMatchBackfillOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StartMatchmakingInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StartMatchmakingOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StopFleetActionsInput' => [ 'base' => NULL, 'refs' => [], ], 'StopFleetActionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'StopGameSessionPlacementInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StopGameSessionPlacementOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StopMatchmakingInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StopMatchmakingOutput' => [ 'base' => NULL, 'refs' => [], ], 'StringDoubleMap' => [ 'base' => NULL, 'refs' => [ 'AttributeValue$SDM' => '

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AcceptMatchInput$PlayerIds' => '

Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

', 'AttributeValue$SL' => '

For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

', 'CreateFleetInput$LogPaths' => '

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

', 'FleetAttributes$LogPaths' => '

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\\game\\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

', ], ], 'StringModel' => [ 'base' => NULL, 'refs' => [ 'GameSessionConnectionInfo$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'MatchmakingTicket$StatusReason' => '

Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

', 'MatchmakingTicket$StatusMessage' => '

Additional information about the current status.

', ], ], 'TargetConfiguration' => [ 'base' => '

Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

', 'refs' => [ 'PutScalingPolicyInput$TargetConfiguration' => '

Object that contains settings for a target-based scaling policy.

', 'ScalingPolicy$TargetConfiguration' => '

Object that contains settings for a target-based scaling policy.

', ], ], 'TerminalRoutingStrategyException' => [ 'base' => '

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Alias$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'Alias$LastUpdatedTime' => '

Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'Build$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'DescribeFleetEventsInput$StartTime' => '

Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

', 'DescribeFleetEventsInput$EndTime' => '

Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

', 'Event$EventTime' => '

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'FleetAttributes$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'FleetAttributes$TerminationTime' => '

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSession$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSession$TerminationTime' => '

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSessionPlacement$StartTime' => '

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSessionPlacement$EndTime' => '

Time stamp indicating when this request was completed, canceled, or timed out.

', 'Instance$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingConfiguration$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingRuleSet$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingTicket$StartTime' => '

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingTicket$EndTime' => '

Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'PlayerSession$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'PlayerSession$TerminationTime' => '

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'VpcPeeringAuthorization$CreationTime' => '

Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'VpcPeeringAuthorization$ExpirationTime' => '

Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', ], ], 'UnauthorizedException' => [ 'base' => '

The client failed authentication. Clients should not retry such requests.

', 'refs' => [], ], 'UnsupportedRegionException' => [ 'base' => '

The requested operation is not supported in the region specified.

', 'refs' => [], ], 'UpdateAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateBuildOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateFleetAttributesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateFleetAttributesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateFleetCapacityInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateFleetCapacityOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateFleetPortSettingsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateFleetPortSettingsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateGameSessionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateGameSessionOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateGameSessionQueueInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateGameSessionQueueOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateMatchmakingConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateMatchmakingConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateRuntimeConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateRuntimeConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ValidateMatchmakingRuleSetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ValidateMatchmakingRuleSetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'VpcPeeringAuthorization' => [ 'base' => '

Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.

', 'refs' => [ 'CreateVpcPeeringAuthorizationOutput$VpcPeeringAuthorization' => '

Details on the requested VPC peering authorization, including expiration.

', 'VpcPeeringAuthorizationList$member' => NULL, ], ], 'VpcPeeringAuthorizationList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcPeeringAuthorizationsOutput$VpcPeeringAuthorizations' => '

Collection of objects that describe all valid VPC peering operations for the current AWS account.

', ], ], 'VpcPeeringConnection' => [ 'base' => '

Represents a peering connection between a VPC on one of your AWS accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.

', 'refs' => [ 'VpcPeeringConnectionList$member' => NULL, ], ], 'VpcPeeringConnectionList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcPeeringConnectionsOutput$VpcPeeringConnections' => '

Collection of VPC peering connection records that match the request.

', ], ], 'VpcPeeringConnectionStatus' => [ 'base' => '

Represents status information for a VPC peering connection. Status is associated with a VpcPeeringConnection object. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet Event.

', 'refs' => [ 'VpcPeeringConnection$Status' => '

Object that contains status information about the connection. Status indicates if a connection is pending, successful, or failed.

', ], ], 'WholeNumber' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'CreateGameSessionQueueInput$TimeoutInSeconds' => '

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

', 'CreateMatchmakingConfigurationInput$AdditionalPlayerCount' => '

Number of player slots in a match to keep open for future players. For example, if the configuration\'s rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

', 'EC2InstanceCounts$DESIRED' => '

Ideal number of active instances in the fleet.

', 'EC2InstanceCounts$MINIMUM' => '

Minimum value allowed for the fleet\'s instance count.

', 'EC2InstanceCounts$MAXIMUM' => '

Maximum value allowed for the fleet\'s instance count.

', 'EC2InstanceCounts$PENDING' => '

Number of instances in the fleet that are starting but not yet active.

', 'EC2InstanceCounts$ACTIVE' => '

Actual number of active instances in the fleet.

', 'EC2InstanceCounts$IDLE' => '

Number of active instances in the fleet that are not currently hosting a game session.

', 'EC2InstanceCounts$TERMINATING' => '

Number of instances in the fleet that are no longer active but haven\'t yet been terminated.

', 'EC2InstanceLimit$CurrentInstances' => '

Number of instances of the specified type that are currently in use by this AWS account.

', 'EC2InstanceLimit$InstanceLimit' => '

Number of instances allowed.

', 'FleetUtilization$ActiveServerProcessCount' => '

Number of server processes in an ACTIVE status currently running across all instances in the fleet

', 'FleetUtilization$ActiveGameSessionCount' => '

Number of active game sessions currently being hosted on all instances in the fleet.

', 'FleetUtilization$CurrentPlayerSessionCount' => '

Number of active player sessions currently being hosted on all instances in the fleet.

', 'FleetUtilization$MaximumPlayerSessionCount' => '

Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.

', 'GameSession$CurrentPlayerSessionCount' => '

Number of players currently in the game session.

', 'GameSession$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'GameSessionPlacement$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'GameSessionQueue$TimeoutInSeconds' => '

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

', 'MatchmakingConfiguration$AdditionalPlayerCount' => '

Number of player slots in a match to keep open for future players. For example, if the configuration\'s rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

', 'MatchmakingTicket$EstimatedWaitTime' => '

Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

', 'PlayerLatencyPolicy$MaximumIndividualPlayerLatencyMilliseconds' => '

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

', 'PlayerLatencyPolicy$PolicyDurationSeconds' => '

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

', 'ResourceCreationLimitPolicy$NewGameSessionsPerCreator' => '

Maximum number of game sessions that an individual can create during the policy period.

', 'ResourceCreationLimitPolicy$PolicyPeriodInMinutes' => '

Time span used in evaluating the resource creation limit policy.

', 'StartGameSessionPlacementInput$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'UpdateFleetCapacityInput$DesiredInstances' => '

Number of EC2 instances you want this fleet to host.

', 'UpdateFleetCapacityInput$MinSize' => '

Minimum value allowed for the fleet\'s instance count. Default if not set is 0.

', 'UpdateFleetCapacityInput$MaxSize' => '

Maximum value allowed for the fleet\'s instance count. Default if not set is 1.

', 'UpdateGameSessionInput$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'UpdateGameSessionQueueInput$TimeoutInSeconds' => '

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

', 'UpdateMatchmakingConfigurationInput$AdditionalPlayerCount' => '

Number of player slots in a match to keep open for future players. For example, if the configuration\'s rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon GameLift Service

Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage.

The Amazon GameLift service API includes two important function sets:

This reference guide describes the low-level service API for Amazon GameLift. You can use the API functionality with these tools:

Learn more

API SUMMARY

This list offers a functional overview of the Amazon GameLift service API.

Managing Games and Players

Use these actions to start new game sessions, find existing game sessions, track game session status and other information, and enable player access to game sessions.

Setting Up and Managing Game Servers

When setting up Amazon GameLift resources for your game, you first create a game build and upload it to Amazon GameLift. You can then use these actions to configure and manage a fleet of resources to run your game servers, scale capacity to meet player demand, access performance and utilization metrics, and more.

', 'operations' => [ 'AcceptMatch' => '

Registers a player\'s acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.

', 'CreateAlias' => '

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias.

', 'CreateBuild' => '

Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.

Game server binaries must be combined into a .zip file for use with Amazon GameLift.

To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions.

The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:

If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

Related operations

', 'CreateFleet' => '

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You set up a fleet to use instances with certain hardware specifications (see Amazon EC2 Instance Types), and deploy your game build to the fleet.

To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type, (3) the build ID for your game build, and (4) a run-time configuration, which specifies the server processes to run on each instance in the fleet. If fleet type is not set, the new fleet will use on-demand instances by default.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

Learn more

Working with Fleets.

Related operations

', 'CreateGameSession' => '

Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified.

Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.

Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.

Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session\'s player session creation policy.

Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

', 'CreateGameSessionQueue' => '

Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.

Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue\'s default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.

Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy\'s maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.

To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.

', 'CreateMatchmakingConfiguration' => '

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used.

To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.

Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept.

Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking). Since notifications promise only "best effort" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds.

', 'CreateMatchmakingRuleSet' => '

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same region as the matchmaking configuration they will be used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

Related operations

', 'CreatePlayerSession' => '

Adds a player to a game session and creates a player session record. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions.

To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new PlayerSession object is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

', 'CreatePlayerSessions' => '

Adds a group of players to a game session. This action is useful with a team matching feature. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession.

To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, the players are added to the game session and a set of new PlayerSession objects is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

', 'CreateVpcPeeringAuthorization' => '

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you\'ve received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions.

To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.

', 'CreateVpcPeeringConnection' => '

Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request\'s status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents.

', 'DeleteAlias' => '

Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

', 'DeleteBuild' => '

Deletes a build. This action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

Learn more

Working with Builds

Related operations

', 'DeleteFleet' => '

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet\'s desired capacity to zero. See UpdateFleetCapacity.

This action removes the fleet\'s resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

Learn more

Working with Fleets.

Related operations

', 'DeleteGameSessionQueue' => '

Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.

', 'DeleteMatchmakingConfiguration' => '

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

', 'DeleteMatchmakingRuleSet' => '

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

Related operations

', 'DeleteScalingPolicy' => '

Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet.

', 'DeleteVpcPeeringAuthorization' => '

Cancels a pending VPC peering authorization for the specified VPC. If the authorization has already been used to create a peering connection, call DeleteVpcPeeringConnection to remove the connection.

', 'DeleteVpcPeeringConnection' => '

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.

Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

', 'DescribeAlias' => '

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias\'s target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

', 'DescribeBuild' => '

Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned.

Learn more

Working with Builds

Related operations

', 'DescribeEC2InstanceLimits' => '

Retrieves the following information for the specified EC2 instance type:

Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).

Learn more

Working with Fleets.

Related operations

', 'DescribeFleetAttributes' => '

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

', 'DescribeFleetCapacity' => '

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

', 'DescribeFleetEvents' => '

Retrieves entries from the specified fleet\'s event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Learn more

Working with Fleets.

Related operations

', 'DescribeFleetPortSettings' => '

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet\'s inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Learn more

Working with Fleets.

Related operations

', 'DescribeFleetUtilization' => '

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

', 'DescribeGameSessionDetails' => '

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

', 'DescribeGameSessionPlacement' => '

Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.

', 'DescribeGameSessionQueues' => '

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region.

', 'DescribeGameSessions' => '

Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.

To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.

Available in Amazon GameLift Local.

', 'DescribeInstances' => '

Retrieves information about a fleet\'s instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

', 'DescribeMatchmaking' => '

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.

You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking.

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

', 'DescribeMatchmakingConfigurations' => '

Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

', 'DescribeMatchmakingRuleSets' => '

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

Related operations

', 'DescribePlayerSessions' => '

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

Available in Amazon GameLift Local.

', 'DescribeRuntimeConfiguration' => '

Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.

Learn more

Working with Fleets.

Related operations

', 'DescribeScalingPolicies' => '

Retrieves all scaling policies applied to a fleet.

To get a fleet\'s scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended (StopFleetActions). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet\'s scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.

', 'DescribeVpcPeeringAuthorizations' => '

Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

', 'DescribeVpcPeeringConnections' => '

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

', 'GetGameSessionLogUrl' => '

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

 ', 'GetInstanceAccess' => '

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.

Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you\'re making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet\'s instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned containing the instance\'s IP address and a set of credentials.

', 'ListAliases' => '

Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Returned aliases are not listed in any particular order.

 ', 'ListBuilds' => '

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

Learn more

Working with Builds

Related operations

', 'ListFleets' => '

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in any particular order.

Learn more

Working with Fleets.

Related operations

', 'PutScalingPolicy' => '

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet\'s hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet\'s capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet\'s hosting capacity is ready to host game sessions but is not currently in use. This is the fleet\'s buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet\'s available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it\'s successfully created. If the fleet\'s auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."

A policy\'s rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they\'re successfully created. If the fleet\'s auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

', 'RequestUploadCredentials' => '

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift\'s Amazon S3. This is done as part of the build creation process; see CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more

Uploading Your Game

Related operations

', 'ResolveAlias' => '

Retrieves the fleet ID that a specified alias is currently pointing to.

', 'SearchGameSessions' => '

Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes:

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages.

You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails.

', 'StartFleetActions' => '

Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet\'s auto-scaling activity.

To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet\'s scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet\'s stopped actions using DescribeFleetAttributes.

Learn more

Working with Fleets.

Related operations

', 'StartGameSessionPlacement' => '

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue\'s destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue\'s destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region\'s average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement and check the request\'s status. If the status is FULFILLED, a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

', 'StartMatchBackfill' => '

Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.

To request a match backfill, specify a unique ticket ID, the existing game session\'s ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker\'s ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch.

The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session\'s connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works.

', 'StartMatchmaking' => '

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration. For complete information on setting up and using FlexMatch, see the topic Adding FlexMatch to Your Game.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED. Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches.

Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests:

Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows:

  1. Your client code submits a StartMatchmaking request for one or more players and tracks the status of the request ticket.

  2. FlexMatch uses this ticket and others in process to build an acceptable match. When a potential match is identified, all tickets in the proposed match are advanced to the next status.

  3. If the match requires player acceptance (set in the matchmaking configuration), the tickets move into status REQUIRES_ACCEPTANCE. This status triggers your client code to solicit acceptance from all players in every ticket involved in the match, and then call AcceptMatch for each player. If any player rejects or fails to accept the match before a specified timeout, the proposed match is dropped (see AcceptMatch for more details).

  4. Once a match is proposed and accepted, the matchmaking tickets move into status PLACING. FlexMatch locates resources for a new game session using the game session queue (set in the matchmaking configuration) and creates the game session based on the match data.

  5. When the match is successfully placed, the matchmaking tickets move into COMPLETED status. Connection information (including game session endpoint and player session) is added to the matchmaking tickets. Matched players can use the connection information to join the game.

', 'StopFleetActions' => '

Suspends activity on a fleet. Currently, this operation is used to stop a fleet\'s auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet\'s scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet\'s stopped actions using DescribeFleetAttributes.

To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet\'s desired instances setting (FleetCapacity. Changes to the fleet\'s capacity must be done manually using UpdateFleetCapacity.

Learn more

Working with Fleets.

Related operations

', 'StopGameSessionPlacement' => '

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

', 'StopMatchmaking' => '

Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

', 'UpdateAlias' => '

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

', 'UpdateBuild' => '

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Learn more

Working with Builds

Related operations

', 'UpdateFleetAttributes' => '

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

Learn more

Working with Fleets.

Related operations

', 'UpdateFleetCapacity' => '

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet\'s EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet\'s active instance count matches the desired instance count. You can view a fleet\'s current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type\'s limit, the "Limit Exceeded" exception occurs.

Learn more

Working with Fleets.

Related operations

', 'UpdateFleetPortSettings' => '

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

Learn more

Working with Fleets.

Related operations

', 'UpdateGameSession' => '

Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.

', 'UpdateGameSessionQueue' => '

Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

', 'UpdateMatchmakingConfiguration' => '

Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings.

', 'UpdateRuntimeConfiguration' => '

Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet\'s run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift\'s normal process recycling activity.

Learn more

Working with Fleets.

Related operations

', 'ValidateMatchmakingRuleSet' => '

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.

Learn more

Related operations

', ], 'shapes' => [ 'AcceptMatchInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'AcceptMatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'AcceptanceType' => [ 'base' => NULL, 'refs' => [ 'AcceptMatchInput$AcceptanceType' => '

Player response to the proposed match.

', ], ], 'Alias' => [ 'base' => '

Properties describing a fleet alias.

', 'refs' => [ 'AliasList$member' => NULL, 'CreateAliasOutput$Alias' => '

Object that describes the newly created alias record.

', 'DescribeAliasOutput$Alias' => '

Object that contains the requested alias.

', 'UpdateAliasOutput$Alias' => '

Object that contains the updated alias configuration.

', ], ], 'AliasId' => [ 'base' => NULL, 'refs' => [ 'Alias$AliasId' => '

Unique identifier for an alias; alias IDs are unique within a region.

', 'CreateGameSessionInput$AliasId' => '

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

', 'DeleteAliasInput$AliasId' => '

Unique identifier for a fleet alias. Specify the alias you want to delete.

', 'DescribeAliasInput$AliasId' => '

Unique identifier for a fleet alias. Specify the alias you want to retrieve.

', 'DescribeGameSessionDetailsInput$AliasId' => '

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

', 'DescribeGameSessionsInput$AliasId' => '

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

', 'ResolveAliasInput$AliasId' => '

Unique identifier for the alias you want to resolve.

', 'SearchGameSessionsInput$AliasId' => '

Unique identifier for an alias associated with the fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

', 'UpdateAliasInput$AliasId' => '

Unique identifier for a fleet alias. Specify the alias you want to update.

', ], ], 'AliasList' => [ 'base' => NULL, 'refs' => [ 'ListAliasesOutput$Aliases' => '

Collection of alias records that match the list request.

', ], ], 'ArnStringModel' => [ 'base' => NULL, 'refs' => [ 'Alias$AliasArn' => '

Unique identifier for an alias; alias ARNs are unique across all regions.

', 'CreatePlayerSessionInput$GameSessionId' => '

Unique identifier for the game session to add a player to.

', 'CreatePlayerSessionsInput$GameSessionId' => '

Unique identifier for the game session to add players to.

', 'DescribeGameSessionDetailsInput$GameSessionId' => '

Unique identifier for the game session to retrieve.

', 'DescribeGameSessionsInput$GameSessionId' => '

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

', 'DescribePlayerSessionsInput$GameSessionId' => '

Unique identifier for the game session to retrieve player sessions for.

', 'FleetAttributes$FleetArn' => '

Identifier for a fleet that is unique across all regions.

', 'GameSessionConnectionInfo$GameSessionArn' => '

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

', 'GameSessionQueue$GameSessionQueueArn' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

', 'GameSessionQueueDestination$DestinationArn' => '

Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.

', 'GetGameSessionLogUrlInput$GameSessionId' => '

Unique identifier for the game session to get logs for.

', 'QueueArnsList$member' => NULL, 'StartMatchBackfillInput$GameSessionArn' => '

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

', 'UpdateGameSessionInput$GameSessionId' => '

Unique identifier for the game session to update.

', ], ], 'AttributeValue' => [ 'base' => '

Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.

', 'refs' => [ 'PlayerAttributeMap$value' => NULL, ], ], 'AwsCredentials' => [ 'base' => '

Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.

', 'refs' => [ 'CreateBuildOutput$UploadCredentials' => '

This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.

', 'RequestUploadCredentialsOutput$UploadCredentials' => '

AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

', ], ], 'BooleanModel' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$AcceptanceRequired' => '

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

', 'MatchmakingConfiguration$AcceptanceRequired' => '

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

', 'UpdateMatchmakingConfigurationInput$AcceptanceRequired' => '

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

', 'ValidateMatchmakingRuleSetOutput$Valid' => '

Response indicating whether or not the rule set is valid.

', ], ], 'Build' => [ 'base' => '

Properties describing a game build.

', 'refs' => [ 'BuildList$member' => NULL, 'CreateBuildOutput$Build' => '

The newly created build record, including a unique build ID and status.

', 'DescribeBuildOutput$Build' => '

Set of properties describing the requested build.

', 'UpdateBuildOutput$Build' => '

Object that contains the updated build record.

', ], ], 'BuildId' => [ 'base' => NULL, 'refs' => [ 'Build$BuildId' => '

Unique identifier for a build.

', 'CreateFleetInput$BuildId' => '

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

', 'DeleteBuildInput$BuildId' => '

Unique identifier for a build to delete.

', 'DescribeBuildInput$BuildId' => '

Unique identifier for a build to retrieve properties for.

', 'FleetAttributes$BuildId' => '

Unique identifier for a build.

', 'ListFleetsInput$BuildId' => '

Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

', 'RequestUploadCredentialsInput$BuildId' => '

Unique identifier for a build to get credentials for.

', 'UpdateBuildInput$BuildId' => '

Unique identifier for a build to update.

', ], ], 'BuildList' => [ 'base' => NULL, 'refs' => [ 'ListBuildsOutput$Builds' => '

Collection of build records that match the request.

', ], ], 'BuildStatus' => [ 'base' => NULL, 'refs' => [ 'Build$Status' => '

Current status of the build.

Possible build statuses include the following:

', 'ListBuildsInput$Status' => '

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

', ], ], 'ComparisonOperatorType' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$ComparisonOperator' => '

Comparison operator to use when measuring the metric against the threshold value.

', 'ScalingPolicy$ComparisonOperator' => '

Comparison operator to use when measuring a metric against the threshold value.

', ], ], 'ConflictException' => [ 'base' => '

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

', 'refs' => [], ], 'CreateAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateBuildOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateFleetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateFleetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateGameSessionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateGameSessionOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateGameSessionQueueInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateGameSessionQueueOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateMatchmakingConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateMatchmakingConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateMatchmakingRuleSetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateMatchmakingRuleSetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreatePlayerSessionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreatePlayerSessionOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreatePlayerSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreatePlayerSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateVpcPeeringAuthorizationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateVpcPeeringAuthorizationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'CreateVpcPeeringConnectionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'CreateVpcPeeringConnectionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CustomEventData' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$CustomEventData' => '

Information to attached to all events related to the matchmaking configuration.

', 'MatchmakingConfiguration$CustomEventData' => '

Information to attached to all events related to the matchmaking configuration.

', 'UpdateMatchmakingConfigurationInput$CustomEventData' => '

Information to attached to all events related to the matchmaking configuration.

', ], ], 'DeleteAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteFleetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteGameSessionQueueInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteGameSessionQueueOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMatchmakingConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteMatchmakingConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMatchmakingRuleSetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteMatchmakingRuleSetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DeleteScalingPolicyInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteVpcPeeringAuthorizationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteVpcPeeringAuthorizationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVpcPeeringConnectionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DeleteVpcPeeringConnectionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeBuildOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeEC2InstanceLimitsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeEC2InstanceLimitsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetAttributesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetAttributesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetCapacityInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetCapacityOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetEventsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetEventsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetPortSettingsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetPortSettingsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeFleetUtilizationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeFleetUtilizationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionDetailsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionDetailsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionPlacementInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionPlacementOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionQueuesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionQueuesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeGameSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeGameSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeInstancesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeInstancesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeMatchmakingConfigurationsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeMatchmakingConfigurationsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeMatchmakingInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeMatchmakingOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeMatchmakingRuleSetsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeMatchmakingRuleSetsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribePlayerSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribePlayerSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeRuntimeConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeRuntimeConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeScalingPoliciesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeScalingPoliciesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DescribeVpcPeeringAuthorizationsInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcPeeringAuthorizationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcPeeringConnectionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'DescribeVpcPeeringConnectionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'DesiredPlayerSession' => [ 'base' => '

Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement.

', 'refs' => [ 'DesiredPlayerSessionList$member' => NULL, ], ], 'DesiredPlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'StartGameSessionPlacementInput$DesiredPlayerSessions' => '

Set of information on each player to create a player session for.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$Threshold' => '

Metric value used to trigger a scaling event.

', 'ScalingPolicy$Threshold' => '

Metric value used to trigger a scaling event.

', 'TargetConfiguration$TargetValue' => '

Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet\'s buffer (the percent of capacity that should be idle and ready for new game sessions).

', ], ], 'DoubleObject' => [ 'base' => NULL, 'refs' => [ 'AttributeValue$N' => '

For number values, expressed as double.

', 'StringDoubleMap$value' => NULL, ], ], 'EC2InstanceCounts' => [ 'base' => '

Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.

', 'refs' => [ 'FleetCapacity$InstanceCounts' => '

Current status of fleet capacity.

', ], ], 'EC2InstanceLimit' => [ 'base' => '

Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.

', 'refs' => [ 'EC2InstanceLimitList$member' => NULL, ], ], 'EC2InstanceLimitList' => [ 'base' => NULL, 'refs' => [ 'DescribeEC2InstanceLimitsOutput$EC2InstanceLimits' => '

Object that contains the maximum number of instances for the specified instance type.

', ], ], 'EC2InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$EC2InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

', 'DescribeEC2InstanceLimitsInput$EC2InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.

', 'EC2InstanceLimit$EC2InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

', 'FleetAttributes$InstanceType' => '

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

', 'FleetCapacity$InstanceType' => '

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

', 'Instance$Type' => '

EC2 instance type that defines the computing resources of this instance.

', ], ], 'Event' => [ 'base' => '

Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCode' => [ 'base' => NULL, 'refs' => [ 'Event$EventCode' => '

Type of event being logged. The following events are currently in use:

Fleet creation events:

VPC peering events:

Spot instance events:

Other fleet events:

', ], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetEventsOutput$Events' => '

Collection of objects containing event log entries for the specified fleet.

', ], ], 'FleetAction' => [ 'base' => NULL, 'refs' => [ 'FleetActionList$member' => NULL, ], ], 'FleetActionList' => [ 'base' => NULL, 'refs' => [ 'FleetAttributes$StoppedActions' => '

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

', 'StartFleetActionsInput$Actions' => '

List of actions to restart on the fleet.

', 'StopFleetActionsInput$Actions' => '

List of actions to suspend on the fleet.

', ], ], 'FleetAttributes' => [ 'base' => '

General properties describing a fleet.

', 'refs' => [ 'CreateFleetOutput$FleetAttributes' => '

Properties for the newly created fleet.

', 'FleetAttributesList$member' => NULL, ], ], 'FleetAttributesList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetAttributesOutput$FleetAttributes' => '

Collection of objects containing attribute metadata for each requested fleet ID.

', ], ], 'FleetCapacity' => [ 'base' => '

Information about the fleet\'s capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet\'s instance type.

', 'refs' => [ 'FleetCapacityList$member' => NULL, ], ], 'FleetCapacityExceededException' => [ 'base' => '

The specified fleet has no available instances to fulfill a CreateGameSession request. Clients can retry such requests immediately or after a waiting period.

', 'refs' => [], ], 'FleetCapacityList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetCapacityOutput$FleetCapacity' => '

Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.

', ], ], 'FleetId' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$FleetId' => '

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

', 'CreateVpcPeeringConnectionInput$FleetId' => '

Unique identifier for a fleet. This tells Amazon GameLift which GameLift VPC to peer with.

', 'DeleteFleetInput$FleetId' => '

Unique identifier for a fleet to be deleted.

', 'DeleteScalingPolicyInput$FleetId' => '

Unique identifier for a fleet to be deleted.

', 'DeleteVpcPeeringConnectionInput$FleetId' => '

Unique identifier for a fleet. This value must match the fleet ID referenced in the VPC peering connection record.

', 'DescribeFleetEventsInput$FleetId' => '

Unique identifier for a fleet to get event logs for.

', 'DescribeFleetPortSettingsInput$FleetId' => '

Unique identifier for a fleet to retrieve port settings for.

', 'DescribeGameSessionDetailsInput$FleetId' => '

Unique identifier for a fleet to retrieve all game sessions active on the fleet.

', 'DescribeGameSessionsInput$FleetId' => '

Unique identifier for a fleet to retrieve all game sessions for.

', 'DescribeInstancesInput$FleetId' => '

Unique identifier for a fleet to retrieve instance information for.

', 'DescribeRuntimeConfigurationInput$FleetId' => '

Unique identifier for a fleet to get the run-time configuration for.

', 'DescribeScalingPoliciesInput$FleetId' => '

Unique identifier for a fleet to retrieve scaling policies for.

', 'DescribeVpcPeeringConnectionsInput$FleetId' => '

Unique identifier for a fleet.

', 'FleetAttributes$FleetId' => '

Unique identifier for a fleet.

', 'FleetCapacity$FleetId' => '

Unique identifier for a fleet.

', 'FleetIdList$member' => NULL, 'FleetUtilization$FleetId' => '

Unique identifier for a fleet.

', 'GameSession$FleetId' => '

Unique identifier for a fleet that the game session is running on.

', 'GetInstanceAccessInput$FleetId' => '

Unique identifier for a fleet that contains the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.

', 'Instance$FleetId' => '

Unique identifier for a fleet that the instance is in.

', 'InstanceAccess$FleetId' => '

Unique identifier for a fleet containing the instance being accessed.

', 'PlayerSession$FleetId' => '

Unique identifier for a fleet that the player\'s game session is running on.

', 'PutScalingPolicyInput$FleetId' => '

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

', 'ResolveAliasOutput$FleetId' => '

Fleet identifier that is associated with the requested alias.

', 'RoutingStrategy$FleetId' => '

Unique identifier for a fleet that the alias points to.

', 'ScalingPolicy$FleetId' => '

Unique identifier for a fleet that is associated with this scaling policy.

', 'SearchGameSessionsInput$FleetId' => '

Unique identifier for a fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

', 'StartFleetActionsInput$FleetId' => '

Unique identifier for a fleet

', 'StopFleetActionsInput$FleetId' => '

Unique identifier for a fleet

', 'UpdateFleetAttributesInput$FleetId' => '

Unique identifier for a fleet to update attribute metadata for.

', 'UpdateFleetAttributesOutput$FleetId' => '

Unique identifier for a fleet that was updated.

', 'UpdateFleetCapacityInput$FleetId' => '

Unique identifier for a fleet to update capacity for.

', 'UpdateFleetCapacityOutput$FleetId' => '

Unique identifier for a fleet that was updated.

', 'UpdateFleetPortSettingsInput$FleetId' => '

Unique identifier for a fleet to update port settings for.

', 'UpdateFleetPortSettingsOutput$FleetId' => '

Unique identifier for a fleet that was updated.

', 'UpdateRuntimeConfigurationInput$FleetId' => '

Unique identifier for a fleet to update run-time configuration for.

', 'VpcPeeringConnection$FleetId' => '

Unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

', ], ], 'FleetIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetAttributesInput$FleetIds' => '

Unique identifier for a fleet(s) to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.

', 'DescribeFleetCapacityInput$FleetIds' => '

Unique identifier for a fleet(s) to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

', 'DescribeFleetUtilizationInput$FleetIds' => '

Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.

', 'ListFleetsOutput$FleetIds' => '

Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization.

', ], ], 'FleetStatus' => [ 'base' => NULL, 'refs' => [ 'FleetAttributes$Status' => '

Current status of the fleet.

Possible fleet statuses include the following:

', ], ], 'FleetType' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$FleetType' => '

Indicates whether to use on-demand instances or spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations, based on the instance type selected for this fleet. You can acquire on-demand instances at any time for a fixed price and keep them as long as you need them. Spot instances have lower prices, but spot pricing is variable, and while in use they can be interrupted (with a two-minute notification). Learn more about Amazon GameLift spot instances with at Set up Access to External Services.

', 'FleetAttributes$FleetType' => '

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

', ], ], 'FleetUtilization' => [ 'base' => '

Current status of fleet utilization, including the number of game and player sessions being hosted.

', 'refs' => [ 'FleetUtilizationList$member' => NULL, ], ], 'FleetUtilizationList' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetUtilizationOutput$FleetUtilization' => '

Collection of objects containing utilization information for each requested fleet ID.

', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'PlayerLatency$LatencyInMilliseconds' => '

Amount of time that represents the time lag experienced by the player when connected to the specified region.

', ], ], 'FreeText' => [ 'base' => NULL, 'refs' => [ 'Alias$Description' => '

Human-readable description of an alias.

', 'Build$Name' => '

Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

', 'Build$Version' => '

Version that is associated with this build. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

', 'RoutingStrategy$Message' => '

Message text to be used with a terminal routing strategy.

', ], ], 'GameProperty' => [ 'base' => '

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide.

', 'refs' => [ 'GamePropertyList$member' => NULL, ], ], 'GamePropertyKey' => [ 'base' => NULL, 'refs' => [ 'GameProperty$Key' => '

Game property identifier.

', ], ], 'GamePropertyList' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'CreateMatchmakingConfigurationInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'GameSession$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions.

', 'GameSessionPlacement$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'MatchmakingConfiguration$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'StartGameSessionPlacementInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'UpdateMatchmakingConfigurationInput$GameProperties' => '

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', ], ], 'GamePropertyValue' => [ 'base' => NULL, 'refs' => [ 'GameProperty$Value' => '

Game property value.

', ], ], 'GameSession' => [ 'base' => '

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

', 'refs' => [ 'CreateGameSessionOutput$GameSession' => '

Object that describes the newly created game session record.

', 'GameSessionDetail$GameSession' => '

Object that describes a game session.

', 'GameSessionList$member' => NULL, 'UpdateGameSessionOutput$GameSession' => '

Object that contains the updated game session metadata.

', ], ], 'GameSessionActivationTimeoutSeconds' => [ 'base' => NULL, 'refs' => [ 'RuntimeConfiguration$GameSessionActivationTimeoutSeconds' => '

Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.

', ], ], 'GameSessionConnectionInfo' => [ 'base' => '

Connection information for the new game session that is created with matchmaking. (with StartMatchmaking). Once a match is set, the FlexMatch engine places the match and creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.

', 'refs' => [ 'MatchmakingTicket$GameSessionConnectionInfo' => '

Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.

', ], ], 'GameSessionData' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'CreateMatchmakingConfigurationInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'GameSession$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'GameSessionPlacement$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'MatchmakingConfiguration$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', 'StartGameSessionPlacementInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

', 'UpdateMatchmakingConfigurationInput$GameSessionData' => '

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

', ], ], 'GameSessionDetail' => [ 'base' => '

A game session\'s properties plus the protection policy currently in force.

', 'refs' => [ 'GameSessionDetailList$member' => NULL, ], ], 'GameSessionDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionDetailsOutput$GameSessionDetails' => '

Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.

', ], ], 'GameSessionFullException' => [ 'base' => '

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

', 'refs' => [], ], 'GameSessionList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionsOutput$GameSessions' => '

Collection of objects containing game session properties for each session matching the request.

', 'SearchGameSessionsOutput$GameSessions' => '

Collection of objects containing game session properties for each session matching the request.

', ], ], 'GameSessionPlacement' => [ 'base' => '

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

', 'refs' => [ 'DescribeGameSessionPlacementOutput$GameSessionPlacement' => '

Object that describes the requested game session placement.

', 'StartGameSessionPlacementOutput$GameSessionPlacement' => '

Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status.

', 'StopGameSessionPlacementOutput$GameSessionPlacement' => '

Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

', ], ], 'GameSessionPlacementState' => [ 'base' => NULL, 'refs' => [ 'GameSessionPlacement$Status' => '

Current status of the game session placement request.

', ], ], 'GameSessionQueue' => [ 'base' => '

Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:

', 'refs' => [ 'CreateGameSessionQueueOutput$GameSessionQueue' => '

Object that describes the newly created game session queue.

', 'GameSessionQueueList$member' => NULL, 'UpdateGameSessionQueueOutput$GameSessionQueue' => '

Object that describes the newly updated game session queue.

', ], ], 'GameSessionQueueDestination' => [ 'base' => '

Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.

', 'refs' => [ 'GameSessionQueueDestinationList$member' => NULL, ], ], 'GameSessionQueueDestinationList' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionQueueInput$Destinations' => '

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

', 'GameSessionQueue$Destinations' => '

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

', 'UpdateGameSessionQueueInput$Destinations' => '

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.

', ], ], 'GameSessionQueueList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionQueuesOutput$GameSessionQueues' => '

Collection of objects that describes the requested game session queues.

', ], ], 'GameSessionQueueName' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionQueueInput$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'DeleteGameSessionQueueInput$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'GameSessionPlacement$GameSessionQueueName' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'GameSessionQueue$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', 'GameSessionQueueNameList$member' => NULL, 'StartGameSessionPlacementInput$GameSessionQueueName' => '

Name of the queue to use to place the new game session.

', 'UpdateGameSessionQueueInput$Name' => '

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

', ], ], 'GameSessionQueueNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeGameSessionQueuesInput$Names' => '

List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty.

', ], ], 'GameSessionStatus' => [ 'base' => NULL, 'refs' => [ 'GameSession$Status' => '

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

', ], ], 'GameSessionStatusReason' => [ 'base' => NULL, 'refs' => [ 'GameSession$StatusReason' => '

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

', ], ], 'GetGameSessionLogUrlInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'GetGameSessionLogUrlOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'GetInstanceAccessInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'GetInstanceAccessOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'IdStringModel' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$GameSessionId' => '

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session\'s ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

', 'CreateGameSessionInput$IdempotencyToken' => '

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session\'s ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

', 'DescribeGameSessionPlacementInput$PlacementId' => '

Unique identifier for a game session placement to retrieve.

', 'GameSessionPlacement$PlacementId' => '

Unique identifier for a game session placement.

', 'StartGameSessionPlacementInput$PlacementId' => '

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

', 'StopGameSessionPlacementInput$PlacementId' => '

Unique identifier for a game session placement to cancel.

', ], ], 'IdempotentParameterMismatchException' => [ 'base' => '

A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.

', 'refs' => [], ], 'Instance' => [ 'base' => '

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.

', 'refs' => [ 'InstanceList$member' => NULL, ], ], 'InstanceAccess' => [ 'base' => '

Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.

', 'refs' => [ 'GetInstanceAccessOutput$InstanceAccess' => '

Object that contains connection information for a fleet instance, including IP address and access credentials.

', ], ], 'InstanceCredentials' => [ 'base' => '

Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.

', 'refs' => [ 'InstanceAccess$Credentials' => '

Credentials required to access the instance.

', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'DescribeInstancesInput$InstanceId' => '

Unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

', 'GetInstanceAccessInput$InstanceId' => '

Unique identifier for an instance you want to get access to. You can access an instance in any status.

', 'Instance$InstanceId' => '

Unique identifier for an instance.

', 'InstanceAccess$InstanceId' => '

Unique identifier for an instance being accessed.

', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeInstancesOutput$Instances' => '

Collection of objects containing properties for each instance returned.

', ], ], 'InstanceStatus' => [ 'base' => NULL, 'refs' => [ 'Instance$Status' => '

Current status of the instance. Possible statuses include the following:

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$ScalingAdjustment' => '

Amount of adjustment to make, based on the scaling adjustment type.

', 'ScalingPolicy$ScalingAdjustment' => '

Amount of adjustment to make, based on the scaling adjustment type.

', ], ], 'InternalServiceException' => [ 'base' => '

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

', 'refs' => [], ], 'InvalidFleetStatusException' => [ 'base' => '

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

', 'refs' => [], ], 'InvalidGameSessionStatusException' => [ 'base' => '

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

', 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'GameSession$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'GameSessionPlacement$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

', 'Instance$IpAddress' => '

IP address assigned to the instance.

', 'InstanceAccess$IpAddress' => '

IP address assigned to the instance.

', 'PlayerSession$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', ], ], 'IpPermission' => [ 'base' => '

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet\'s allowed ranges. This combination is included in the GameSession object.

', 'refs' => [ 'IpPermissionsList$member' => NULL, ], ], 'IpPermissionsList' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$EC2InboundPermissions' => '

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

', 'DescribeFleetPortSettingsOutput$InboundPermissions' => '

Object that contains port settings for the requested fleet ID.

', 'UpdateFleetPortSettingsInput$InboundPermissionAuthorizations' => '

Collection of port settings to be added to the fleet record.

', 'UpdateFleetPortSettingsInput$InboundPermissionRevocations' => '

Collection of port settings to be removed from the fleet record.

', ], ], 'IpProtocol' => [ 'base' => NULL, 'refs' => [ 'IpPermission$Protocol' => '

Network communication protocol used by the fleet.

', ], ], 'LatencyMap' => [ 'base' => NULL, 'refs' => [ 'Player$LatencyInMs' => '

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.

If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.

', ], ], 'LimitExceededException' => [ 'base' => '

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

', 'refs' => [], ], 'ListAliasesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ListAliasesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ListBuildsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ListBuildsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ListFleetsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ListFleetsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'MatchedPlayerSession' => [ 'base' => '

Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.

When players connect to the match\'s game session, they must include both player ID and player session ID in order to claim their assigned player slot.

', 'refs' => [ 'MatchedPlayerSessionList$member' => NULL, ], ], 'MatchedPlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'GameSessionConnectionInfo$MatchedPlayerSessions' => '

Collection of player session IDs, one for each player ID that was included in the original matchmaking request.

', ], ], 'MatchmakerData' => [ 'base' => NULL, 'refs' => [ 'GameSession$MatchmakerData' => '

Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

', 'GameSessionPlacement$MatchmakerData' => '

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

', ], ], 'MatchmakingAcceptanceTimeoutInteger' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$AcceptanceTimeoutSeconds' => '

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

', 'MatchmakingConfiguration$AcceptanceTimeoutSeconds' => '

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

', 'UpdateMatchmakingConfigurationInput$AcceptanceTimeoutSeconds' => '

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

', ], ], 'MatchmakingConfiguration' => [ 'base' => '

Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.

', 'refs' => [ 'CreateMatchmakingConfigurationOutput$Configuration' => '

Object that describes the newly created matchmaking configuration.

', 'MatchmakingConfigurationList$member' => NULL, 'UpdateMatchmakingConfigurationOutput$Configuration' => '

Object that describes the updated matchmaking configuration.

', ], ], 'MatchmakingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingConfigurationsOutput$Configurations' => '

Collection of requested matchmaking configuration objects.

', ], ], 'MatchmakingConfigurationStatus' => [ 'base' => NULL, 'refs' => [ 'MatchmakingTicket$Status' => '

Current status of the matchmaking request.

Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.

', ], ], 'MatchmakingIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingConfigurationsInput$Names' => '

Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty.

', 'DescribeMatchmakingInput$TicketIds' => '

Unique identifier for a matchmaking ticket. You can include up to 10 ID values.

', ], ], 'MatchmakingIdStringModel' => [ 'base' => NULL, 'refs' => [ 'AcceptMatchInput$TicketId' => '

Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

', 'CreateMatchmakingConfigurationInput$Name' => '

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

', 'CreateMatchmakingConfigurationInput$RuleSetName' => '

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

', 'CreateMatchmakingRuleSetInput$Name' => '

Unique identifier for a matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. (Note: The rule set name is different from the optional "name" field in the rule set body.)

', 'DeleteMatchmakingConfigurationInput$Name' => '

Unique identifier for a matchmaking configuration

', 'DeleteMatchmakingRuleSetInput$Name' => '

Unique identifier for a matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.)

', 'DescribeMatchmakingConfigurationsInput$RuleSetName' => '

Unique identifier for a matchmaking rule set. Use this parameter to retrieve all matchmaking configurations that use this rule set.

', 'MatchmakingConfiguration$Name' => '

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

', 'MatchmakingConfiguration$RuleSetName' => '

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

', 'MatchmakingIdList$member' => NULL, 'MatchmakingRuleSet$RuleSetName' => '

Unique identifier for a matchmaking rule set

', 'MatchmakingRuleSetNameList$member' => NULL, 'MatchmakingTicket$TicketId' => '

Unique identifier for a matchmaking ticket.

', 'MatchmakingTicket$ConfigurationName' => '

Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

', 'StartMatchBackfillInput$TicketId' => '

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

', 'StartMatchBackfillInput$ConfigurationName' => '

Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4", the matchmaking configuration name is "MM-4v4".) Use only the name for this parameter.

', 'StartMatchmakingInput$TicketId' => '

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

', 'StartMatchmakingInput$ConfigurationName' => '

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

', 'StopMatchmakingInput$TicketId' => '

Unique identifier for a matchmaking ticket.

', 'UpdateMatchmakingConfigurationInput$Name' => '

Unique identifier for a matchmaking configuration to update.

', 'UpdateMatchmakingConfigurationInput$RuleSetName' => '

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

', ], ], 'MatchmakingRequestTimeoutInteger' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$RequestTimeoutSeconds' => '

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

', 'MatchmakingConfiguration$RequestTimeoutSeconds' => '

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

', 'UpdateMatchmakingConfigurationInput$RequestTimeoutSeconds' => '

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

', ], ], 'MatchmakingRuleSet' => [ 'base' => '

Set of rule statements, used with FlexMatch, that determine how to build a certain kind of player match. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.

A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch Rule Set.

', 'refs' => [ 'CreateMatchmakingRuleSetOutput$RuleSet' => '

Object that describes the newly created matchmaking rule set.

', 'MatchmakingRuleSetList$member' => NULL, ], ], 'MatchmakingRuleSetList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingRuleSetsOutput$RuleSets' => '

Collection of requested matchmaking rule set objects.

', ], ], 'MatchmakingRuleSetNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingRuleSetsInput$Names' => '

List of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.)

', ], ], 'MatchmakingTicket' => [ 'base' => '

Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.

', 'refs' => [ 'MatchmakingTicketList$member' => NULL, 'StartMatchBackfillOutput$MatchmakingTicket' => '

Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

', 'StartMatchmakingOutput$MatchmakingTicket' => '

Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.

', ], ], 'MatchmakingTicketList' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingOutput$TicketList' => '

Collection of existing matchmaking ticket objects matching the request.

', ], ], 'MaxConcurrentGameSessionActivations' => [ 'base' => NULL, 'refs' => [ 'RuntimeConfiguration$MaxConcurrentGameSessionActivations' => '

Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.

', ], ], 'MetricGroup' => [ 'base' => NULL, 'refs' => [ 'MetricGroupList$member' => NULL, ], ], 'MetricGroupList' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$MetricGroups' => '

Name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.

', 'FleetAttributes$MetricGroups' => '

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

', 'UpdateFleetAttributesInput$MetricGroups' => '

Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$MetricName' => '

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

', 'ScalingPolicy$MetricName' => '

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

', ], ], 'NonBlankAndLengthConstraintString' => [ 'base' => NULL, 'refs' => [ 'Alias$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', 'CreateAliasInput$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', 'UpdateAliasInput$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', ], ], 'NonBlankString' => [ 'base' => NULL, 'refs' => [ 'IpPermission$IpRange' => '

Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AwsCredentials$AccessKeyId' => '

Temporary key allowing access to the Amazon GameLift S3 account.

', 'AwsCredentials$SecretAccessKey' => '

Temporary secret key allowing access to the Amazon GameLift S3 account.

', 'AwsCredentials$SessionToken' => '

Token used to associate a specific build ID with the files uploaded using these credentials.

', 'ConflictException$Message' => NULL, 'CreateFleetInput$InstanceRoleArn' => '

Unique identifier for an AWS IAM role that manages access to your AWS services. Any application that runs on an instance in this fleet can assume the role, including install scripts, server processs, daemons (background processes). Create a role or look up a role\'s ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

', 'Event$Message' => '

Additional information related to the event.

', 'FleetAttributes$InstanceRoleArn' => '

Unique identifier for an AWS IAM role that manages access to your AWS services. Any application that runs on an instance in this fleet can assume the role, including install scripts, server processs, daemons (background processes). Create a role or look up a role\'s ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

', 'FleetCapacityExceededException$Message' => NULL, 'GameSessionFullException$Message' => NULL, 'IdempotentParameterMismatchException$Message' => NULL, 'InstanceCredentials$UserName' => '

User login string.

', 'InstanceCredentials$Secret' => '

Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux instances, it is a private key (which must be saved as a .pem file) for use with SSH.

', 'InternalServiceException$Message' => NULL, 'InvalidFleetStatusException$Message' => NULL, 'InvalidGameSessionStatusException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'LatencyMap$key' => NULL, 'LimitExceededException$Message' => NULL, 'ListAliasesInput$Name' => '

Descriptive label that is associated with an alias. Alias names do not need to be unique.

', 'ListAliasesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'ListAliasesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'ListBuildsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'ListBuildsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'NotFoundException$Message' => NULL, 'S3Location$Bucket' => '

Amazon S3 bucket identifier. This is the name of your S3 bucket.

', 'S3Location$Key' => '

Name of the zip file containing your build files.

', 'S3Location$RoleArn' => '

Amazon Resource Name (ARN) for the access role that allows Amazon GameLift to access your S3 bucket.

', 'TerminalRoutingStrategyException$Message' => NULL, 'UnauthorizedException$Message' => NULL, 'UnsupportedRegionException$Message' => NULL, ], ], 'NonZeroAndMaxString' => [ 'base' => NULL, 'refs' => [ 'AttributeValue$S' => '

For single string values. Maximum string length is 100 characters.

', 'CreateAliasInput$Description' => '

Human-readable description of an alias.

', 'CreateBuildInput$Name' => '

Descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

', 'CreateBuildInput$Version' => '

Version that is associated with this build. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

', 'CreateFleetInput$Name' => '

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

', 'CreateFleetInput$Description' => '

Human-readable description of a fleet.

', 'CreateFleetInput$ServerLaunchPath' => '

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

', 'CreateFleetInput$ServerLaunchParameters' => '

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

', 'CreateFleetInput$PeerVpcAwsAccountId' => '

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

', 'CreateFleetInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'CreateGameSessionInput$Name' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'CreateGameSessionInput$CreatorId' => '

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

', 'CreateMatchmakingConfigurationInput$Description' => '

Meaningful description of the matchmaking configuration.

', 'CreatePlayerSessionInput$PlayerId' => '

Unique identifier for a player. Player IDs are developer-defined.

', 'CreateVpcPeeringAuthorizationInput$GameLiftAwsAccountId' => '

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

', 'CreateVpcPeeringAuthorizationInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'CreateVpcPeeringConnectionInput$PeerVpcAwsAccountId' => '

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

', 'CreateVpcPeeringConnectionInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'DeleteScalingPolicyInput$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

', 'DeleteVpcPeeringAuthorizationInput$GameLiftAwsAccountId' => '

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

', 'DeleteVpcPeeringAuthorizationInput$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'DeleteVpcPeeringConnectionInput$VpcPeeringConnectionId' => '

Unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

', 'DescribeFleetAttributesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetAttributesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeFleetCapacityInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetCapacityOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeFleetEventsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeFleetEventsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeFleetUtilizationInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetUtilizationOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeGameSessionDetailsInput$StatusFilter' => '

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

', 'DescribeGameSessionDetailsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeGameSessionDetailsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeGameSessionQueuesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeGameSessionQueuesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeGameSessionsInput$StatusFilter' => '

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

', 'DescribeGameSessionsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeGameSessionsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeInstancesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeInstancesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeMatchmakingConfigurationsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeMatchmakingConfigurationsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeMatchmakingRuleSetsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeMatchmakingRuleSetsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribePlayerSessionsInput$PlayerId' => '

Unique identifier for a player to retrieve player sessions for.

', 'DescribePlayerSessionsInput$PlayerSessionStatusFilter' => '

Player session status to filter results on.

Possible player session statuses include the following:

', 'DescribePlayerSessionsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

', 'DescribePlayerSessionsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DescribeScalingPoliciesInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'DescribeScalingPoliciesOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'DesiredPlayerSession$PlayerId' => '

Unique identifier for a player to associate with the player session.

', 'Event$EventId' => '

Unique identifier for a fleet event.

', 'Event$ResourceId' => '

Unique identifier for an event resource, such as a fleet ID.

', 'Event$PreSignedLogUrl' => '

Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.

', 'FleetAttributes$Description' => '

Human-readable description of the fleet.

', 'FleetAttributes$Name' => '

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

', 'FleetAttributes$ServerLaunchPath' => '

Path to a game server executable in the fleet\'s build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet\'s RuntimeConfiguration.

', 'FleetAttributes$ServerLaunchParameters' => '

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet\'s RuntimeConfiguration.

', 'GameSession$GameSessionId' => '

Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

', 'GameSession$Name' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'GameSession$CreatorId' => '

Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

', 'GameSessionPlacement$GameSessionName' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'GameSessionPlacement$GameSessionId' => '

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

', 'GameSessionPlacement$GameSessionArn' => '

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

', 'GameSessionPlacement$GameSessionRegion' => '

Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

', 'GetGameSessionLogUrlOutput$PreSignedUrl' => '

Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.

', 'ListFleetsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'ListFleetsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'MatchedPlayerSession$PlayerId' => '

Unique identifier for a player

', 'MatchmakingConfiguration$Description' => '

Descriptive label that is associated with matchmaking configuration.

', 'PlacedPlayerSession$PlayerId' => '

Unique identifier for a player that is associated with this player session.

', 'Player$PlayerId' => '

Unique identifier for a player

', 'Player$Team' => '

Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

', 'PlayerAttributeMap$key' => NULL, 'PlayerDataMap$key' => NULL, 'PlayerIdList$member' => NULL, 'PlayerLatency$PlayerId' => '

Unique identifier for a player associated with the latency data.

', 'PlayerLatency$RegionIdentifier' => '

Name of the region that is associated with the latency value.

', 'PlayerSession$PlayerId' => '

Unique identifier for a player that is associated with this player session.

', 'PlayerSession$GameSessionId' => '

Unique identifier for the game session that the player session is connected to.

', 'PutScalingPolicyInput$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

', 'PutScalingPolicyOutput$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

', 'ScalingPolicy$Name' => '

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

', 'SearchGameSessionsInput$FilterExpression' => '

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".

', 'SearchGameSessionsInput$SortExpression' => '

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.

', 'SearchGameSessionsInput$NextToken' => '

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

', 'SearchGameSessionsOutput$NextToken' => '

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

', 'ServerProcess$LaunchPath' => '

Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\\game, and for Linux instances /local/game. A Windows game build with an executable file located at MyGame\\latest\\server.exe must have a launch path of "C:\\game\\MyGame\\latest\\server.exe". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe".

', 'ServerProcess$Parameters' => '

Optional list of parameters to pass to the server executable on launch.

', 'StartGameSessionPlacementInput$GameSessionName' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'StringDoubleMap$key' => NULL, 'StringList$member' => NULL, 'UpdateAliasInput$Description' => '

Human-readable description of an alias.

', 'UpdateBuildInput$Name' => '

Descriptive label that is associated with a build. Build names do not need to be unique.

', 'UpdateBuildInput$Version' => '

Version that is associated with this build. Version strings do not need to be unique.

', 'UpdateFleetAttributesInput$Name' => '

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

', 'UpdateFleetAttributesInput$Description' => '

Human-readable description of a fleet.

', 'UpdateGameSessionInput$Name' => '

Descriptive label that is associated with a game session. Session names do not need to be unique.

', 'UpdateMatchmakingConfigurationInput$Description' => '

Descriptive label that is associated with matchmaking configuration.

', 'VpcPeeringAuthorization$GameLiftAwsAccountId' => '

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

', 'VpcPeeringAuthorization$PeerVpcAwsAccountId' => '

', 'VpcPeeringAuthorization$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'VpcPeeringConnection$IpV4CidrBlock' => '

CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

', 'VpcPeeringConnection$VpcPeeringConnectionId' => '

Unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection.

', 'VpcPeeringConnection$PeerVpcId' => '

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

', 'VpcPeeringConnection$GameLiftVpcId' => '

Unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.

', 'VpcPeeringConnectionStatus$Code' => '

Code indicating the status of a VPC peering connection.

', 'VpcPeeringConnectionStatus$Message' => '

Additional messaging associated with the connection status.

', ], ], 'NotFoundException' => [ 'base' => '

A service resource associated with the request could not be found. Clients should not retry such requests.

', 'refs' => [], ], 'OperatingSystem' => [ 'base' => NULL, 'refs' => [ 'Build$OperatingSystem' => '

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

', 'CreateBuildInput$OperatingSystem' => '

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

', 'FleetAttributes$OperatingSystem' => '

Operating system of the fleet\'s computing resources. A fleet\'s operating system depends on the OS specified for the build that is deployed on this fleet.

', 'Instance$OperatingSystem' => '

Operating system that is running on this instance.

', 'InstanceAccess$OperatingSystem' => '

Operating system that is running on the instance.

', ], ], 'PlacedPlayerSession' => [ 'base' => '

Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.

', 'refs' => [ 'PlacedPlayerSessionList$member' => NULL, ], ], 'PlacedPlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'GameSessionPlacement$PlacedPlayerSessions' => '

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

', ], ], 'Player' => [ 'base' => '

Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.

', 'refs' => [ 'PlayerList$member' => NULL, ], ], 'PlayerAttributeMap' => [ 'base' => NULL, 'refs' => [ 'Player$PlayerAttributes' => '

Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

', ], ], 'PlayerData' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionInput$PlayerData' => '

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

', 'DesiredPlayerSession$PlayerData' => '

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

', 'PlayerDataMap$value' => NULL, 'PlayerSession$PlayerData' => '

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

', ], ], 'PlayerDataMap' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionsInput$PlayerDataMap' => '

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data strings for player IDs not included in the PlayerIds parameter are ignored.

', ], ], 'PlayerIdList' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionsInput$PlayerIds' => '

List of unique identifiers for the players to be added.

', ], ], 'PlayerLatency' => [ 'base' => '

Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player\'s latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.

', 'refs' => [ 'PlayerLatencyList$member' => NULL, ], ], 'PlayerLatencyList' => [ 'base' => NULL, 'refs' => [ 'GameSessionPlacement$PlayerLatencies' => '

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

', 'StartGameSessionPlacementInput$PlayerLatencies' => '

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

', ], ], 'PlayerLatencyPolicy' => [ 'base' => '

Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

', 'refs' => [ 'PlayerLatencyPolicyList$member' => NULL, ], ], 'PlayerLatencyPolicyList' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionQueueInput$PlayerLatencyPolicies' => '

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

', 'GameSessionQueue$PlayerLatencyPolicies' => '

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

', 'UpdateGameSessionQueueInput$PlayerLatencyPolicies' => '

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.

', ], ], 'PlayerList' => [ 'base' => NULL, 'refs' => [ 'MatchmakingTicket$Players' => '

A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

', 'StartMatchBackfillInput$Players' => '

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

', 'StartMatchmakingInput$Players' => '

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

', ], ], 'PlayerSession' => [ 'base' => '

Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED) or actual player activity in a game session (status ACTIVE). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.

When a player disconnects, the player session status changes to COMPLETED. Once the session ends, the player session object is retained for 30 days and then removed.

', 'refs' => [ 'CreatePlayerSessionOutput$PlayerSession' => '

Object that describes the newly created player session record.

', 'PlayerSessionList$member' => NULL, ], ], 'PlayerSessionCreationPolicy' => [ 'base' => NULL, 'refs' => [ 'GameSession$PlayerSessionCreationPolicy' => '

Indicates whether or not the game session is accepting new players.

', 'UpdateGameSessionInput$PlayerSessionCreationPolicy' => '

Policy determining whether or not the game session accepts new players.

', ], ], 'PlayerSessionId' => [ 'base' => NULL, 'refs' => [ 'DescribePlayerSessionsInput$PlayerSessionId' => '

Unique identifier for a player session to retrieve.

', 'MatchedPlayerSession$PlayerSessionId' => '

Unique identifier for a player session

', 'PlacedPlayerSession$PlayerSessionId' => '

Unique identifier for a player session.

', 'PlayerSession$PlayerSessionId' => '

Unique identifier for a player session.

', ], ], 'PlayerSessionList' => [ 'base' => NULL, 'refs' => [ 'CreatePlayerSessionsOutput$PlayerSessions' => '

Collection of player session objects created for the added players.

', 'DescribePlayerSessionsOutput$PlayerSessions' => '

Collection of objects containing properties for each player session that matches the request.

', ], ], 'PlayerSessionStatus' => [ 'base' => NULL, 'refs' => [ 'PlayerSession$Status' => '

Current status of the player session.

Possible player session statuses include the following:

', ], ], 'PolicyType' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$PolicyType' => '

Type of scaling policy to create. For a target-based policy, set the parameter MetricName to \'PercentAvailableGameSessions\' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

', 'ScalingPolicy$PolicyType' => '

Type of scaling policy to create. For a target-based policy, set the parameter MetricName to \'PercentAvailableGameSessions\' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

', ], ], 'PortNumber' => [ 'base' => NULL, 'refs' => [ 'GameSession$Port' => '

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'GameSessionPlacement$Port' => '

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

', 'IpPermission$FromPort' => '

Starting value for a range of allowed port numbers.

', 'IpPermission$ToPort' => '

Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

', 'PlayerSession$Port' => '

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'DescribeFleetAttributesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetCapacityInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeFleetEventsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeFleetUtilizationInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

', 'DescribeGameSessionDetailsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeGameSessionQueuesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeGameSessionsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeInstancesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'DescribeMatchmakingConfigurationsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10.

', 'DescribePlayerSessionsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

', 'DescribeScalingPoliciesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'GameSessionConnectionInfo$Port' => '

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'LatencyMap$value' => NULL, 'ListAliasesInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'ListBuildsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'ListFleetsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', 'PutScalingPolicyInput$EvaluationPeriods' => '

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

', 'ScalingPolicy$EvaluationPeriods' => '

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

', 'SearchGameSessionsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

', 'ServerProcess$ConcurrentExecutions' => '

Number of server processes using this configuration to run concurrently on an instance.

', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'Build$SizeOnDisk' => '

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

', ], ], 'ProtectionPolicy' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$NewGameSessionProtectionPolicy' => '

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet\'s protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

', 'FleetAttributes$NewGameSessionProtectionPolicy' => '

Type of game session protection to set for all new instances started in the fleet.

', 'GameSessionDetail$ProtectionPolicy' => '

Current status of protection for the game session.

', 'UpdateFleetAttributesInput$NewGameSessionProtectionPolicy' => '

Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

', 'UpdateGameSessionInput$ProtectionPolicy' => '

Game session protection policy to apply to this game session only.

', ], ], 'PutScalingPolicyInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'PutScalingPolicyOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'QueueArnsList' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$GameSessionQueueArns' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

', 'MatchmakingConfiguration$GameSessionQueueArns' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

', 'UpdateMatchmakingConfigurationInput$GameSessionQueueArns' => '

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

', ], ], 'RequestUploadCredentialsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'RequestUploadCredentialsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ResolveAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ResolveAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ResourceCreationLimitPolicy' => [ 'base' => '

Policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example, with a policy of 10 new game sessions and a time period of 60 minutes, on receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

', 'refs' => [ 'CreateFleetInput$ResourceCreationLimitPolicy' => '

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

', 'FleetAttributes$ResourceCreationLimitPolicy' => '

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

', 'UpdateFleetAttributesInput$ResourceCreationLimitPolicy' => '

Policy that limits the number of game sessions an individual player can create over a span of time.

', ], ], 'RoutingStrategy' => [ 'base' => '

Routing configuration for a fleet alias.

', 'refs' => [ 'Alias$RoutingStrategy' => '

Alias configuration for the alias, including routing type and settings.

', 'CreateAliasInput$RoutingStrategy' => '

Object that specifies the fleet and routing type to use for the alias.

', 'UpdateAliasInput$RoutingStrategy' => '

Object that specifies the fleet and routing type to use for the alias.

', ], ], 'RoutingStrategyType' => [ 'base' => NULL, 'refs' => [ 'ListAliasesInput$RoutingStrategyType' => '

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

', 'RoutingStrategy$Type' => '

Type of routing strategy.

Possible routing types include the following:

', ], ], 'RuleSetBody' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingRuleSetInput$RuleSetBody' => '

Collection of matchmaking rules, formatted as a JSON string. Note that comments are not allowed in JSON, but most elements support a description field.

', 'MatchmakingRuleSet$RuleSetBody' => '

Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)

', 'ValidateMatchmakingRuleSetInput$RuleSetBody' => '

Collection of matchmaking rules to validate, formatted as a JSON string.

', ], ], 'RuleSetLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeMatchmakingRuleSetsInput$Limit' => '

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

', ], ], 'RuntimeConfiguration' => [ 'base' => '

A collection of server process configurations that describe what processes to run on each instance in a fleet. All fleets must have a run-time configuration. Each instance in the fleet launches the server processes specified in the run-time configuration and launches new ones as existing processes end. Each instance regularly checks for an updated run-time configuration and follows the new instructions.

The run-time configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different build executables, such as your game server executable and a related program, or two or more different versions of a game server. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.

A Amazon GameLift instance is limited to 50 processes running simultaneously. A run-time configuration must specify fewer than this limit. To calculate the total number of processes specified in a run-time configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the run-time configuration.

', 'refs' => [ 'CreateFleetInput$RuntimeConfiguration' => '

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

', 'DescribeRuntimeConfigurationOutput$RuntimeConfiguration' => '

Instructions describing how server processes should be launched and maintained on each instance in the fleet.

', 'UpdateRuntimeConfigurationInput$RuntimeConfiguration' => '

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.

', 'UpdateRuntimeConfigurationOutput$RuntimeConfiguration' => '

The run-time configuration currently in force. If the update was successful, this object matches the one in the request.

', ], ], 'S3Location' => [ 'base' => '

Location in Amazon Simple Storage Service (Amazon S3) where build files can be stored for access by Amazon GameLift. This location is specified in a CreateBuild request. For more details, see the Create a Build with Files in Amazon S3.

', 'refs' => [ 'CreateBuildInput$StorageLocation' => '

Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key, as well as a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in.

', 'CreateBuildOutput$StorageLocation' => '

Amazon S3 location for your game build file, including bucket name and key.

', 'RequestUploadCredentialsOutput$StorageLocation' => '

Amazon S3 path and key, identifying where the game build files are stored.

', ], ], 'ScalingAdjustmentType' => [ 'base' => NULL, 'refs' => [ 'PutScalingPolicyInput$ScalingAdjustmentType' => '

Type of adjustment to make to a fleet\'s instance count (see FleetCapacity):

', 'ScalingPolicy$ScalingAdjustmentType' => '

Type of adjustment to make to a fleet\'s instance count (see FleetCapacity):

', ], ], 'ScalingPolicy' => [ 'base' => '

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

', 'refs' => [ 'ScalingPolicyList$member' => NULL, ], ], 'ScalingPolicyList' => [ 'base' => NULL, 'refs' => [ 'DescribeScalingPoliciesOutput$ScalingPolicies' => '

Collection of objects containing the scaling policies matching the request.

', ], ], 'ScalingStatusType' => [ 'base' => NULL, 'refs' => [ 'DescribeScalingPoliciesInput$StatusFilter' => '

Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

', 'ScalingPolicy$Status' => '

Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet\'s stopped actions by calling DescribeFleetCapacity.

', ], ], 'SearchGameSessionsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'SearchGameSessionsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ServerProcess' => [ 'base' => '

A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet\'s RuntimeConfiguration .

', 'refs' => [ 'ServerProcessList$member' => NULL, ], ], 'ServerProcessList' => [ 'base' => NULL, 'refs' => [ 'RuntimeConfiguration$ServerProcesses' => '

Collection of server process configurations that describe which server processes to run on each instance in a fleet.

', ], ], 'SnsArnStringModel' => [ 'base' => NULL, 'refs' => [ 'CreateMatchmakingConfigurationInput$NotificationTarget' => '

SNS topic ARN that is set up to receive matchmaking notifications.

', 'MatchmakingConfiguration$NotificationTarget' => '

SNS topic ARN that is set up to receive matchmaking notifications.

', 'UpdateMatchmakingConfigurationInput$NotificationTarget' => '

SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

', ], ], 'StartFleetActionsInput' => [ 'base' => NULL, 'refs' => [], ], 'StartFleetActionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'StartGameSessionPlacementInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StartGameSessionPlacementOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StartMatchBackfillInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StartMatchBackfillOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StartMatchmakingInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StartMatchmakingOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StopFleetActionsInput' => [ 'base' => NULL, 'refs' => [], ], 'StopFleetActionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'StopGameSessionPlacementInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StopGameSessionPlacementOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'StopMatchmakingInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'StopMatchmakingOutput' => [ 'base' => NULL, 'refs' => [], ], 'StringDoubleMap' => [ 'base' => NULL, 'refs' => [ 'AttributeValue$SDM' => '

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AcceptMatchInput$PlayerIds' => '

Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

', 'AttributeValue$SL' => '

For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

', 'CreateFleetInput$LogPaths' => '

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

', 'FleetAttributes$LogPaths' => '

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\\game\\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

', ], ], 'StringModel' => [ 'base' => NULL, 'refs' => [ 'GameSessionConnectionInfo$IpAddress' => '

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

', 'MatchmakingTicket$StatusReason' => '

Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

', 'MatchmakingTicket$StatusMessage' => '

Additional information about the current status.

', ], ], 'TargetConfiguration' => [ 'base' => '

Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

', 'refs' => [ 'PutScalingPolicyInput$TargetConfiguration' => '

Object that contains settings for a target-based scaling policy.

', 'ScalingPolicy$TargetConfiguration' => '

Object that contains settings for a target-based scaling policy.

', ], ], 'TerminalRoutingStrategyException' => [ 'base' => '

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Alias$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'Alias$LastUpdatedTime' => '

Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'Build$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'DescribeFleetEventsInput$StartTime' => '

Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

', 'DescribeFleetEventsInput$EndTime' => '

Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").

', 'Event$EventTime' => '

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'FleetAttributes$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'FleetAttributes$TerminationTime' => '

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSession$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSession$TerminationTime' => '

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSessionPlacement$StartTime' => '

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'GameSessionPlacement$EndTime' => '

Time stamp indicating when this request was completed, canceled, or timed out.

', 'Instance$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingConfiguration$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingRuleSet$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingTicket$StartTime' => '

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'MatchmakingTicket$EndTime' => '

Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'PlayerSession$CreationTime' => '

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'PlayerSession$TerminationTime' => '

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'VpcPeeringAuthorization$CreationTime' => '

Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', 'VpcPeeringAuthorization$ExpirationTime' => '

Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

', ], ], 'UnauthorizedException' => [ 'base' => '

The client failed authentication. Clients should not retry such requests.

', 'refs' => [], ], 'UnsupportedRegionException' => [ 'base' => '

The requested operation is not supported in the region specified.

', 'refs' => [], ], 'UpdateAliasInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateAliasOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateBuildInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateBuildOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateFleetAttributesInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateFleetAttributesOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateFleetCapacityInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateFleetCapacityOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateFleetPortSettingsInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateFleetPortSettingsOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateGameSessionInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateGameSessionOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateGameSessionQueueInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateGameSessionQueueOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateMatchmakingConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateMatchmakingConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'UpdateRuntimeConfigurationInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'UpdateRuntimeConfigurationOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'ValidateMatchmakingRuleSetInput' => [ 'base' => '

Represents the input for a request action.

', 'refs' => [], ], 'ValidateMatchmakingRuleSetOutput' => [ 'base' => '

Represents the returned data in response to a request action.

', 'refs' => [], ], 'VpcPeeringAuthorization' => [ 'base' => '

Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.

', 'refs' => [ 'CreateVpcPeeringAuthorizationOutput$VpcPeeringAuthorization' => '

Details on the requested VPC peering authorization, including expiration.

', 'VpcPeeringAuthorizationList$member' => NULL, ], ], 'VpcPeeringAuthorizationList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcPeeringAuthorizationsOutput$VpcPeeringAuthorizations' => '

Collection of objects that describe all valid VPC peering operations for the current AWS account.

', ], ], 'VpcPeeringConnection' => [ 'base' => '

Represents a peering connection between a VPC on one of your AWS accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.

', 'refs' => [ 'VpcPeeringConnectionList$member' => NULL, ], ], 'VpcPeeringConnectionList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcPeeringConnectionsOutput$VpcPeeringConnections' => '

Collection of VPC peering connection records that match the request.

', ], ], 'VpcPeeringConnectionStatus' => [ 'base' => '

Represents status information for a VPC peering connection. Status is associated with a VpcPeeringConnection object. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet Event.

', 'refs' => [ 'VpcPeeringConnection$Status' => '

Object that contains status information about the connection. Status indicates if a connection is pending, successful, or failed.

', ], ], 'WholeNumber' => [ 'base' => NULL, 'refs' => [ 'CreateGameSessionInput$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'CreateGameSessionQueueInput$TimeoutInSeconds' => '

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

', 'CreateMatchmakingConfigurationInput$AdditionalPlayerCount' => '

Number of player slots in a match to keep open for future players. For example, if the configuration\'s rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

', 'EC2InstanceCounts$DESIRED' => '

Ideal number of active instances in the fleet.

', 'EC2InstanceCounts$MINIMUM' => '

Minimum value allowed for the fleet\'s instance count.

', 'EC2InstanceCounts$MAXIMUM' => '

Maximum value allowed for the fleet\'s instance count.

', 'EC2InstanceCounts$PENDING' => '

Number of instances in the fleet that are starting but not yet active.

', 'EC2InstanceCounts$ACTIVE' => '

Actual number of active instances in the fleet.

', 'EC2InstanceCounts$IDLE' => '

Number of active instances in the fleet that are not currently hosting a game session.

', 'EC2InstanceCounts$TERMINATING' => '

Number of instances in the fleet that are no longer active but haven\'t yet been terminated.

', 'EC2InstanceLimit$CurrentInstances' => '

Number of instances of the specified type that are currently in use by this AWS account.

', 'EC2InstanceLimit$InstanceLimit' => '

Number of instances allowed.

', 'FleetUtilization$ActiveServerProcessCount' => '

Number of server processes in an ACTIVE status currently running across all instances in the fleet

', 'FleetUtilization$ActiveGameSessionCount' => '

Number of active game sessions currently being hosted on all instances in the fleet.

', 'FleetUtilization$CurrentPlayerSessionCount' => '

Number of active player sessions currently being hosted on all instances in the fleet.

', 'FleetUtilization$MaximumPlayerSessionCount' => '

Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.

', 'GameSession$CurrentPlayerSessionCount' => '

Number of players currently in the game session.

', 'GameSession$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'GameSessionPlacement$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'GameSessionQueue$TimeoutInSeconds' => '

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

', 'MatchmakingConfiguration$AdditionalPlayerCount' => '

Number of player slots in a match to keep open for future players. For example, if the configuration\'s rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

', 'MatchmakingTicket$EstimatedWaitTime' => '

Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

', 'PlayerLatencyPolicy$MaximumIndividualPlayerLatencyMilliseconds' => '

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

', 'PlayerLatencyPolicy$PolicyDurationSeconds' => '

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

', 'ResourceCreationLimitPolicy$NewGameSessionsPerCreator' => '

Maximum number of game sessions that an individual can create during the policy period.

', 'ResourceCreationLimitPolicy$PolicyPeriodInMinutes' => '

Time span used in evaluating the resource creation limit policy.

', 'StartGameSessionPlacementInput$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'UpdateFleetCapacityInput$DesiredInstances' => '

Number of EC2 instances you want this fleet to host.

', 'UpdateFleetCapacityInput$MinSize' => '

Minimum value allowed for the fleet\'s instance count. Default if not set is 0.

', 'UpdateFleetCapacityInput$MaxSize' => '

Maximum value allowed for the fleet\'s instance count. Default if not set is 1.

', 'UpdateGameSessionInput$MaximumPlayerSessionCount' => '

Maximum number of players that can be connected simultaneously to the game session.

', 'UpdateGameSessionQueueInput$TimeoutInSeconds' => '

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

', 'UpdateMatchmakingConfigurationInput$AdditionalPlayerCount' => '

Number of player slots in a match to keep open for future players. For example, if the configuration\'s rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

', ], ], ],]; diff --git a/src/data/greengrass/2017-06-07/api-2.json b/src/data/greengrass/2017-06-07/api-2.json index 4fa0f1c155..e30ec9910f 100644 --- a/src/data/greengrass/2017-06-07/api-2.json +++ b/src/data/greengrass/2017-06-07/api-2.json @@ -2765,6 +2765,9 @@ "members" : { "IsolationMode" : { "shape" : "FunctionIsolationMode" + }, + "RunAs" : { + "shape" : "FunctionRunAsConfig" } } }, diff --git a/src/data/greengrass/2017-06-07/api-2.json.php b/src/data/greengrass/2017-06-07/api-2.json.php index 40ca3c3417..6431bc9a5d 100644 --- a/src/data/greengrass/2017-06-07/api-2.json.php +++ b/src/data/greengrass/2017-06-07/api-2.json.php @@ -1,3 +1,3 @@ [ 'apiVersion' => '2017-06-07', 'endpointPrefix' => 'greengrass', 'signingName' => 'greengrass', 'serviceFullName' => 'AWS Greengrass', 'serviceId' => 'Greengrass', 'protocol' => 'rest-json', 'jsonVersion' => '1.1', 'uid' => 'greengrass-2017-06-07', 'signatureVersion' => 'v4', ], 'operations' => [ 'AssociateRoleToGroup' => [ 'name' => 'AssociateRoleToGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/groups/{GroupId}/role', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociateRoleToGroupRequest', ], 'output' => [ 'shape' => 'AssociateRoleToGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'AssociateServiceRoleToAccount' => [ 'name' => 'AssociateServiceRoleToAccount', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/servicerole', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociateServiceRoleToAccountRequest', ], 'output' => [ 'shape' => 'AssociateServiceRoleToAccountResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'CreateConnectorDefinition' => [ 'name' => 'CreateConnectorDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/connectors', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'CreateConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateConnectorDefinitionVersion' => [ 'name' => 'CreateConnectorDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateConnectorDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateConnectorDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateCoreDefinition' => [ 'name' => 'CreateCoreDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/cores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateCoreDefinitionRequest', ], 'output' => [ 'shape' => 'CreateCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateCoreDefinitionVersion' => [ 'name' => 'CreateCoreDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateCoreDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateCoreDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateDeployment' => [ 'name' => 'CreateDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeploymentRequest', ], 'output' => [ 'shape' => 'CreateDeploymentResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateDeviceDefinition' => [ 'name' => 'CreateDeviceDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/devices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateDeviceDefinitionVersion' => [ 'name' => 'CreateDeviceDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeviceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateDeviceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateFunctionDefinition' => [ 'name' => 'CreateFunctionDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/functions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateFunctionDefinitionVersion' => [ 'name' => 'CreateFunctionDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateFunctionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateFunctionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateGroupCertificateAuthority' => [ 'name' => 'CreateGroupCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateGroupCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'CreateGroupCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'CreateGroupVersion' => [ 'name' => 'CreateGroupVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateGroupVersionRequest', ], 'output' => [ 'shape' => 'CreateGroupVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateLoggerDefinition' => [ 'name' => 'CreateLoggerDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/loggers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'CreateLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateLoggerDefinitionVersion' => [ 'name' => 'CreateLoggerDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateLoggerDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateLoggerDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateResourceDefinition' => [ 'name' => 'CreateResourceDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateResourceDefinitionRequest', ], 'output' => [ 'shape' => 'CreateResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateResourceDefinitionVersion' => [ 'name' => 'CreateResourceDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateResourceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateResourceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateSoftwareUpdateJob' => [ 'name' => 'CreateSoftwareUpdateJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/updates', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSoftwareUpdateJobRequest', ], 'output' => [ 'shape' => 'CreateSoftwareUpdateJobResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'CreateSubscriptionDefinition' => [ 'name' => 'CreateSubscriptionDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/subscriptions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'CreateSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateSubscriptionDefinitionVersion' => [ 'name' => 'CreateSubscriptionDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSubscriptionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateSubscriptionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteConnectorDefinition' => [ 'name' => 'DeleteConnectorDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteCoreDefinition' => [ 'name' => 'DeleteCoreDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteCoreDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteDeviceDefinition' => [ 'name' => 'DeleteDeviceDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteFunctionDefinition' => [ 'name' => 'DeleteFunctionDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/groups/{GroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteLoggerDefinition' => [ 'name' => 'DeleteLoggerDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteResourceDefinition' => [ 'name' => 'DeleteResourceDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteResourceDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteSubscriptionDefinition' => [ 'name' => 'DeleteSubscriptionDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DisassociateRoleFromGroup' => [ 'name' => 'DisassociateRoleFromGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/groups/{GroupId}/role', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociateRoleFromGroupRequest', ], 'output' => [ 'shape' => 'DisassociateRoleFromGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'DisassociateServiceRoleFromAccount' => [ 'name' => 'DisassociateServiceRoleFromAccount', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/servicerole', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociateServiceRoleFromAccountRequest', ], 'output' => [ 'shape' => 'DisassociateServiceRoleFromAccountResponse', ], 'errors' => [ [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetAssociatedRole' => [ 'name' => 'GetAssociatedRole', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/role', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAssociatedRoleRequest', ], 'output' => [ 'shape' => 'GetAssociatedRoleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetBulkDeploymentStatus' => [ 'name' => 'GetBulkDeploymentStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/bulk/deployments/{BulkDeploymentId}/status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetBulkDeploymentStatusRequest', ], 'output' => [ 'shape' => 'GetBulkDeploymentStatusResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetConnectivityInfo' => [ 'name' => 'GetConnectivityInfo', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/things/{ThingName}/connectivityInfo', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetConnectivityInfoRequest', ], 'output' => [ 'shape' => 'GetConnectivityInfoResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetConnectorDefinition' => [ 'name' => 'GetConnectorDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'GetConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetConnectorDefinitionVersion' => [ 'name' => 'GetConnectorDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}/versions/{ConnectorDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetConnectorDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetConnectorDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetCoreDefinition' => [ 'name' => 'GetCoreDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetCoreDefinitionRequest', ], 'output' => [ 'shape' => 'GetCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetCoreDefinitionVersion' => [ 'name' => 'GetCoreDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}/versions/{CoreDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetCoreDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetCoreDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetDeploymentStatus' => [ 'name' => 'GetDeploymentStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/deployments/{DeploymentId}/status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeploymentStatusRequest', ], 'output' => [ 'shape' => 'GetDeploymentStatusResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetDeviceDefinition' => [ 'name' => 'GetDeviceDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'GetDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetDeviceDefinitionVersion' => [ 'name' => 'GetDeviceDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}/versions/{DeviceDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeviceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetDeviceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetFunctionDefinition' => [ 'name' => 'GetFunctionDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'GetFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetFunctionDefinitionVersion' => [ 'name' => 'GetFunctionDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}/versions/{FunctionDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetFunctionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetGroup' => [ 'name' => 'GetGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupRequest', ], 'output' => [ 'shape' => 'GetGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetGroupCertificateAuthority' => [ 'name' => 'GetGroupCertificateAuthority', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities/{CertificateAuthorityId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'GetGroupCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetGroupCertificateConfiguration' => [ 'name' => 'GetGroupCertificateConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupCertificateConfigurationRequest', ], 'output' => [ 'shape' => 'GetGroupCertificateConfigurationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetGroupVersion' => [ 'name' => 'GetGroupVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/versions/{GroupVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupVersionRequest', ], 'output' => [ 'shape' => 'GetGroupVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetLoggerDefinition' => [ 'name' => 'GetLoggerDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'GetLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetLoggerDefinitionVersion' => [ 'name' => 'GetLoggerDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}/versions/{LoggerDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLoggerDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetLoggerDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetResourceDefinition' => [ 'name' => 'GetResourceDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetResourceDefinitionRequest', ], 'output' => [ 'shape' => 'GetResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetResourceDefinitionVersion' => [ 'name' => 'GetResourceDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}/versions/{ResourceDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetResourceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetResourceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetServiceRoleForAccount' => [ 'name' => 'GetServiceRoleForAccount', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/servicerole', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetServiceRoleForAccountRequest', ], 'output' => [ 'shape' => 'GetServiceRoleForAccountResponse', ], 'errors' => [ [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetSubscriptionDefinition' => [ 'name' => 'GetSubscriptionDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'GetSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetSubscriptionDefinitionVersion' => [ 'name' => 'GetSubscriptionDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSubscriptionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetSubscriptionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListBulkDeploymentDetailedReports' => [ 'name' => 'ListBulkDeploymentDetailedReports', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/bulk/deployments/{BulkDeploymentId}/detailed-reports', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListBulkDeploymentDetailedReportsRequest', ], 'output' => [ 'shape' => 'ListBulkDeploymentDetailedReportsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListBulkDeployments' => [ 'name' => 'ListBulkDeployments', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/bulk/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListBulkDeploymentsRequest', ], 'output' => [ 'shape' => 'ListBulkDeploymentsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListConnectorDefinitionVersions' => [ 'name' => 'ListConnectorDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListConnectorDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListConnectorDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListConnectorDefinitions' => [ 'name' => 'ListConnectorDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListConnectorDefinitionsRequest', ], 'output' => [ 'shape' => 'ListConnectorDefinitionsResponse', ], 'errors' => [], ], 'ListCoreDefinitionVersions' => [ 'name' => 'ListCoreDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListCoreDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListCoreDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListCoreDefinitions' => [ 'name' => 'ListCoreDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListCoreDefinitionsRequest', ], 'output' => [ 'shape' => 'ListCoreDefinitionsResponse', ], 'errors' => [], ], 'ListDeployments' => [ 'name' => 'ListDeployments', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeploymentsRequest', ], 'output' => [ 'shape' => 'ListDeploymentsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListDeviceDefinitionVersions' => [ 'name' => 'ListDeviceDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeviceDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListDeviceDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListDeviceDefinitions' => [ 'name' => 'ListDeviceDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeviceDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDeviceDefinitionsResponse', ], 'errors' => [], ], 'ListFunctionDefinitionVersions' => [ 'name' => 'ListFunctionDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFunctionDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListFunctionDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListFunctionDefinitions' => [ 'name' => 'ListFunctionDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFunctionDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFunctionDefinitionsResponse', ], 'errors' => [], ], 'ListGroupCertificateAuthorities' => [ 'name' => 'ListGroupCertificateAuthorities', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupCertificateAuthoritiesRequest', ], 'output' => [ 'shape' => 'ListGroupCertificateAuthoritiesResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'ListGroupVersions' => [ 'name' => 'ListGroupVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupVersionsRequest', ], 'output' => [ 'shape' => 'ListGroupVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [], ], 'ListLoggerDefinitionVersions' => [ 'name' => 'ListLoggerDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListLoggerDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListLoggerDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListLoggerDefinitions' => [ 'name' => 'ListLoggerDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListLoggerDefinitionsRequest', ], 'output' => [ 'shape' => 'ListLoggerDefinitionsResponse', ], 'errors' => [], ], 'ListResourceDefinitionVersions' => [ 'name' => 'ListResourceDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListResourceDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListResourceDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListResourceDefinitions' => [ 'name' => 'ListResourceDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListResourceDefinitionsRequest', ], 'output' => [ 'shape' => 'ListResourceDefinitionsResponse', ], 'errors' => [], ], 'ListSubscriptionDefinitionVersions' => [ 'name' => 'ListSubscriptionDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSubscriptionDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListSubscriptionDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListSubscriptionDefinitions' => [ 'name' => 'ListSubscriptionDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSubscriptionDefinitionsRequest', ], 'output' => [ 'shape' => 'ListSubscriptionDefinitionsResponse', ], 'errors' => [], ], 'ResetDeployments' => [ 'name' => 'ResetDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/deployments/$reset', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResetDeploymentsRequest', ], 'output' => [ 'shape' => 'ResetDeploymentsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'StartBulkDeployment' => [ 'name' => 'StartBulkDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/bulk/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartBulkDeploymentRequest', ], 'output' => [ 'shape' => 'StartBulkDeploymentResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'StopBulkDeployment' => [ 'name' => 'StopBulkDeployment', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/bulk/deployments/{BulkDeploymentId}/$stop', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StopBulkDeploymentRequest', ], 'output' => [ 'shape' => 'StopBulkDeploymentResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateConnectivityInfo' => [ 'name' => 'UpdateConnectivityInfo', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/things/{ThingName}/connectivityInfo', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateConnectivityInfoRequest', ], 'output' => [ 'shape' => 'UpdateConnectivityInfoResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'UpdateConnectorDefinition' => [ 'name' => 'UpdateConnectorDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateCoreDefinition' => [ 'name' => 'UpdateCoreDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateCoreDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateDeviceDefinition' => [ 'name' => 'UpdateDeviceDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateFunctionDefinition' => [ 'name' => 'UpdateFunctionDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateGroup' => [ 'name' => 'UpdateGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/groups/{GroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateGroupRequest', ], 'output' => [ 'shape' => 'UpdateGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateGroupCertificateConfiguration' => [ 'name' => 'UpdateGroupCertificateConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateGroupCertificateConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateGroupCertificateConfigurationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'UpdateLoggerDefinition' => [ 'name' => 'UpdateLoggerDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateResourceDefinition' => [ 'name' => 'UpdateResourceDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateResourceDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateSubscriptionDefinition' => [ 'name' => 'UpdateSubscriptionDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], ], 'shapes' => [ 'AssociateRoleToGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'RoleArn' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'AssociateRoleToGroupResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], ], ], 'AssociateServiceRoleToAccountRequest' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => '__string', ], ], ], 'AssociateServiceRoleToAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], ], ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [ 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'Message' => [ 'shape' => '__string', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 400, ], ], 'BulkDeployment' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentArn' => [ 'shape' => '__string', ], 'BulkDeploymentId' => [ 'shape' => '__string', ], 'CreatedAt' => [ 'shape' => '__string', ], ], ], 'BulkDeploymentMetrics' => [ 'type' => 'structure', 'members' => [ 'InvalidInputRecords' => [ 'shape' => '__integer', ], 'RecordsProcessed' => [ 'shape' => '__integer', ], 'RetryAttempts' => [ 'shape' => '__integer', ], ], ], 'BulkDeploymentResult' => [ 'type' => 'structure', 'members' => [ 'CreatedAt' => [ 'shape' => '__string', ], 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], 'DeploymentStatus' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'ErrorMessage' => [ 'shape' => '__string', ], 'GroupArn' => [ 'shape' => '__string', ], ], ], 'BulkDeploymentResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'BulkDeploymentResult', ], ], 'BulkDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Running', 'Completed', 'Stopping', 'Stopped', 'Failed', ], ], 'BulkDeployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'BulkDeployment', ], ], 'ConnectivityInfo' => [ 'type' => 'structure', 'members' => [ 'HostAddress' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Metadata' => [ 'shape' => '__string', ], 'PortNumber' => [ 'shape' => '__integer', ], ], ], 'Connector' => [ 'type' => 'structure', 'members' => [ 'ConnectorArn' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Parameters' => [ 'shape' => '__mapOf__string', ], ], 'required' => [], ], 'ConnectorDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Connectors' => [ 'shape' => '__listOfConnector', ], ], ], 'Core' => [ 'type' => 'structure', 'members' => [ 'CertificateArn' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'SyncShadow' => [ 'shape' => '__boolean', ], 'ThingArn' => [ 'shape' => '__string', ], ], 'required' => [], ], 'CoreDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Cores' => [ 'shape' => '__listOfCore', ], ], ], 'CreateConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'ConnectorDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateConnectorDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'Connectors' => [ 'shape' => '__listOfConnector', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'CreateConnectorDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'CoreDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateCoreDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'Cores' => [ 'shape' => '__listOfCore', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'CreateCoreDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'DeploymentId' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'GroupVersionId' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'CreateDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], ], ], 'CreateDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'DeviceDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateDeviceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'Devices' => [ 'shape' => '__listOfDevice', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'CreateDeviceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'FunctionDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateFunctionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'DefaultConfig' => [ 'shape' => 'FunctionDefaultConfig', ], 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'Functions' => [ 'shape' => '__listOfFunction', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'CreateFunctionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateGroupCertificateAuthorityRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'CreateGroupCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorityArn' => [ 'shape' => '__string', ], ], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'GroupVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateGroupVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ConnectorDefinitionVersionArn' => [ 'shape' => '__string', ], 'CoreDefinitionVersionArn' => [ 'shape' => '__string', ], 'DeviceDefinitionVersionArn' => [ 'shape' => '__string', ], 'FunctionDefinitionVersionArn' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'LoggerDefinitionVersionArn' => [ 'shape' => '__string', ], 'ResourceDefinitionVersionArn' => [ 'shape' => '__string', ], 'SubscriptionDefinitionVersionArn' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'CreateGroupVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'LoggerDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateLoggerDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'Loggers' => [ 'shape' => '__listOfLogger', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'CreateLoggerDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'ResourceDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateResourceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], 'Resources' => [ 'shape' => '__listOfResource', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'CreateResourceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateSoftwareUpdateJobRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'S3UrlSignerRole' => [ 'shape' => 'S3UrlSignerRole', ], 'SoftwareToUpdate' => [ 'shape' => 'SoftwareToUpdate', ], 'UpdateAgentLogLevel' => [ 'shape' => 'UpdateAgentLogLevel', ], 'UpdateTargets' => [ 'shape' => 'UpdateTargets', ], 'UpdateTargetsArchitecture' => [ 'shape' => 'UpdateTargetsArchitecture', ], 'UpdateTargetsOperatingSystem' => [ 'shape' => 'UpdateTargetsOperatingSystem', ], ], ], 'CreateSoftwareUpdateJobResponse' => [ 'type' => 'structure', 'members' => [ 'IotJobArn' => [ 'shape' => '__string', ], 'IotJobId' => [ 'shape' => '__string', ], ], ], 'CreateSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'SubscriptionDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateSubscriptionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], 'Subscriptions' => [ 'shape' => '__listOfSubscription', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'CreateSubscriptionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'DefinitionInformation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'DeleteConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'DeleteConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'DeleteCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'DeleteDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'DeleteFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'DeleteLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'DeleteResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'DeleteSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'Deployment' => [ 'type' => 'structure', 'members' => [ 'CreatedAt' => [ 'shape' => '__string', ], 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'GroupArn' => [ 'shape' => '__string', ], ], ], 'DeploymentType' => [ 'type' => 'string', 'enum' => [ 'NewDeployment', 'Redeployment', 'ResetDeployment', 'ForceResetDeployment', ], ], 'Deployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Deployment', ], ], 'Device' => [ 'type' => 'structure', 'members' => [ 'CertificateArn' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'SyncShadow' => [ 'shape' => '__boolean', ], 'ThingArn' => [ 'shape' => '__string', ], ], 'required' => [], ], 'DeviceDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => '__listOfDevice', ], ], ], 'DisassociateRoleFromGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'DisassociateRoleFromGroupResponse' => [ 'type' => 'structure', 'members' => [ 'DisassociatedAt' => [ 'shape' => '__string', ], ], ], 'DisassociateServiceRoleFromAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateServiceRoleFromAccountResponse' => [ 'type' => 'structure', 'members' => [ 'DisassociatedAt' => [ 'shape' => '__string', ], ], ], 'Empty' => [ 'type' => 'structure', 'members' => [], ], 'EncodingType' => [ 'type' => 'string', 'enum' => [ 'binary', 'json', ], ], 'ErrorDetail' => [ 'type' => 'structure', 'members' => [ 'DetailedErrorCode' => [ 'shape' => '__string', ], 'DetailedErrorMessage' => [ 'shape' => '__string', ], ], ], 'ErrorDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ErrorDetail', ], ], 'Function' => [ 'type' => 'structure', 'members' => [ 'FunctionArn' => [ 'shape' => '__string', ], 'FunctionConfiguration' => [ 'shape' => 'FunctionConfiguration', ], 'Id' => [ 'shape' => '__string', ], ], 'required' => [], ], 'FunctionConfiguration' => [ 'type' => 'structure', 'members' => [ 'EncodingType' => [ 'shape' => 'EncodingType', ], 'Environment' => [ 'shape' => 'FunctionConfigurationEnvironment', ], 'ExecArgs' => [ 'shape' => '__string', ], 'Executable' => [ 'shape' => '__string', ], 'MemorySize' => [ 'shape' => '__integer', ], 'Pinned' => [ 'shape' => '__boolean', ], 'Timeout' => [ 'shape' => '__integer', ], ], ], 'FunctionConfigurationEnvironment' => [ 'type' => 'structure', 'members' => [ 'AccessSysfs' => [ 'shape' => '__boolean', ], 'Execution' => [ 'shape' => 'FunctionExecutionConfig', ], 'ResourceAccessPolicies' => [ 'shape' => '__listOfResourceAccessPolicy', ], 'Variables' => [ 'shape' => '__mapOf__string', ], ], ], 'FunctionDefaultConfig' => [ 'type' => 'structure', 'members' => [ 'Execution' => [ 'shape' => 'FunctionDefaultExecutionConfig', ], ], ], 'FunctionDefaultExecutionConfig' => [ 'type' => 'structure', 'members' => [ 'IsolationMode' => [ 'shape' => 'FunctionIsolationMode', ], ], ], 'FunctionDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'DefaultConfig' => [ 'shape' => 'FunctionDefaultConfig', ], 'Functions' => [ 'shape' => '__listOfFunction', ], ], ], 'FunctionExecutionConfig' => [ 'type' => 'structure', 'members' => [ 'IsolationMode' => [ 'shape' => 'FunctionIsolationMode', ], 'RunAs' => [ 'shape' => 'FunctionRunAsConfig', ], ], ], 'FunctionIsolationMode' => [ 'type' => 'string', 'enum' => [ 'GreengrassContainer', 'NoContainer', ], ], 'FunctionRunAsConfig' => [ 'type' => 'structure', 'members' => [ 'Gid' => [ 'shape' => '__integer', ], 'Uid' => [ 'shape' => '__integer', ], ], ], 'GeneralError' => [ 'type' => 'structure', 'members' => [ 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'Message' => [ 'shape' => '__string', ], ], ], 'GetAssociatedRoleRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'GetAssociatedRoleResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], 'RoleArn' => [ 'shape' => '__string', ], ], ], 'GetBulkDeploymentStatusRequest' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'BulkDeploymentId', ], ], 'required' => [ 'BulkDeploymentId', ], ], 'GetBulkDeploymentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentMetrics' => [ 'shape' => 'BulkDeploymentMetrics', ], 'BulkDeploymentStatus' => [ 'shape' => 'BulkDeploymentStatus', ], 'CreatedAt' => [ 'shape' => '__string', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'ErrorMessage' => [ 'shape' => '__string', ], ], ], 'GetConnectivityInfoRequest' => [ 'type' => 'structure', 'members' => [ 'ThingName' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ThingName', ], ], 'required' => [ 'ThingName', ], ], 'GetConnectivityInfoResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectivityInfo' => [ 'shape' => '__listOfConnectivityInfo', ], 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'GetConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'GetConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetConnectorDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'ConnectorDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'ConnectorDefinitionId', 'ConnectorDefinitionVersionId', ], ], 'GetConnectorDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'ConnectorDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'GetCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetCoreDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'CoreDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionVersionId', ], ], 'required' => [ 'CoreDefinitionId', 'CoreDefinitionVersionId', ], ], 'GetCoreDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'CoreDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetDeploymentStatusRequest' => [ 'type' => 'structure', 'members' => [ 'DeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeploymentId', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', 'DeploymentId', ], ], 'GetDeploymentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'DeploymentStatus' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'ErrorMessage' => [ 'shape' => '__string', ], 'UpdatedAt' => [ 'shape' => '__string', ], ], ], 'GetDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'GetDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetDeviceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'DeviceDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'DeviceDefinitionVersionId', 'DeviceDefinitionId', ], ], 'GetDeviceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'DeviceDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'GetFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetFunctionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'FunctionDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'FunctionDefinitionId', 'FunctionDefinitionVersionId', ], ], 'GetFunctionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'FunctionDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetGroupCertificateAuthorityRequest' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CertificateAuthorityId', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'CertificateAuthorityId', 'GroupId', ], ], 'GetGroupCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorityArn' => [ 'shape' => '__string', ], 'GroupCertificateAuthorityId' => [ 'shape' => '__string', ], 'PemEncodedCertificate' => [ 'shape' => '__string', ], ], ], 'GetGroupCertificateConfigurationRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'GetGroupCertificateConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityExpiryInMilliseconds' => [ 'shape' => '__string', ], 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', ], ], ], 'GetGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'GetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetGroupVersionRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'GroupVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupVersionId', ], ], 'required' => [ 'GroupVersionId', 'GroupId', ], ], 'GetGroupVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'GroupVersion', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'GetLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetLoggerDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'LoggerDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'LoggerDefinitionVersionId', 'LoggerDefinitionId', ], ], 'GetLoggerDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'LoggerDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'GetResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetResourceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], 'ResourceDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionVersionId', ], ], 'required' => [ 'ResourceDefinitionVersionId', 'ResourceDefinitionId', ], ], 'GetResourceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'ResourceDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetServiceRoleForAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetServiceRoleForAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], 'RoleArn' => [ 'shape' => '__string', ], ], ], 'GetSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'GetSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetSubscriptionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], 'SubscriptionDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionVersionId', ], ], 'required' => [ 'SubscriptionDefinitionId', 'SubscriptionDefinitionVersionId', ], ], 'GetSubscriptionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'SubscriptionDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GroupCertificateAuthorityProperties' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorityArn' => [ 'shape' => '__string', ], 'GroupCertificateAuthorityId' => [ 'shape' => '__string', ], ], ], 'GroupCertificateConfiguration' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityExpiryInMilliseconds' => [ 'shape' => '__string', ], 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', ], ], ], 'GroupInformation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GroupOwnerSetting' => [ 'type' => 'structure', 'members' => [ 'AutoAddGroupOwner' => [ 'shape' => '__boolean', ], 'GroupOwner' => [ 'shape' => '__string', ], ], ], 'GroupVersion' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionVersionArn' => [ 'shape' => '__string', ], 'CoreDefinitionVersionArn' => [ 'shape' => '__string', ], 'DeviceDefinitionVersionArn' => [ 'shape' => '__string', ], 'FunctionDefinitionVersionArn' => [ 'shape' => '__string', ], 'LoggerDefinitionVersionArn' => [ 'shape' => '__string', ], 'ResourceDefinitionVersionArn' => [ 'shape' => '__string', ], 'SubscriptionDefinitionVersionArn' => [ 'shape' => '__string', ], ], ], 'InternalServerErrorException' => [ 'type' => 'structure', 'members' => [ 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'Message' => [ 'shape' => '__string', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 500, ], ], 'ListBulkDeploymentDetailedReportsRequest' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'BulkDeploymentId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'BulkDeploymentId', ], ], 'ListBulkDeploymentDetailedReportsResponse' => [ 'type' => 'structure', 'members' => [ 'Deployments' => [ 'shape' => 'BulkDeploymentResults', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListBulkDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListBulkDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'BulkDeployments' => [ 'shape' => 'BulkDeployments', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListConnectorDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'ListConnectorDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListConnectorDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListConnectorDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListCoreDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'ListCoreDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListCoreDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListCoreDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'GroupId', ], ], 'ListDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'Deployments' => [ 'shape' => 'Deployments', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListDeviceDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'ListDeviceDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListDeviceDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListDeviceDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListFunctionDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'ListFunctionDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListFunctionDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListFunctionDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListGroupCertificateAuthoritiesRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'ListGroupCertificateAuthoritiesResponse' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorities' => [ 'shape' => '__listOfGroupCertificateAuthorityProperties', ], ], ], 'ListGroupVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'GroupId', ], ], 'ListGroupVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => '__listOfGroupInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListLoggerDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'ListLoggerDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListLoggerDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListLoggerDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListResourceDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'ListResourceDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListResourceDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListResourceDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListSubscriptionDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'ListSubscriptionDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListSubscriptionDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListSubscriptionDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'LocalDeviceResourceData' => [ 'type' => 'structure', 'members' => [ 'GroupOwnerSetting' => [ 'shape' => 'GroupOwnerSetting', ], 'SourcePath' => [ 'shape' => '__string', ], ], ], 'LocalVolumeResourceData' => [ 'type' => 'structure', 'members' => [ 'DestinationPath' => [ 'shape' => '__string', ], 'GroupOwnerSetting' => [ 'shape' => 'GroupOwnerSetting', ], 'SourcePath' => [ 'shape' => '__string', ], ], ], 'Logger' => [ 'type' => 'structure', 'members' => [ 'Component' => [ 'shape' => 'LoggerComponent', ], 'Id' => [ 'shape' => '__string', ], 'Level' => [ 'shape' => 'LoggerLevel', ], 'Space' => [ 'shape' => '__integer', ], 'Type' => [ 'shape' => 'LoggerType', ], ], 'required' => [], ], 'LoggerComponent' => [ 'type' => 'string', 'enum' => [ 'GreengrassSystem', 'Lambda', ], ], 'LoggerDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Loggers' => [ 'shape' => '__listOfLogger', ], ], ], 'LoggerLevel' => [ 'type' => 'string', 'enum' => [ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', ], ], 'LoggerType' => [ 'type' => 'string', 'enum' => [ 'FileSystem', 'AWSCloudWatch', ], ], 'Permission' => [ 'type' => 'string', 'enum' => [ 'ro', 'rw', ], ], 'ResetDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'Force' => [ 'shape' => '__boolean', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'ResetDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], ], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], 'ResourceDataContainer' => [ 'shape' => 'ResourceDataContainer', ], ], 'required' => [], ], 'ResourceAccessPolicy' => [ 'type' => 'structure', 'members' => [ 'Permission' => [ 'shape' => 'Permission', ], 'ResourceId' => [ 'shape' => '__string', ], ], 'required' => [], ], 'ResourceDataContainer' => [ 'type' => 'structure', 'members' => [ 'LocalDeviceResourceData' => [ 'shape' => 'LocalDeviceResourceData', ], 'LocalVolumeResourceData' => [ 'shape' => 'LocalVolumeResourceData', ], 'S3MachineLearningModelResourceData' => [ 'shape' => 'S3MachineLearningModelResourceData', ], 'SageMakerMachineLearningModelResourceData' => [ 'shape' => 'SageMakerMachineLearningModelResourceData', ], 'SecretsManagerSecretResourceData' => [ 'shape' => 'SecretsManagerSecretResourceData', ], ], ], 'ResourceDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Resources' => [ 'shape' => '__listOfResource', ], ], ], 'S3MachineLearningModelResourceData' => [ 'type' => 'structure', 'members' => [ 'DestinationPath' => [ 'shape' => '__string', ], 'S3Uri' => [ 'shape' => '__string', ], ], ], 'S3UrlSignerRole' => [ 'type' => 'string', ], 'SageMakerMachineLearningModelResourceData' => [ 'type' => 'structure', 'members' => [ 'DestinationPath' => [ 'shape' => '__string', ], 'SageMakerJobArn' => [ 'shape' => '__string', ], ], ], 'SecretsManagerSecretResourceData' => [ 'type' => 'structure', 'members' => [ 'ARN' => [ 'shape' => '__string', ], 'AdditionalStagingLabelsToDownload' => [ 'shape' => '__listOf__string', ], ], ], 'SoftwareToUpdate' => [ 'type' => 'string', 'enum' => [ 'core', 'ota_agent', ], ], 'StartBulkDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ExecutionRoleArn' => [ 'shape' => '__string', ], 'InputFileUri' => [ 'shape' => '__string', ], ], ], 'StartBulkDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentArn' => [ 'shape' => '__string', ], 'BulkDeploymentId' => [ 'shape' => '__string', ], ], ], 'StopBulkDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'BulkDeploymentId', ], ], 'required' => [ 'BulkDeploymentId', ], ], 'StopBulkDeploymentResponse' => [ 'type' => 'structure', 'members' => [], ], 'Subscription' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => '__string', ], 'Source' => [ 'shape' => '__string', ], 'Subject' => [ 'shape' => '__string', ], 'Target' => [ 'shape' => '__string', ], ], 'required' => [], ], 'SubscriptionDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Subscriptions' => [ 'shape' => '__listOfSubscription', ], ], ], 'UpdateAgentLogLevel' => [ 'type' => 'string', 'enum' => [ 'NONE', 'TRACE', 'DEBUG', 'VERBOSE', 'INFO', 'WARN', 'ERROR', 'FATAL', ], ], 'UpdateConnectivityInfoRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectivityInfo' => [ 'shape' => '__listOfConnectivityInfo', ], 'ThingName' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ThingName', ], ], 'required' => [ 'ThingName', ], ], 'UpdateConnectivityInfoResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], 'Version' => [ 'shape' => '__string', ], ], ], 'UpdateConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'UpdateConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'UpdateCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'UpdateDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'UpdateFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateGroupCertificateConfigurationRequest' => [ 'type' => 'structure', 'members' => [ 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'UpdateGroupCertificateConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityExpiryInMilliseconds' => [ 'shape' => '__string', ], 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', ], ], ], 'UpdateGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'UpdateGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'UpdateLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__string', ], 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'UpdateResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__string', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'UpdateSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateTargets' => [ 'type' => 'list', 'member' => [ 'shape' => '__string', ], ], 'UpdateTargetsArchitecture' => [ 'type' => 'string', 'enum' => [ 'armv7l', 'x86_64', 'aarch64', ], ], 'UpdateTargetsOperatingSystem' => [ 'type' => 'string', 'enum' => [ 'ubuntu', 'raspbian', 'amazon_linux', ], ], 'VersionInformation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], '__boolean' => [ 'type' => 'boolean', ], '__double' => [ 'type' => 'double', ], '__integer' => [ 'type' => 'integer', ], '__listOfConnectivityInfo' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectivityInfo', ], ], '__listOfConnector' => [ 'type' => 'list', 'member' => [ 'shape' => 'Connector', ], ], '__listOfCore' => [ 'type' => 'list', 'member' => [ 'shape' => 'Core', ], ], '__listOfDefinitionInformation' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefinitionInformation', ], ], '__listOfDevice' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], '__listOfFunction' => [ 'type' => 'list', 'member' => [ 'shape' => 'Function', ], ], '__listOfGroupCertificateAuthorityProperties' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupCertificateAuthorityProperties', ], ], '__listOfGroupInformation' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupInformation', ], ], '__listOfLogger' => [ 'type' => 'list', 'member' => [ 'shape' => 'Logger', ], ], '__listOfResource' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], '__listOfResourceAccessPolicy' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceAccessPolicy', ], ], '__listOfSubscription' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subscription', ], ], '__listOfVersionInformation' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionInformation', ], ], '__listOf__string' => [ 'type' => 'list', 'member' => [ 'shape' => '__string', ], ], '__long' => [ 'type' => 'long', ], '__mapOf__string' => [ 'type' => 'map', 'key' => [ 'shape' => '__string', ], 'value' => [ 'shape' => '__string', ], ], '__string' => [ 'type' => 'string', ], '__timestampIso8601' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], '__timestampUnix' => [ 'type' => 'timestamp', 'timestampFormat' => 'unixTimestamp', ], ],]; +return [ 'metadata' => [ 'apiVersion' => '2017-06-07', 'endpointPrefix' => 'greengrass', 'signingName' => 'greengrass', 'serviceFullName' => 'AWS Greengrass', 'serviceId' => 'Greengrass', 'protocol' => 'rest-json', 'jsonVersion' => '1.1', 'uid' => 'greengrass-2017-06-07', 'signatureVersion' => 'v4', ], 'operations' => [ 'AssociateRoleToGroup' => [ 'name' => 'AssociateRoleToGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/groups/{GroupId}/role', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociateRoleToGroupRequest', ], 'output' => [ 'shape' => 'AssociateRoleToGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'AssociateServiceRoleToAccount' => [ 'name' => 'AssociateServiceRoleToAccount', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/servicerole', 'responseCode' => 200, ], 'input' => [ 'shape' => 'AssociateServiceRoleToAccountRequest', ], 'output' => [ 'shape' => 'AssociateServiceRoleToAccountResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'CreateConnectorDefinition' => [ 'name' => 'CreateConnectorDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/connectors', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'CreateConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateConnectorDefinitionVersion' => [ 'name' => 'CreateConnectorDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateConnectorDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateConnectorDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateCoreDefinition' => [ 'name' => 'CreateCoreDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/cores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateCoreDefinitionRequest', ], 'output' => [ 'shape' => 'CreateCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateCoreDefinitionVersion' => [ 'name' => 'CreateCoreDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateCoreDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateCoreDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateDeployment' => [ 'name' => 'CreateDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeploymentRequest', ], 'output' => [ 'shape' => 'CreateDeploymentResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateDeviceDefinition' => [ 'name' => 'CreateDeviceDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/devices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateDeviceDefinitionVersion' => [ 'name' => 'CreateDeviceDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeviceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateDeviceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateFunctionDefinition' => [ 'name' => 'CreateFunctionDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/functions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateFunctionDefinitionVersion' => [ 'name' => 'CreateFunctionDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateFunctionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateFunctionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateGroupCertificateAuthority' => [ 'name' => 'CreateGroupCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateGroupCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'CreateGroupCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'CreateGroupVersion' => [ 'name' => 'CreateGroupVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateGroupVersionRequest', ], 'output' => [ 'shape' => 'CreateGroupVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateLoggerDefinition' => [ 'name' => 'CreateLoggerDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/loggers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'CreateLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateLoggerDefinitionVersion' => [ 'name' => 'CreateLoggerDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateLoggerDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateLoggerDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateResourceDefinition' => [ 'name' => 'CreateResourceDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateResourceDefinitionRequest', ], 'output' => [ 'shape' => 'CreateResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateResourceDefinitionVersion' => [ 'name' => 'CreateResourceDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateResourceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateResourceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateSoftwareUpdateJob' => [ 'name' => 'CreateSoftwareUpdateJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/updates', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSoftwareUpdateJobRequest', ], 'output' => [ 'shape' => 'CreateSoftwareUpdateJobResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'CreateSubscriptionDefinition' => [ 'name' => 'CreateSubscriptionDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/subscriptions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'CreateSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'CreateSubscriptionDefinitionVersion' => [ 'name' => 'CreateSubscriptionDefinitionVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateSubscriptionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'CreateSubscriptionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteConnectorDefinition' => [ 'name' => 'DeleteConnectorDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteCoreDefinition' => [ 'name' => 'DeleteCoreDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteCoreDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteDeviceDefinition' => [ 'name' => 'DeleteDeviceDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteFunctionDefinition' => [ 'name' => 'DeleteFunctionDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/groups/{GroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteLoggerDefinition' => [ 'name' => 'DeleteLoggerDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteResourceDefinition' => [ 'name' => 'DeleteResourceDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteResourceDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DeleteSubscriptionDefinition' => [ 'name' => 'DeleteSubscriptionDefinition', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'DisassociateRoleFromGroup' => [ 'name' => 'DisassociateRoleFromGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/groups/{GroupId}/role', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociateRoleFromGroupRequest', ], 'output' => [ 'shape' => 'DisassociateRoleFromGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'DisassociateServiceRoleFromAccount' => [ 'name' => 'DisassociateServiceRoleFromAccount', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/greengrass/servicerole', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DisassociateServiceRoleFromAccountRequest', ], 'output' => [ 'shape' => 'DisassociateServiceRoleFromAccountResponse', ], 'errors' => [ [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetAssociatedRole' => [ 'name' => 'GetAssociatedRole', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/role', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAssociatedRoleRequest', ], 'output' => [ 'shape' => 'GetAssociatedRoleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetBulkDeploymentStatus' => [ 'name' => 'GetBulkDeploymentStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/bulk/deployments/{BulkDeploymentId}/status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetBulkDeploymentStatusRequest', ], 'output' => [ 'shape' => 'GetBulkDeploymentStatusResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetConnectivityInfo' => [ 'name' => 'GetConnectivityInfo', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/things/{ThingName}/connectivityInfo', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetConnectivityInfoRequest', ], 'output' => [ 'shape' => 'GetConnectivityInfoResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetConnectorDefinition' => [ 'name' => 'GetConnectorDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'GetConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetConnectorDefinitionVersion' => [ 'name' => 'GetConnectorDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}/versions/{ConnectorDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetConnectorDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetConnectorDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetCoreDefinition' => [ 'name' => 'GetCoreDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetCoreDefinitionRequest', ], 'output' => [ 'shape' => 'GetCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetCoreDefinitionVersion' => [ 'name' => 'GetCoreDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}/versions/{CoreDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetCoreDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetCoreDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetDeploymentStatus' => [ 'name' => 'GetDeploymentStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/deployments/{DeploymentId}/status', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeploymentStatusRequest', ], 'output' => [ 'shape' => 'GetDeploymentStatusResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetDeviceDefinition' => [ 'name' => 'GetDeviceDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'GetDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetDeviceDefinitionVersion' => [ 'name' => 'GetDeviceDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}/versions/{DeviceDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeviceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetDeviceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetFunctionDefinition' => [ 'name' => 'GetFunctionDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'GetFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetFunctionDefinitionVersion' => [ 'name' => 'GetFunctionDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}/versions/{FunctionDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetFunctionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetGroup' => [ 'name' => 'GetGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupRequest', ], 'output' => [ 'shape' => 'GetGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetGroupCertificateAuthority' => [ 'name' => 'GetGroupCertificateAuthority', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities/{CertificateAuthorityId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'GetGroupCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetGroupCertificateConfiguration' => [ 'name' => 'GetGroupCertificateConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupCertificateConfigurationRequest', ], 'output' => [ 'shape' => 'GetGroupCertificateConfigurationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetGroupVersion' => [ 'name' => 'GetGroupVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/versions/{GroupVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetGroupVersionRequest', ], 'output' => [ 'shape' => 'GetGroupVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetLoggerDefinition' => [ 'name' => 'GetLoggerDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'GetLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetLoggerDefinitionVersion' => [ 'name' => 'GetLoggerDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}/versions/{LoggerDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetLoggerDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetLoggerDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetResourceDefinition' => [ 'name' => 'GetResourceDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetResourceDefinitionRequest', ], 'output' => [ 'shape' => 'GetResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetResourceDefinitionVersion' => [ 'name' => 'GetResourceDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}/versions/{ResourceDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetResourceDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetResourceDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetServiceRoleForAccount' => [ 'name' => 'GetServiceRoleForAccount', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/servicerole', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetServiceRoleForAccountRequest', ], 'output' => [ 'shape' => 'GetServiceRoleForAccountResponse', ], 'errors' => [ [ 'shape' => 'InternalServerErrorException', ], ], ], 'GetSubscriptionDefinition' => [ 'name' => 'GetSubscriptionDefinition', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'GetSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'GetSubscriptionDefinitionVersion' => [ 'name' => 'GetSubscriptionDefinitionVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetSubscriptionDefinitionVersionRequest', ], 'output' => [ 'shape' => 'GetSubscriptionDefinitionVersionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListBulkDeploymentDetailedReports' => [ 'name' => 'ListBulkDeploymentDetailedReports', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/bulk/deployments/{BulkDeploymentId}/detailed-reports', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListBulkDeploymentDetailedReportsRequest', ], 'output' => [ 'shape' => 'ListBulkDeploymentDetailedReportsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListBulkDeployments' => [ 'name' => 'ListBulkDeployments', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/bulk/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListBulkDeploymentsRequest', ], 'output' => [ 'shape' => 'ListBulkDeploymentsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListConnectorDefinitionVersions' => [ 'name' => 'ListConnectorDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListConnectorDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListConnectorDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListConnectorDefinitions' => [ 'name' => 'ListConnectorDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/connectors', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListConnectorDefinitionsRequest', ], 'output' => [ 'shape' => 'ListConnectorDefinitionsResponse', ], 'errors' => [], ], 'ListCoreDefinitionVersions' => [ 'name' => 'ListCoreDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListCoreDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListCoreDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListCoreDefinitions' => [ 'name' => 'ListCoreDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/cores', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListCoreDefinitionsRequest', ], 'output' => [ 'shape' => 'ListCoreDefinitionsResponse', ], 'errors' => [], ], 'ListDeployments' => [ 'name' => 'ListDeployments', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeploymentsRequest', ], 'output' => [ 'shape' => 'ListDeploymentsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListDeviceDefinitionVersions' => [ 'name' => 'ListDeviceDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeviceDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListDeviceDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListDeviceDefinitions' => [ 'name' => 'ListDeviceDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/devices', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeviceDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDeviceDefinitionsResponse', ], 'errors' => [], ], 'ListFunctionDefinitionVersions' => [ 'name' => 'ListFunctionDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFunctionDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListFunctionDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListFunctionDefinitions' => [ 'name' => 'ListFunctionDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/functions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFunctionDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFunctionDefinitionsResponse', ], 'errors' => [], ], 'ListGroupCertificateAuthorities' => [ 'name' => 'ListGroupCertificateAuthorities', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupCertificateAuthoritiesRequest', ], 'output' => [ 'shape' => 'ListGroupCertificateAuthoritiesResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'ListGroupVersions' => [ 'name' => 'ListGroupVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups/{GroupId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupVersionsRequest', ], 'output' => [ 'shape' => 'ListGroupVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/groups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [], ], 'ListLoggerDefinitionVersions' => [ 'name' => 'ListLoggerDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListLoggerDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListLoggerDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListLoggerDefinitions' => [ 'name' => 'ListLoggerDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/loggers', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListLoggerDefinitionsRequest', ], 'output' => [ 'shape' => 'ListLoggerDefinitionsResponse', ], 'errors' => [], ], 'ListResourceDefinitionVersions' => [ 'name' => 'ListResourceDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListResourceDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListResourceDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListResourceDefinitions' => [ 'name' => 'ListResourceDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/resources', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListResourceDefinitionsRequest', ], 'output' => [ 'shape' => 'ListResourceDefinitionsResponse', ], 'errors' => [], ], 'ListSubscriptionDefinitionVersions' => [ 'name' => 'ListSubscriptionDefinitionVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSubscriptionDefinitionVersionsRequest', ], 'output' => [ 'shape' => 'ListSubscriptionDefinitionVersionsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'ListSubscriptionDefinitions' => [ 'name' => 'ListSubscriptionDefinitions', 'http' => [ 'method' => 'GET', 'requestUri' => '/greengrass/definition/subscriptions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListSubscriptionDefinitionsRequest', ], 'output' => [ 'shape' => 'ListSubscriptionDefinitionsResponse', ], 'errors' => [], ], 'ResetDeployments' => [ 'name' => 'ResetDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/groups/{GroupId}/deployments/$reset', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ResetDeploymentsRequest', ], 'output' => [ 'shape' => 'ResetDeploymentsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'StartBulkDeployment' => [ 'name' => 'StartBulkDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/greengrass/bulk/deployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartBulkDeploymentRequest', ], 'output' => [ 'shape' => 'StartBulkDeploymentResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'StopBulkDeployment' => [ 'name' => 'StopBulkDeployment', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/bulk/deployments/{BulkDeploymentId}/$stop', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StopBulkDeploymentRequest', ], 'output' => [ 'shape' => 'StopBulkDeploymentResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateConnectivityInfo' => [ 'name' => 'UpdateConnectivityInfo', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/things/{ThingName}/connectivityInfo', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateConnectivityInfoRequest', ], 'output' => [ 'shape' => 'UpdateConnectivityInfoResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'UpdateConnectorDefinition' => [ 'name' => 'UpdateConnectorDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/connectors/{ConnectorDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateConnectorDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateConnectorDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateCoreDefinition' => [ 'name' => 'UpdateCoreDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/cores/{CoreDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateCoreDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateCoreDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateDeviceDefinition' => [ 'name' => 'UpdateDeviceDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/devices/{DeviceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateDeviceDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateDeviceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateFunctionDefinition' => [ 'name' => 'UpdateFunctionDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/functions/{FunctionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateFunctionDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateFunctionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateGroup' => [ 'name' => 'UpdateGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/groups/{GroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateGroupRequest', ], 'output' => [ 'shape' => 'UpdateGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateGroupCertificateConfiguration' => [ 'name' => 'UpdateGroupCertificateConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateGroupCertificateConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateGroupCertificateConfigurationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], ], ], 'UpdateLoggerDefinition' => [ 'name' => 'UpdateLoggerDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/loggers/{LoggerDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateLoggerDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateLoggerDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateResourceDefinition' => [ 'name' => 'UpdateResourceDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/resources/{ResourceDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateResourceDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateResourceDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], 'UpdateSubscriptionDefinition' => [ 'name' => 'UpdateSubscriptionDefinition', 'http' => [ 'method' => 'PUT', 'requestUri' => '/greengrass/definition/subscriptions/{SubscriptionDefinitionId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateSubscriptionDefinitionRequest', ], 'output' => [ 'shape' => 'UpdateSubscriptionDefinitionResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], ], ], ], 'shapes' => [ 'AssociateRoleToGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'RoleArn' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'AssociateRoleToGroupResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], ], ], 'AssociateServiceRoleToAccountRequest' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => '__string', ], ], ], 'AssociateServiceRoleToAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], ], ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [ 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'Message' => [ 'shape' => '__string', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 400, ], ], 'BulkDeployment' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentArn' => [ 'shape' => '__string', ], 'BulkDeploymentId' => [ 'shape' => '__string', ], 'CreatedAt' => [ 'shape' => '__string', ], ], ], 'BulkDeploymentMetrics' => [ 'type' => 'structure', 'members' => [ 'InvalidInputRecords' => [ 'shape' => '__integer', ], 'RecordsProcessed' => [ 'shape' => '__integer', ], 'RetryAttempts' => [ 'shape' => '__integer', ], ], ], 'BulkDeploymentResult' => [ 'type' => 'structure', 'members' => [ 'CreatedAt' => [ 'shape' => '__string', ], 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], 'DeploymentStatus' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'ErrorMessage' => [ 'shape' => '__string', ], 'GroupArn' => [ 'shape' => '__string', ], ], ], 'BulkDeploymentResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'BulkDeploymentResult', ], ], 'BulkDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Running', 'Completed', 'Stopping', 'Stopped', 'Failed', ], ], 'BulkDeployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'BulkDeployment', ], ], 'ConnectivityInfo' => [ 'type' => 'structure', 'members' => [ 'HostAddress' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Metadata' => [ 'shape' => '__string', ], 'PortNumber' => [ 'shape' => '__integer', ], ], ], 'Connector' => [ 'type' => 'structure', 'members' => [ 'ConnectorArn' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Parameters' => [ 'shape' => '__mapOf__string', ], ], 'required' => [], ], 'ConnectorDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Connectors' => [ 'shape' => '__listOfConnector', ], ], ], 'Core' => [ 'type' => 'structure', 'members' => [ 'CertificateArn' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'SyncShadow' => [ 'shape' => '__boolean', ], 'ThingArn' => [ 'shape' => '__string', ], ], 'required' => [], ], 'CoreDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Cores' => [ 'shape' => '__listOfCore', ], ], ], 'CreateConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'ConnectorDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateConnectorDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'Connectors' => [ 'shape' => '__listOfConnector', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'CreateConnectorDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'CoreDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateCoreDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'Cores' => [ 'shape' => '__listOfCore', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'CreateCoreDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'DeploymentId' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'GroupVersionId' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'CreateDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], ], ], 'CreateDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'DeviceDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateDeviceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'Devices' => [ 'shape' => '__listOfDevice', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'CreateDeviceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'FunctionDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateFunctionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'DefaultConfig' => [ 'shape' => 'FunctionDefaultConfig', ], 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'Functions' => [ 'shape' => '__listOfFunction', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'CreateFunctionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateGroupCertificateAuthorityRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'CreateGroupCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorityArn' => [ 'shape' => '__string', ], ], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'GroupVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateGroupVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ConnectorDefinitionVersionArn' => [ 'shape' => '__string', ], 'CoreDefinitionVersionArn' => [ 'shape' => '__string', ], 'DeviceDefinitionVersionArn' => [ 'shape' => '__string', ], 'FunctionDefinitionVersionArn' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'LoggerDefinitionVersionArn' => [ 'shape' => '__string', ], 'ResourceDefinitionVersionArn' => [ 'shape' => '__string', ], 'SubscriptionDefinitionVersionArn' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'CreateGroupVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'LoggerDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateLoggerDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'Loggers' => [ 'shape' => '__listOfLogger', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'CreateLoggerDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'ResourceDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateResourceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], 'Resources' => [ 'shape' => '__listOfResource', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'CreateResourceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'CreateSoftwareUpdateJobRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'S3UrlSignerRole' => [ 'shape' => 'S3UrlSignerRole', ], 'SoftwareToUpdate' => [ 'shape' => 'SoftwareToUpdate', ], 'UpdateAgentLogLevel' => [ 'shape' => 'UpdateAgentLogLevel', ], 'UpdateTargets' => [ 'shape' => 'UpdateTargets', ], 'UpdateTargetsArchitecture' => [ 'shape' => 'UpdateTargetsArchitecture', ], 'UpdateTargetsOperatingSystem' => [ 'shape' => 'UpdateTargetsOperatingSystem', ], ], ], 'CreateSoftwareUpdateJobResponse' => [ 'type' => 'structure', 'members' => [ 'IotJobArn' => [ 'shape' => '__string', ], 'IotJobId' => [ 'shape' => '__string', ], ], ], 'CreateSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'InitialVersion' => [ 'shape' => 'SubscriptionDefinitionVersion', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'CreateSubscriptionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], 'Subscriptions' => [ 'shape' => '__listOfSubscription', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'CreateSubscriptionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'DefinitionInformation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'DeleteConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'DeleteConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'DeleteCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'DeleteDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'DeleteFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'DeleteLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'DeleteResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'DeleteSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'Deployment' => [ 'type' => 'structure', 'members' => [ 'CreatedAt' => [ 'shape' => '__string', ], 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'GroupArn' => [ 'shape' => '__string', ], ], ], 'DeploymentType' => [ 'type' => 'string', 'enum' => [ 'NewDeployment', 'Redeployment', 'ResetDeployment', 'ForceResetDeployment', ], ], 'Deployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Deployment', ], ], 'Device' => [ 'type' => 'structure', 'members' => [ 'CertificateArn' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'SyncShadow' => [ 'shape' => '__boolean', ], 'ThingArn' => [ 'shape' => '__string', ], ], 'required' => [], ], 'DeviceDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => '__listOfDevice', ], ], ], 'DisassociateRoleFromGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'DisassociateRoleFromGroupResponse' => [ 'type' => 'structure', 'members' => [ 'DisassociatedAt' => [ 'shape' => '__string', ], ], ], 'DisassociateServiceRoleFromAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateServiceRoleFromAccountResponse' => [ 'type' => 'structure', 'members' => [ 'DisassociatedAt' => [ 'shape' => '__string', ], ], ], 'Empty' => [ 'type' => 'structure', 'members' => [], ], 'EncodingType' => [ 'type' => 'string', 'enum' => [ 'binary', 'json', ], ], 'ErrorDetail' => [ 'type' => 'structure', 'members' => [ 'DetailedErrorCode' => [ 'shape' => '__string', ], 'DetailedErrorMessage' => [ 'shape' => '__string', ], ], ], 'ErrorDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ErrorDetail', ], ], 'Function' => [ 'type' => 'structure', 'members' => [ 'FunctionArn' => [ 'shape' => '__string', ], 'FunctionConfiguration' => [ 'shape' => 'FunctionConfiguration', ], 'Id' => [ 'shape' => '__string', ], ], 'required' => [], ], 'FunctionConfiguration' => [ 'type' => 'structure', 'members' => [ 'EncodingType' => [ 'shape' => 'EncodingType', ], 'Environment' => [ 'shape' => 'FunctionConfigurationEnvironment', ], 'ExecArgs' => [ 'shape' => '__string', ], 'Executable' => [ 'shape' => '__string', ], 'MemorySize' => [ 'shape' => '__integer', ], 'Pinned' => [ 'shape' => '__boolean', ], 'Timeout' => [ 'shape' => '__integer', ], ], ], 'FunctionConfigurationEnvironment' => [ 'type' => 'structure', 'members' => [ 'AccessSysfs' => [ 'shape' => '__boolean', ], 'Execution' => [ 'shape' => 'FunctionExecutionConfig', ], 'ResourceAccessPolicies' => [ 'shape' => '__listOfResourceAccessPolicy', ], 'Variables' => [ 'shape' => '__mapOf__string', ], ], ], 'FunctionDefaultConfig' => [ 'type' => 'structure', 'members' => [ 'Execution' => [ 'shape' => 'FunctionDefaultExecutionConfig', ], ], ], 'FunctionDefaultExecutionConfig' => [ 'type' => 'structure', 'members' => [ 'IsolationMode' => [ 'shape' => 'FunctionIsolationMode', ], 'RunAs' => [ 'shape' => 'FunctionRunAsConfig', ], ], ], 'FunctionDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'DefaultConfig' => [ 'shape' => 'FunctionDefaultConfig', ], 'Functions' => [ 'shape' => '__listOfFunction', ], ], ], 'FunctionExecutionConfig' => [ 'type' => 'structure', 'members' => [ 'IsolationMode' => [ 'shape' => 'FunctionIsolationMode', ], 'RunAs' => [ 'shape' => 'FunctionRunAsConfig', ], ], ], 'FunctionIsolationMode' => [ 'type' => 'string', 'enum' => [ 'GreengrassContainer', 'NoContainer', ], ], 'FunctionRunAsConfig' => [ 'type' => 'structure', 'members' => [ 'Gid' => [ 'shape' => '__integer', ], 'Uid' => [ 'shape' => '__integer', ], ], ], 'GeneralError' => [ 'type' => 'structure', 'members' => [ 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'Message' => [ 'shape' => '__string', ], ], ], 'GetAssociatedRoleRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'GetAssociatedRoleResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], 'RoleArn' => [ 'shape' => '__string', ], ], ], 'GetBulkDeploymentStatusRequest' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'BulkDeploymentId', ], ], 'required' => [ 'BulkDeploymentId', ], ], 'GetBulkDeploymentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentMetrics' => [ 'shape' => 'BulkDeploymentMetrics', ], 'BulkDeploymentStatus' => [ 'shape' => 'BulkDeploymentStatus', ], 'CreatedAt' => [ 'shape' => '__string', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'ErrorMessage' => [ 'shape' => '__string', ], ], ], 'GetConnectivityInfoRequest' => [ 'type' => 'structure', 'members' => [ 'ThingName' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ThingName', ], ], 'required' => [ 'ThingName', ], ], 'GetConnectivityInfoResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectivityInfo' => [ 'shape' => '__listOfConnectivityInfo', ], 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'GetConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'GetConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetConnectorDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'ConnectorDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'ConnectorDefinitionId', 'ConnectorDefinitionVersionId', ], ], 'GetConnectorDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'ConnectorDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'GetCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetCoreDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'CoreDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionVersionId', ], ], 'required' => [ 'CoreDefinitionId', 'CoreDefinitionVersionId', ], ], 'GetCoreDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'CoreDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetDeploymentStatusRequest' => [ 'type' => 'structure', 'members' => [ 'DeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeploymentId', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', 'DeploymentId', ], ], 'GetDeploymentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'DeploymentStatus' => [ 'shape' => '__string', ], 'DeploymentType' => [ 'shape' => 'DeploymentType', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'ErrorMessage' => [ 'shape' => '__string', ], 'UpdatedAt' => [ 'shape' => '__string', ], ], ], 'GetDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'GetDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetDeviceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'DeviceDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'DeviceDefinitionVersionId', 'DeviceDefinitionId', ], ], 'GetDeviceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'DeviceDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'GetFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetFunctionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'FunctionDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'FunctionDefinitionId', 'FunctionDefinitionVersionId', ], ], 'GetFunctionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'FunctionDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetGroupCertificateAuthorityRequest' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CertificateAuthorityId', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'CertificateAuthorityId', 'GroupId', ], ], 'GetGroupCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorityArn' => [ 'shape' => '__string', ], 'GroupCertificateAuthorityId' => [ 'shape' => '__string', ], 'PemEncodedCertificate' => [ 'shape' => '__string', ], ], ], 'GetGroupCertificateConfigurationRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'GetGroupCertificateConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityExpiryInMilliseconds' => [ 'shape' => '__string', ], 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', ], ], ], 'GetGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'GetGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetGroupVersionRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'GroupVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupVersionId', ], ], 'required' => [ 'GroupVersionId', 'GroupId', ], ], 'GetGroupVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'GroupVersion', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'GetLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetLoggerDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'LoggerDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionVersionId', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'LoggerDefinitionVersionId', 'LoggerDefinitionId', ], ], 'GetLoggerDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'LoggerDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'GetResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetResourceDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], 'ResourceDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionVersionId', ], ], 'required' => [ 'ResourceDefinitionVersionId', 'ResourceDefinitionId', ], ], 'GetResourceDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'ResourceDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GetServiceRoleForAccountRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetServiceRoleForAccountResponse' => [ 'type' => 'structure', 'members' => [ 'AssociatedAt' => [ 'shape' => '__string', ], 'RoleArn' => [ 'shape' => '__string', ], ], ], 'GetSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'GetSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GetSubscriptionDefinitionVersionRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], 'SubscriptionDefinitionVersionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionVersionId', ], ], 'required' => [ 'SubscriptionDefinitionId', 'SubscriptionDefinitionVersionId', ], ], 'GetSubscriptionDefinitionVersionResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Definition' => [ 'shape' => 'SubscriptionDefinitionVersion', ], 'Id' => [ 'shape' => '__string', ], 'NextToken' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], 'GroupCertificateAuthorityProperties' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorityArn' => [ 'shape' => '__string', ], 'GroupCertificateAuthorityId' => [ 'shape' => '__string', ], ], ], 'GroupCertificateConfiguration' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityExpiryInMilliseconds' => [ 'shape' => '__string', ], 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', ], ], ], 'GroupInformation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'LastUpdatedTimestamp' => [ 'shape' => '__string', ], 'LatestVersion' => [ 'shape' => '__string', ], 'LatestVersionArn' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], ], ], 'GroupOwnerSetting' => [ 'type' => 'structure', 'members' => [ 'AutoAddGroupOwner' => [ 'shape' => '__boolean', ], 'GroupOwner' => [ 'shape' => '__string', ], ], ], 'GroupVersion' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionVersionArn' => [ 'shape' => '__string', ], 'CoreDefinitionVersionArn' => [ 'shape' => '__string', ], 'DeviceDefinitionVersionArn' => [ 'shape' => '__string', ], 'FunctionDefinitionVersionArn' => [ 'shape' => '__string', ], 'LoggerDefinitionVersionArn' => [ 'shape' => '__string', ], 'ResourceDefinitionVersionArn' => [ 'shape' => '__string', ], 'SubscriptionDefinitionVersionArn' => [ 'shape' => '__string', ], ], ], 'InternalServerErrorException' => [ 'type' => 'structure', 'members' => [ 'ErrorDetails' => [ 'shape' => 'ErrorDetails', ], 'Message' => [ 'shape' => '__string', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 500, ], ], 'ListBulkDeploymentDetailedReportsRequest' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'BulkDeploymentId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'BulkDeploymentId', ], ], 'ListBulkDeploymentDetailedReportsResponse' => [ 'type' => 'structure', 'members' => [ 'Deployments' => [ 'shape' => 'BulkDeploymentResults', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListBulkDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListBulkDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'BulkDeployments' => [ 'shape' => 'BulkDeployments', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListConnectorDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'ListConnectorDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListConnectorDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListConnectorDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListCoreDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'ListCoreDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListCoreDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListCoreDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'GroupId', ], ], 'ListDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'Deployments' => [ 'shape' => 'Deployments', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListDeviceDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'ListDeviceDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListDeviceDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListDeviceDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListFunctionDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'ListFunctionDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListFunctionDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListFunctionDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListGroupCertificateAuthoritiesRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'ListGroupCertificateAuthoritiesResponse' => [ 'type' => 'structure', 'members' => [ 'GroupCertificateAuthorities' => [ 'shape' => '__listOfGroupCertificateAuthorityProperties', ], ], ], 'ListGroupVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'GroupId', ], ], 'ListGroupVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => '__listOfGroupInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListLoggerDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'ListLoggerDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListLoggerDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListLoggerDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListResourceDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'ListResourceDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListResourceDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListResourceDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListSubscriptionDefinitionVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'ListSubscriptionDefinitionVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'ListSubscriptionDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'MaxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'NextToken', ], ], ], 'ListSubscriptionDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'Definitions' => [ 'shape' => '__listOfDefinitionInformation', ], 'NextToken' => [ 'shape' => '__string', ], ], ], 'ListVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', ], 'Versions' => [ 'shape' => '__listOfVersionInformation', ], ], ], 'LocalDeviceResourceData' => [ 'type' => 'structure', 'members' => [ 'GroupOwnerSetting' => [ 'shape' => 'GroupOwnerSetting', ], 'SourcePath' => [ 'shape' => '__string', ], ], ], 'LocalVolumeResourceData' => [ 'type' => 'structure', 'members' => [ 'DestinationPath' => [ 'shape' => '__string', ], 'GroupOwnerSetting' => [ 'shape' => 'GroupOwnerSetting', ], 'SourcePath' => [ 'shape' => '__string', ], ], ], 'Logger' => [ 'type' => 'structure', 'members' => [ 'Component' => [ 'shape' => 'LoggerComponent', ], 'Id' => [ 'shape' => '__string', ], 'Level' => [ 'shape' => 'LoggerLevel', ], 'Space' => [ 'shape' => '__integer', ], 'Type' => [ 'shape' => 'LoggerType', ], ], 'required' => [], ], 'LoggerComponent' => [ 'type' => 'string', 'enum' => [ 'GreengrassSystem', 'Lambda', ], ], 'LoggerDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Loggers' => [ 'shape' => '__listOfLogger', ], ], ], 'LoggerLevel' => [ 'type' => 'string', 'enum' => [ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', ], ], 'LoggerType' => [ 'type' => 'string', 'enum' => [ 'FileSystem', 'AWSCloudWatch', ], ], 'Permission' => [ 'type' => 'string', 'enum' => [ 'ro', 'rw', ], ], 'ResetDeploymentsRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'Force' => [ 'shape' => '__boolean', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'ResetDeploymentsResponse' => [ 'type' => 'structure', 'members' => [ 'DeploymentArn' => [ 'shape' => '__string', ], 'DeploymentId' => [ 'shape' => '__string', ], ], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => '__string', ], 'Name' => [ 'shape' => '__string', ], 'ResourceDataContainer' => [ 'shape' => 'ResourceDataContainer', ], ], 'required' => [], ], 'ResourceAccessPolicy' => [ 'type' => 'structure', 'members' => [ 'Permission' => [ 'shape' => 'Permission', ], 'ResourceId' => [ 'shape' => '__string', ], ], 'required' => [], ], 'ResourceDataContainer' => [ 'type' => 'structure', 'members' => [ 'LocalDeviceResourceData' => [ 'shape' => 'LocalDeviceResourceData', ], 'LocalVolumeResourceData' => [ 'shape' => 'LocalVolumeResourceData', ], 'S3MachineLearningModelResourceData' => [ 'shape' => 'S3MachineLearningModelResourceData', ], 'SageMakerMachineLearningModelResourceData' => [ 'shape' => 'SageMakerMachineLearningModelResourceData', ], 'SecretsManagerSecretResourceData' => [ 'shape' => 'SecretsManagerSecretResourceData', ], ], ], 'ResourceDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Resources' => [ 'shape' => '__listOfResource', ], ], ], 'S3MachineLearningModelResourceData' => [ 'type' => 'structure', 'members' => [ 'DestinationPath' => [ 'shape' => '__string', ], 'S3Uri' => [ 'shape' => '__string', ], ], ], 'S3UrlSignerRole' => [ 'type' => 'string', ], 'SageMakerMachineLearningModelResourceData' => [ 'type' => 'structure', 'members' => [ 'DestinationPath' => [ 'shape' => '__string', ], 'SageMakerJobArn' => [ 'shape' => '__string', ], ], ], 'SecretsManagerSecretResourceData' => [ 'type' => 'structure', 'members' => [ 'ARN' => [ 'shape' => '__string', ], 'AdditionalStagingLabelsToDownload' => [ 'shape' => '__listOf__string', ], ], ], 'SoftwareToUpdate' => [ 'type' => 'string', 'enum' => [ 'core', 'ota_agent', ], ], 'StartBulkDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'AmznClientToken' => [ 'shape' => '__string', 'location' => 'header', 'locationName' => 'X-Amzn-Client-Token', ], 'ExecutionRoleArn' => [ 'shape' => '__string', ], 'InputFileUri' => [ 'shape' => '__string', ], ], ], 'StartBulkDeploymentResponse' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentArn' => [ 'shape' => '__string', ], 'BulkDeploymentId' => [ 'shape' => '__string', ], ], ], 'StopBulkDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'BulkDeploymentId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'BulkDeploymentId', ], ], 'required' => [ 'BulkDeploymentId', ], ], 'StopBulkDeploymentResponse' => [ 'type' => 'structure', 'members' => [], ], 'Subscription' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => '__string', ], 'Source' => [ 'shape' => '__string', ], 'Subject' => [ 'shape' => '__string', ], 'Target' => [ 'shape' => '__string', ], ], 'required' => [], ], 'SubscriptionDefinitionVersion' => [ 'type' => 'structure', 'members' => [ 'Subscriptions' => [ 'shape' => '__listOfSubscription', ], ], ], 'UpdateAgentLogLevel' => [ 'type' => 'string', 'enum' => [ 'NONE', 'TRACE', 'DEBUG', 'VERBOSE', 'INFO', 'WARN', 'ERROR', 'FATAL', ], ], 'UpdateConnectivityInfoRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectivityInfo' => [ 'shape' => '__listOfConnectivityInfo', ], 'ThingName' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ThingName', ], ], 'required' => [ 'ThingName', ], ], 'UpdateConnectivityInfoResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], 'Version' => [ 'shape' => '__string', ], ], ], 'UpdateConnectorDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'ConnectorDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ConnectorDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'ConnectorDefinitionId', ], ], 'UpdateConnectorDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateCoreDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'CoreDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'CoreDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'CoreDefinitionId', ], ], 'UpdateCoreDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDeviceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'DeviceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'DeviceDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'DeviceDefinitionId', ], ], 'UpdateDeviceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateFunctionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'FunctionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'FunctionDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'FunctionDefinitionId', ], ], 'UpdateFunctionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateGroupCertificateConfigurationRequest' => [ 'type' => 'structure', 'members' => [ 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], ], 'required' => [ 'GroupId', ], ], 'UpdateGroupCertificateConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityExpiryInMilliseconds' => [ 'shape' => '__string', ], 'CertificateExpiryInMilliseconds' => [ 'shape' => '__string', ], 'GroupId' => [ 'shape' => '__string', ], ], ], 'UpdateGroupRequest' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'GroupId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'GroupId', ], ], 'UpdateGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateLoggerDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'LoggerDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'LoggerDefinitionId', ], 'Name' => [ 'shape' => '__string', ], ], 'required' => [ 'LoggerDefinitionId', ], ], 'UpdateLoggerDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateResourceDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__string', ], 'ResourceDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'ResourceDefinitionId', ], ], 'required' => [ 'ResourceDefinitionId', ], ], 'UpdateResourceDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateSubscriptionDefinitionRequest' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__string', ], 'SubscriptionDefinitionId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'SubscriptionDefinitionId', ], ], 'required' => [ 'SubscriptionDefinitionId', ], ], 'UpdateSubscriptionDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateTargets' => [ 'type' => 'list', 'member' => [ 'shape' => '__string', ], ], 'UpdateTargetsArchitecture' => [ 'type' => 'string', 'enum' => [ 'armv7l', 'x86_64', 'aarch64', ], ], 'UpdateTargetsOperatingSystem' => [ 'type' => 'string', 'enum' => [ 'ubuntu', 'raspbian', 'amazon_linux', ], ], 'VersionInformation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', ], 'CreationTimestamp' => [ 'shape' => '__string', ], 'Id' => [ 'shape' => '__string', ], 'Version' => [ 'shape' => '__string', ], ], ], '__boolean' => [ 'type' => 'boolean', ], '__double' => [ 'type' => 'double', ], '__integer' => [ 'type' => 'integer', ], '__listOfConnectivityInfo' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectivityInfo', ], ], '__listOfConnector' => [ 'type' => 'list', 'member' => [ 'shape' => 'Connector', ], ], '__listOfCore' => [ 'type' => 'list', 'member' => [ 'shape' => 'Core', ], ], '__listOfDefinitionInformation' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefinitionInformation', ], ], '__listOfDevice' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], '__listOfFunction' => [ 'type' => 'list', 'member' => [ 'shape' => 'Function', ], ], '__listOfGroupCertificateAuthorityProperties' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupCertificateAuthorityProperties', ], ], '__listOfGroupInformation' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupInformation', ], ], '__listOfLogger' => [ 'type' => 'list', 'member' => [ 'shape' => 'Logger', ], ], '__listOfResource' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], '__listOfResourceAccessPolicy' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceAccessPolicy', ], ], '__listOfSubscription' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subscription', ], ], '__listOfVersionInformation' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionInformation', ], ], '__listOf__string' => [ 'type' => 'list', 'member' => [ 'shape' => '__string', ], ], '__long' => [ 'type' => 'long', ], '__mapOf__string' => [ 'type' => 'map', 'key' => [ 'shape' => '__string', ], 'value' => [ 'shape' => '__string', ], ], '__string' => [ 'type' => 'string', ], '__timestampIso8601' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], '__timestampUnix' => [ 'type' => 'timestamp', 'timestampFormat' => 'unixTimestamp', ], ],]; diff --git a/src/data/greengrass/2017-06-07/docs-2.json b/src/data/greengrass/2017-06-07/docs-2.json index 52972cf64c..3c07f33db3 100644 --- a/src/data/greengrass/2017-06-07/docs-2.json +++ b/src/data/greengrass/2017-06-07/docs-2.json @@ -210,10 +210,10 @@ } }, "DeploymentType" : { - "base" : "The type of deployment.", + "base" : "The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.", "refs" : { "BulkDeploymentResult$DeploymentType" : "The type of the deployment.", - "CreateDeploymentRequest$DeploymentType" : "The type of deployment. When used in ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.", + "CreateDeploymentRequest$DeploymentType" : "The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.", "Deployment$DeploymentType" : "The type of the deployment.", "GetDeploymentStatusResponse$DeploymentType" : "The type of the deployment." } @@ -288,13 +288,13 @@ } }, "FunctionDefaultConfig" : { - "base" : "Default configuration that will apply to all Lambda functions in the group.", + "base" : "The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.", "refs" : { - "FunctionDefinitionVersion$DefaultConfig" : "Default configuration that will apply to all Lambda functions in this function definition version" + "FunctionDefinitionVersion$DefaultConfig" : "The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings." } }, "FunctionDefaultExecutionConfig" : { - "base" : "Configuration that defines the default containerization used for when running Lambda functions in the group. Individual Lambda functions can be override this setting.", + "base" : "Configuration information that specifies how a Lambda function runs. ", "refs" : { "FunctionDefaultConfig$Execution" : null } @@ -306,7 +306,7 @@ } }, "FunctionExecutionConfig" : { - "base" : "Configuration information that specifies how the Lambda function runs. ", + "base" : "Configuration information that specifies how a Lambda function runs. ", "refs" : { "FunctionConfigurationEnvironment$Execution" : "Configuration related to executing the Lambda function" } @@ -314,12 +314,11 @@ "FunctionIsolationMode" : { "base" : "Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.", "refs" : { - "FunctionDefaultExecutionConfig$IsolationMode" : null, "FunctionExecutionConfig$IsolationMode" : null } }, "FunctionRunAsConfig" : { - "base" : "Specifies the user and/or group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values (ggc_user/ggc_group). We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set IsolationMode to NoContainer and you must update config.json in greengrass-root/config to set allowFunctionsToRunAsRoot to yes.", + "base" : "Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.", "refs" : { "FunctionExecutionConfig$RunAs" : null } @@ -637,8 +636,8 @@ "ConnectivityInfo$PortNumber" : "The port of the Greengrass core. Usually 8883.", "FunctionConfiguration$MemorySize" : "The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.", "FunctionConfiguration$Timeout" : "The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.", - "FunctionRunAsConfig$Gid" : "The Group ID whose permissions are used to run a Lambda function.", - "FunctionRunAsConfig$Uid" : "The User ID whose permissions are used to run a Lambda function.", + "FunctionRunAsConfig$Gid" : "The group ID whose permissions are used to run a Lambda function.", + "FunctionRunAsConfig$Uid" : "The user ID whose permissions are used to run a Lambda function.", "Logger$Space" : "The amount of file space, in KB, to use if the local file system is used for logging purposes." } }, @@ -747,7 +746,7 @@ "BulkDeploymentResult$CreatedAt" : "The time, in ISO format, when the deployment was created.", "BulkDeploymentResult$DeploymentArn" : "The ARN of the group deployment.", "BulkDeploymentResult$DeploymentId" : "The ID of the group deployment.", - "BulkDeploymentResult$DeploymentStatus" : "The current status of the group deployment: ''Pending'', ''InProgress'', ''Success'', or ''Failure''.", + "BulkDeploymentResult$DeploymentStatus" : "The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.", "BulkDeploymentResult$ErrorMessage" : "The error message for a failed deployment", "BulkDeploymentResult$GroupArn" : "The ARN of the Greengrass group.", "ConnectivityInfo$HostAddress" : "The endpoint for the Greengrass core. Can be an IP address or DNS.", @@ -803,7 +802,7 @@ "GetCoreDefinitionVersionResponse$Id" : "The ID of the core definition version.", "GetCoreDefinitionVersionResponse$NextToken" : "The token for the next set of results, or ''null'' if there are no additional results.", "GetCoreDefinitionVersionResponse$Version" : "The version of the core definition version.", - "GetDeploymentStatusResponse$DeploymentStatus" : "The status of the deployment: ''Pending'', ''InProgress'', ''Success'', or ''Failure''.", + "GetDeploymentStatusResponse$DeploymentStatus" : "The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.", "GetDeploymentStatusResponse$ErrorMessage" : "Error message", "GetDeploymentStatusResponse$UpdatedAt" : "The time, in milliseconds since the epoch, when the deployment status was updated.", "GetDeviceDefinitionVersionResponse$Arn" : "The ARN of the device definition version.", @@ -884,7 +883,7 @@ "StartBulkDeploymentResponse$BulkDeploymentId" : "The ID of the bulk deployment.", "Subscription$Id" : "A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", "Subscription$Source" : "The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.", - "Subscription$Subject" : "The subject of the message.", + "Subscription$Subject" : "The MQTT topic used to route the message.", "Subscription$Target" : "Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.", "UpdateConnectivityInfoResponse$Message" : "A message about the connectivity info update request.", "UpdateConnectivityInfoResponse$Version" : "The new version of the connectivity info.", diff --git a/src/data/greengrass/2017-06-07/docs-2.json.php b/src/data/greengrass/2017-06-07/docs-2.json.php index 9f589b884b..ae33c123a8 100644 --- a/src/data/greengrass/2017-06-07/docs-2.json.php +++ b/src/data/greengrass/2017-06-07/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.', 'operations' => [ 'AssociateRoleToGroup' => 'Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role\'s permissions should allow Greengrass core Lambda functions to perform actions against the cloud.', 'AssociateServiceRoleToAccount' => 'Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy \'\'AWSGreengrassResourceAccessRolePolicy\'\'.', 'CreateConnectorDefinition' => 'Creates a connector definition. You may provide the initial version of the connector definition now or use \'\'CreateConnectorDefinitionVersion\'\' at a later time.', 'CreateConnectorDefinitionVersion' => 'Creates a version of a connector definition which has already been defined.', 'CreateCoreDefinition' => 'Creates a core definition. You may provide the initial version of the core definition now or use \'\'CreateCoreDefinitionVersion\'\' at a later time. Greengrass groups must each contain exactly one Greengrass core.', 'CreateCoreDefinitionVersion' => 'Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.', 'CreateDeployment' => 'Creates a deployment. \'\'CreateDeployment\'\' requests are idempotent with respect to the \'\'X-Amzn-Client-Token\'\' token and the request parameters.', 'CreateDeviceDefinition' => 'Creates a device definition. You may provide the initial version of the device definition now or use \'\'CreateDeviceDefinitionVersion\'\' at a later time.', 'CreateDeviceDefinitionVersion' => 'Creates a version of a device definition that has already been defined.', 'CreateFunctionDefinition' => 'Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use \'\'CreateFunctionDefinitionVersion\'\' later.', 'CreateFunctionDefinitionVersion' => 'Creates a version of a Lambda function definition that has already been defined.', 'CreateGroup' => 'Creates a group. You may provide the initial version of the group or use \'\'CreateGroupVersion\'\' at a later time. Tip: You can use the \'\'gg_group_setup\'\' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.', 'CreateGroupCertificateAuthority' => 'Creates a CA for the group. If a CA already exists, it will rotate the existing CA.', 'CreateGroupVersion' => 'Creates a version of a group which has already been defined.', 'CreateLoggerDefinition' => 'Creates a logger definition. You may provide the initial version of the logger definition now or use \'\'CreateLoggerDefinitionVersion\'\' at a later time.', 'CreateLoggerDefinitionVersion' => 'Creates a version of a logger definition that has already been defined.', 'CreateResourceDefinition' => 'Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use \'\'CreateResourceDefinitionVersion\'\' later.', 'CreateResourceDefinitionVersion' => 'Creates a version of a resource definition that has already been defined.', 'CreateSoftwareUpdateJob' => 'Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.', 'CreateSubscriptionDefinition' => 'Creates a subscription definition. You may provide the initial version of the subscription definition now or use \'\'CreateSubscriptionDefinitionVersion\'\' at a later time.', 'CreateSubscriptionDefinitionVersion' => 'Creates a version of a subscription definition which has already been defined.', 'DeleteConnectorDefinition' => 'Deletes a connector definition.', 'DeleteCoreDefinition' => 'Deletes a core definition.', 'DeleteDeviceDefinition' => 'Deletes a device definition.', 'DeleteFunctionDefinition' => 'Deletes a Lambda function definition.', 'DeleteGroup' => 'Deletes a group.', 'DeleteLoggerDefinition' => 'Deletes a logger definition.', 'DeleteResourceDefinition' => 'Deletes a resource definition.', 'DeleteSubscriptionDefinition' => 'Deletes a subscription definition.', 'DisassociateRoleFromGroup' => 'Disassociates the role from a group.', 'DisassociateServiceRoleFromAccount' => 'Disassociates the service role from your account. Without a service role, deployments will not work.', 'GetAssociatedRole' => 'Retrieves the role associated with a particular group.', 'GetBulkDeploymentStatus' => 'Returns the status of a bulk deployment.', 'GetConnectivityInfo' => 'Retrieves the connectivity information for a core.', 'GetConnectorDefinition' => 'Retrieves information about a connector definition.', 'GetConnectorDefinitionVersion' => 'Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.', 'GetCoreDefinition' => 'Retrieves information about a core definition version.', 'GetCoreDefinitionVersion' => 'Retrieves information about a core definition version.', 'GetDeploymentStatus' => 'Returns the status of a deployment.', 'GetDeviceDefinition' => 'Retrieves information about a device definition.', 'GetDeviceDefinitionVersion' => 'Retrieves information about a device definition version.', 'GetFunctionDefinition' => 'Retrieves information about a Lambda function definition, including its creation time and latest version.', 'GetFunctionDefinitionVersion' => 'Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.', 'GetGroup' => 'Retrieves information about a group.', 'GetGroupCertificateAuthority' => 'Retreives the CA associated with a group. Returns the public key of the CA.', 'GetGroupCertificateConfiguration' => 'Retrieves the current configuration for the CA used by the group.', 'GetGroupVersion' => 'Retrieves information about a group version.', 'GetLoggerDefinition' => 'Retrieves information about a logger definition.', 'GetLoggerDefinitionVersion' => 'Retrieves information about a logger definition version.', 'GetResourceDefinition' => 'Retrieves information about a resource definition, including its creation time and latest version.', 'GetResourceDefinitionVersion' => 'Retrieves information about a resource definition version, including which resources are included in the version.', 'GetServiceRoleForAccount' => 'Retrieves the service role that is attached to your account.', 'GetSubscriptionDefinition' => 'Retrieves information about a subscription definition.', 'GetSubscriptionDefinitionVersion' => 'Retrieves information about a subscription definition version.', 'ListBulkDeploymentDetailedReports' => 'Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.', 'ListBulkDeployments' => 'Returns a list of bulk deployments.', 'ListConnectorDefinitionVersions' => 'Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.', 'ListConnectorDefinitions' => 'Retrieves a list of connector definitions.', 'ListCoreDefinitionVersions' => 'Lists the versions of a core definition.', 'ListCoreDefinitions' => 'Retrieves a list of core definitions.', 'ListDeployments' => 'Returns a history of deployments for the group.', 'ListDeviceDefinitionVersions' => 'Lists the versions of a device definition.', 'ListDeviceDefinitions' => 'Retrieves a list of device definitions.', 'ListFunctionDefinitionVersions' => 'Lists the versions of a Lambda function definition.', 'ListFunctionDefinitions' => 'Retrieves a list of Lambda function definitions.', 'ListGroupCertificateAuthorities' => 'Retrieves the current CAs for a group.', 'ListGroupVersions' => 'Lists the versions of a group.', 'ListGroups' => 'Retrieves a list of groups.', 'ListLoggerDefinitionVersions' => 'Lists the versions of a logger definition.', 'ListLoggerDefinitions' => 'Retrieves a list of logger definitions.', 'ListResourceDefinitionVersions' => 'Lists the versions of a resource definition.', 'ListResourceDefinitions' => 'Retrieves a list of resource definitions.', 'ListSubscriptionDefinitionVersions' => 'Lists the versions of a subscription definition.', 'ListSubscriptionDefinitions' => 'Retrieves a list of subscription definitions.', 'ResetDeployments' => 'Resets a group\'s deployments.', 'StartBulkDeployment' => 'Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an \'\'X-Amzn-Client-Token\'\' token in every \'\'StartBulkDeployment\'\' request. These requests are idempotent with respect to the token and the request parameters.', 'StopBulkDeployment' => 'Stops the execution of a bulk deployment. This action returns a status of \'\'Stopping\'\' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the \'\'Stopping\'\' state. This action doesn\'t rollback completed deployments or cancel pending deployments.', 'UpdateConnectivityInfo' => 'Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.', 'UpdateConnectorDefinition' => 'Updates a connector definition.', 'UpdateCoreDefinition' => 'Updates a core definition.', 'UpdateDeviceDefinition' => 'Updates a device definition.', 'UpdateFunctionDefinition' => 'Updates a Lambda function definition.', 'UpdateGroup' => 'Updates a group.', 'UpdateGroupCertificateConfiguration' => 'Updates the Certificate expiry time for a group.', 'UpdateLoggerDefinition' => 'Updates a logger definition.', 'UpdateResourceDefinition' => 'Updates a resource definition.', 'UpdateSubscriptionDefinition' => 'Updates a subscription definition.', ], 'shapes' => [ 'AssociateRoleToGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateRoleToGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceRoleToAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceRoleToAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'BadRequestException' => [ 'base' => 'General error information.', 'refs' => [], ], 'BulkDeployment' => [ 'base' => 'Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.', 'refs' => [ 'BulkDeployments$member' => NULL, ], ], 'BulkDeploymentMetrics' => [ 'base' => 'Relevant metrics on input records processed during bulk deployment.', 'refs' => [ 'GetBulkDeploymentStatusResponse$BulkDeploymentMetrics' => 'Relevant metrics on input records processed during bulk deployment.', ], ], 'BulkDeploymentResult' => [ 'base' => 'Information about an individual group deployment in a bulk deployment operation.', 'refs' => [ 'BulkDeploymentResults$member' => NULL, ], ], 'BulkDeploymentResults' => [ 'base' => NULL, 'refs' => [ 'ListBulkDeploymentDetailedReportsResponse$Deployments' => 'A list of the individual group deployments in the bulk deployment operation.', ], ], 'BulkDeploymentStatus' => [ 'base' => 'The current status of the bulk deployment.', 'refs' => [ 'GetBulkDeploymentStatusResponse$BulkDeploymentStatus' => 'The status of the bulk deployment.', ], ], 'BulkDeployments' => [ 'base' => NULL, 'refs' => [ 'ListBulkDeploymentsResponse$BulkDeployments' => 'A list of bulk deployments.', ], ], 'ConnectivityInfo' => [ 'base' => 'Information about a Greengrass core\'s connectivity.', 'refs' => [ '__listOfConnectivityInfo$member' => NULL, ], ], 'Connector' => [ 'base' => 'Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.', 'refs' => [ '__listOfConnector$member' => NULL, ], ], 'ConnectorDefinitionVersion' => [ 'base' => 'Information about the connector definition version, which is a container for connectors.', 'refs' => [ 'GetConnectorDefinitionVersionResponse$Definition' => 'Information about the connector definition version.', ], ], 'Core' => [ 'base' => 'Information about a core.', 'refs' => [ '__listOfCore$member' => NULL, ], ], 'CoreDefinitionVersion' => [ 'base' => 'Information about a core definition version.', 'refs' => [ 'GetCoreDefinitionVersionResponse$Definition' => 'Information about the core definition version.', ], ], 'CreateDeploymentRequest' => [ 'base' => 'Information about a deployment.', 'refs' => [], ], 'CreateDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupCertificateAuthorityResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSoftwareUpdateJobRequest' => [ 'base' => 'Request for the CreateSoftwareUpdateJob API.', 'refs' => [], ], 'CreateSoftwareUpdateJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DefinitionInformation' => [ 'base' => 'Information about a definition.', 'refs' => [ '__listOfDefinitionInformation$member' => NULL, ], ], 'Deployment' => [ 'base' => 'Information about a deployment.', 'refs' => [ 'Deployments$member' => NULL, ], ], 'DeploymentType' => [ 'base' => 'The type of deployment.', 'refs' => [ 'BulkDeploymentResult$DeploymentType' => 'The type of the deployment.', 'CreateDeploymentRequest$DeploymentType' => 'The type of deployment. When used in \'\'CreateDeployment\'\', only \'\'NewDeployment\'\' and \'\'Redeployment\'\' are valid.', 'Deployment$DeploymentType' => 'The type of the deployment.', 'GetDeploymentStatusResponse$DeploymentType' => 'The type of the deployment.', ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsResponse$Deployments' => 'A list of deployments for the requested groups.', ], ], 'Device' => [ 'base' => 'Information about a device.', 'refs' => [ '__listOfDevice$member' => NULL, ], ], 'DeviceDefinitionVersion' => [ 'base' => 'Information about a device definition version.', 'refs' => [ 'GetDeviceDefinitionVersionResponse$Definition' => 'Information about the device definition version.', ], ], 'DisassociateRoleFromGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateServiceRoleFromAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'Empty' => [ 'base' => 'Empty', 'refs' => [], ], 'EncodingType' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$EncodingType' => 'The expected encoding type of the input payload for the function. The default is \'\'json\'\'.', ], ], 'ErrorDetail' => [ 'base' => 'Details about the error.', 'refs' => [ 'ErrorDetails$member' => NULL, ], ], 'ErrorDetails' => [ 'base' => 'A list of error details.', 'refs' => [ 'BulkDeploymentResult$ErrorDetails' => 'Details about the error.', 'GeneralError$ErrorDetails' => 'Details about the error.', 'GetBulkDeploymentStatusResponse$ErrorDetails' => 'Error details', 'GetDeploymentStatusResponse$ErrorDetails' => 'Error details', ], ], 'Function' => [ 'base' => 'Information about a Lambda function.', 'refs' => [ '__listOfFunction$member' => NULL, ], ], 'FunctionConfiguration' => [ 'base' => 'The configuration of the Lambda function.', 'refs' => [ 'Function$FunctionConfiguration' => 'The configuration of the Lambda function.', ], ], 'FunctionConfigurationEnvironment' => [ 'base' => 'The environment configuration of the function.', 'refs' => [ 'FunctionConfiguration$Environment' => 'The environment configuration of the function.', ], ], 'FunctionDefaultConfig' => [ 'base' => 'Default configuration that will apply to all Lambda functions in the group.', 'refs' => [ 'FunctionDefinitionVersion$DefaultConfig' => 'Default configuration that will apply to all Lambda functions in this function definition version', ], ], 'FunctionDefaultExecutionConfig' => [ 'base' => 'Configuration that defines the default containerization used for when running Lambda functions in the group. Individual Lambda functions can be override this setting.', 'refs' => [ 'FunctionDefaultConfig$Execution' => NULL, ], ], 'FunctionDefinitionVersion' => [ 'base' => 'Information about a function definition version.', 'refs' => [ 'GetFunctionDefinitionVersionResponse$Definition' => 'Information on the definition.', ], ], 'FunctionExecutionConfig' => [ 'base' => 'Configuration information that specifies how the Lambda function runs. ', 'refs' => [ 'FunctionConfigurationEnvironment$Execution' => 'Configuration related to executing the Lambda function', ], ], 'FunctionIsolationMode' => [ 'base' => 'Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.', 'refs' => [ 'FunctionDefaultExecutionConfig$IsolationMode' => NULL, 'FunctionExecutionConfig$IsolationMode' => NULL, ], ], 'FunctionRunAsConfig' => [ 'base' => 'Specifies the user and/or group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values (ggc_user/ggc_group). We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set IsolationMode to NoContainer and you must update config.json in greengrass-root/config to set allowFunctionsToRunAsRoot to yes.', 'refs' => [ 'FunctionExecutionConfig$RunAs' => NULL, ], ], 'GeneralError' => [ 'base' => 'General error information.', 'refs' => [], ], 'GetAssociatedRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBulkDeploymentStatusResponse' => [ 'base' => 'Information about the status of a bulk deployment at the time of the request.', 'refs' => [], ], 'GetConnectivityInfoResponse' => [ 'base' => 'Information about a Greengrass core\'s connectivity.', 'refs' => [], ], 'GetConnectorDefinitionVersionResponse' => [ 'base' => 'Information about a connector definition version.', 'refs' => [], ], 'GetCoreDefinitionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDeploymentStatusResponse' => [ 'base' => 'Information about the status of a deployment for a group.', 'refs' => [], ], 'GetDeviceDefinitionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionDefinitionVersionResponse' => [ 'base' => 'Information about a function definition version.', 'refs' => [], ], 'GetGroupCertificateAuthorityResponse' => [ 'base' => 'Information about a certificate authority for a group.', 'refs' => [], ], 'GetGroupVersionResponse' => [ 'base' => 'Information about a group version.', 'refs' => [], ], 'GetLoggerDefinitionVersionResponse' => [ 'base' => 'Information about a logger definition version.', 'refs' => [], ], 'GetResourceDefinitionVersionResponse' => [ 'base' => 'Information about a resource definition version.', 'refs' => [], ], 'GetServiceRoleForAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSubscriptionDefinitionVersionResponse' => [ 'base' => 'Information about a subscription definition version.', 'refs' => [], ], 'GroupCertificateAuthorityProperties' => [ 'base' => 'Information about a certificate authority for a group.', 'refs' => [ '__listOfGroupCertificateAuthorityProperties$member' => NULL, ], ], 'GroupCertificateConfiguration' => [ 'base' => 'Information about a group certificate configuration.', 'refs' => [], ], 'GroupInformation' => [ 'base' => 'Information about a group.', 'refs' => [ '__listOfGroupInformation$member' => NULL, ], ], 'GroupOwnerSetting' => [ 'base' => 'Group owner related settings for local resources.', 'refs' => [ 'LocalDeviceResourceData$GroupOwnerSetting' => 'Group/owner related settings for local resources.', 'LocalVolumeResourceData$GroupOwnerSetting' => 'Allows you to configure additional group privileges for the Lambda process. This field is optional.', ], ], 'GroupVersion' => [ 'base' => 'Information about a group version.', 'refs' => [ 'GetGroupVersionResponse$Definition' => 'Information about the group version definition.', ], ], 'InternalServerErrorException' => [ 'base' => 'General error information.', 'refs' => [], ], 'ListBulkDeploymentDetailedReportsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListBulkDeploymentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDefinitionsResponse' => [ 'base' => 'A list of definitions.', 'refs' => [], ], 'ListDeploymentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupCertificateAuthoritiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVersionsResponse' => [ 'base' => 'A list of versions.', 'refs' => [], ], 'LocalDeviceResourceData' => [ 'base' => 'Attributes that define a local device resource.', 'refs' => [ 'ResourceDataContainer$LocalDeviceResourceData' => 'Attributes that define the local device resource.', ], ], 'LocalVolumeResourceData' => [ 'base' => 'Attributes that define a local volume resource.', 'refs' => [ 'ResourceDataContainer$LocalVolumeResourceData' => 'Attributes that define the local volume resource.', ], ], 'Logger' => [ 'base' => 'Information about a logger', 'refs' => [ '__listOfLogger$member' => NULL, ], ], 'LoggerComponent' => [ 'base' => NULL, 'refs' => [ 'Logger$Component' => 'The component that will be subject to logging.', ], ], 'LoggerDefinitionVersion' => [ 'base' => 'Information about a logger definition version.', 'refs' => [ 'GetLoggerDefinitionVersionResponse$Definition' => 'Information about the logger definition version.', ], ], 'LoggerLevel' => [ 'base' => NULL, 'refs' => [ 'Logger$Level' => 'The level of the logs.', ], ], 'LoggerType' => [ 'base' => NULL, 'refs' => [ 'Logger$Type' => 'The type of log output which will be used.', ], ], 'Permission' => [ 'base' => 'The type of permission a function has to access a resource.', 'refs' => [ 'ResourceAccessPolicy$Permission' => 'The permissions that the Lambda function has to the resource. Can be one of \'\'rw\'\' (read/write) or \'\'ro\'\' (read-only).', ], ], 'ResetDeploymentsRequest' => [ 'base' => 'Information about a group reset request.', 'refs' => [], ], 'ResetDeploymentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Resource' => [ 'base' => 'Information about a resource.', 'refs' => [ '__listOfResource$member' => NULL, ], ], 'ResourceAccessPolicy' => [ 'base' => 'A policy used by the function to access a resource.', 'refs' => [ '__listOfResourceAccessPolicy$member' => NULL, ], ], 'ResourceDataContainer' => [ 'base' => 'A container for resource data. The container takes only one of the following supported resource data types: \'\'LocalDeviceResourceData\'\', \'\'LocalVolumeResourceData\'\', \'\'SageMakerMachineLearningModelResourceData\'\', \'\'S3MachineLearningModelResourceData\'\', \'\'SecretsManagerSecretResourceData\'\'.', 'refs' => [ 'Resource$ResourceDataContainer' => 'A container of data for all resource types.', ], ], 'ResourceDefinitionVersion' => [ 'base' => 'Information about a resource definition version.', 'refs' => [ 'GetResourceDefinitionVersionResponse$Definition' => 'Information about the definition.', ], ], 'S3MachineLearningModelResourceData' => [ 'base' => 'Attributes that define an Amazon S3 machine learning resource.', 'refs' => [ 'ResourceDataContainer$S3MachineLearningModelResourceData' => 'Attributes that define an Amazon S3 machine learning resource.', ], ], 'S3UrlSignerRole' => [ 'base' => 'The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$S3UrlSignerRole' => NULL, ], ], 'SageMakerMachineLearningModelResourceData' => [ 'base' => 'Attributes that define an Amazon SageMaker machine learning resource.', 'refs' => [ 'ResourceDataContainer$SageMakerMachineLearningModelResourceData' => 'Attributes that define an Amazon SageMaker machine learning resource.', ], ], 'SecretsManagerSecretResourceData' => [ 'base' => 'Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.', 'refs' => [ 'ResourceDataContainer$SecretsManagerSecretResourceData' => 'Attributes that define a secret resource, which references a secret from AWS Secrets Manager.', ], ], 'SoftwareToUpdate' => [ 'base' => 'The piece of software on the Greengrass core that will be updated.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$SoftwareToUpdate' => NULL, ], ], 'StartBulkDeploymentRequest' => [ 'base' => 'Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.', 'refs' => [], ], 'StartBulkDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'Subscription' => [ 'base' => 'Information about a subscription.', 'refs' => [ '__listOfSubscription$member' => NULL, ], ], 'SubscriptionDefinitionVersion' => [ 'base' => 'Information about a subscription definition version.', 'refs' => [ 'GetSubscriptionDefinitionVersionResponse$Definition' => 'Information about the subscription definition version.', ], ], 'UpdateAgentLogLevel' => [ 'base' => 'The minimum level of log statements that should be logged by the OTA Agent during an update.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateAgentLogLevel' => NULL, ], ], 'UpdateConnectivityInfoRequest' => [ 'base' => 'Information required to update a Greengrass core\'s connectivity.', 'refs' => [], ], 'UpdateConnectivityInfoResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupCertificateConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTargets' => [ 'base' => 'The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateTargets' => NULL, ], ], 'UpdateTargetsArchitecture' => [ 'base' => 'The architecture of the cores which are the targets of an update.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateTargetsArchitecture' => NULL, ], ], 'UpdateTargetsOperatingSystem' => [ 'base' => 'The operating system of the cores which are the targets of an update.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateTargetsOperatingSystem' => NULL, ], ], 'VersionInformation' => [ 'base' => 'Information about a version.', 'refs' => [ '__listOfVersionInformation$member' => NULL, ], ], '__boolean' => [ 'base' => NULL, 'refs' => [ 'Core$SyncShadow' => 'If true, the core\'s local shadow is automatically synced with the cloud.', 'Device$SyncShadow' => 'If true, the device\'s local shadow will be automatically synced with the cloud.', 'FunctionConfiguration$Pinned' => 'True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.', 'FunctionConfigurationEnvironment$AccessSysfs' => 'If true, the Lambda function is allowed to access the host\'s /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.', 'GroupOwnerSetting$AutoAddGroupOwner' => 'If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.', 'ResetDeploymentsRequest$Force' => 'If true, performs a best-effort only core reset.', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'BulkDeploymentMetrics$InvalidInputRecords' => 'The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn\'t grant permission to deploy a group or group version.', 'BulkDeploymentMetrics$RecordsProcessed' => 'The total number of group records from the input file that have been processed so far, or attempted.', 'BulkDeploymentMetrics$RetryAttempts' => 'The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. \'\'StartBulkDeployment\'\' retries a group deployment up to five times.', 'ConnectivityInfo$PortNumber' => 'The port of the Greengrass core. Usually 8883.', 'FunctionConfiguration$MemorySize' => 'The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.', 'FunctionConfiguration$Timeout' => 'The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.', 'FunctionRunAsConfig$Gid' => 'The Group ID whose permissions are used to run a Lambda function.', 'FunctionRunAsConfig$Uid' => 'The User ID whose permissions are used to run a Lambda function.', 'Logger$Space' => 'The amount of file space, in KB, to use if the local file system is used for logging purposes.', ], ], '__listOfConnectivityInfo' => [ 'base' => NULL, 'refs' => [ 'GetConnectivityInfoResponse$ConnectivityInfo' => 'Connectivity info list.', 'UpdateConnectivityInfoRequest$ConnectivityInfo' => 'A list of connectivity info.', ], ], '__listOfConnector' => [ 'base' => NULL, 'refs' => [ 'ConnectorDefinitionVersion$Connectors' => 'A list of references to connectors in this version, with their corresponding configuration settings.', ], ], '__listOfCore' => [ 'base' => NULL, 'refs' => [ 'CoreDefinitionVersion$Cores' => 'A list of cores in the core definition version.', ], ], '__listOfDefinitionInformation' => [ 'base' => NULL, 'refs' => [ 'ListDefinitionsResponse$Definitions' => 'Information about a definition.', ], ], '__listOfDevice' => [ 'base' => NULL, 'refs' => [ 'DeviceDefinitionVersion$Devices' => 'A list of devices in the definition version.', ], ], '__listOfFunction' => [ 'base' => NULL, 'refs' => [ 'FunctionDefinitionVersion$Functions' => 'A list of Lambda functions in this function definition version.', ], ], '__listOfGroupCertificateAuthorityProperties' => [ 'base' => NULL, 'refs' => [ 'ListGroupCertificateAuthoritiesResponse$GroupCertificateAuthorities' => 'A list of certificate authorities associated with the group.', ], ], '__listOfGroupInformation' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$Groups' => 'Information about a group.', ], ], '__listOfLogger' => [ 'base' => NULL, 'refs' => [ 'LoggerDefinitionVersion$Loggers' => 'A list of loggers.', ], ], '__listOfResource' => [ 'base' => NULL, 'refs' => [ 'ResourceDefinitionVersion$Resources' => 'A list of resources.', ], ], '__listOfResourceAccessPolicy' => [ 'base' => NULL, 'refs' => [ 'FunctionConfigurationEnvironment$ResourceAccessPolicies' => 'A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.', ], ], '__listOfSubscription' => [ 'base' => NULL, 'refs' => [ 'SubscriptionDefinitionVersion$Subscriptions' => 'A list of subscriptions.', ], ], '__listOfVersionInformation' => [ 'base' => NULL, 'refs' => [ 'ListVersionsResponse$Versions' => 'Information about a version.', ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'SecretsManagerSecretResourceData$AdditionalStagingLabelsToDownload' => 'Optional. The staging labels whose values you want to make available on the core, in addition to \'\'AWSCURRENT\'\'.', ], ], '__mapOf__string' => [ 'base' => NULL, 'refs' => [ 'Connector$Parameters' => 'The parameters or configuration that the connector uses.', 'FunctionConfigurationEnvironment$Variables' => 'Environment variables for the Lambda function\'s configuration.', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'AssociateRoleToGroupRequest$RoleArn' => 'The ARN of the role you wish to associate with this group.', 'AssociateRoleToGroupResponse$AssociatedAt' => 'The time, in milliseconds since the epoch, when the role ARN was associated with the group.', 'AssociateServiceRoleToAccountRequest$RoleArn' => 'The ARN of the service role you wish to associate with your account.', 'AssociateServiceRoleToAccountResponse$AssociatedAt' => 'The time when the service role was associated with the account.', 'BulkDeployment$BulkDeploymentArn' => 'The ARN of the bulk deployment.', 'BulkDeployment$BulkDeploymentId' => 'The ID of the bulk deployment.', 'BulkDeployment$CreatedAt' => 'The time, in ISO format, when the deployment was created.', 'BulkDeploymentResult$CreatedAt' => 'The time, in ISO format, when the deployment was created.', 'BulkDeploymentResult$DeploymentArn' => 'The ARN of the group deployment.', 'BulkDeploymentResult$DeploymentId' => 'The ID of the group deployment.', 'BulkDeploymentResult$DeploymentStatus' => 'The current status of the group deployment: \'\'Pending\'\', \'\'InProgress\'\', \'\'Success\'\', or \'\'Failure\'\'.', 'BulkDeploymentResult$ErrorMessage' => 'The error message for a failed deployment', 'BulkDeploymentResult$GroupArn' => 'The ARN of the Greengrass group.', 'ConnectivityInfo$HostAddress' => 'The endpoint for the Greengrass core. Can be an IP address or DNS.', 'ConnectivityInfo$Id' => 'The ID of the connectivity information.', 'ConnectivityInfo$Metadata' => 'Metadata for this endpoint.', 'Connector$ConnectorArn' => 'The ARN of the connector.', 'Connector$Id' => 'A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.', 'Core$CertificateArn' => 'The ARN of the certificate associated with the core.', 'Core$Id' => 'A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'Core$ThingArn' => 'The ARN of the thing which is the core.', 'CreateDeploymentRequest$DeploymentId' => 'The ID of the deployment if you wish to redeploy a previous deployment.', 'CreateDeploymentRequest$GroupVersionId' => 'The ID of the group version to be deployed.', 'CreateDeploymentResponse$DeploymentArn' => 'The ARN of the deployment.', 'CreateDeploymentResponse$DeploymentId' => 'The ID of the deployment.', 'CreateGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn' => 'The ARN of the group certificate authority.', 'CreateSoftwareUpdateJobResponse$IotJobArn' => 'The IoT Job ARN corresponding to this update.', 'CreateSoftwareUpdateJobResponse$IotJobId' => 'The IoT Job Id corresponding to this update.', 'DefinitionInformation$Arn' => 'The ARN of the definition.', 'DefinitionInformation$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the definition was created.', 'DefinitionInformation$Id' => 'The ID of the definition.', 'DefinitionInformation$LastUpdatedTimestamp' => 'The time, in milliseconds since the epoch, when the definition was last updated.', 'DefinitionInformation$LatestVersion' => 'The latest version of the definition.', 'DefinitionInformation$LatestVersionArn' => 'The ARN of the latest version of the definition.', 'DefinitionInformation$Name' => 'The name of the definition.', 'Deployment$CreatedAt' => 'The time, in milliseconds since the epoch, when the deployment was created.', 'Deployment$DeploymentArn' => 'The ARN of the deployment.', 'Deployment$DeploymentId' => 'The ID of the deployment.', 'Deployment$GroupArn' => 'The ARN of the group for this deployment.', 'Device$CertificateArn' => 'The ARN of the certificate associated with the device.', 'Device$Id' => 'A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'Device$ThingArn' => 'The thing ARN of the device.', 'DisassociateRoleFromGroupResponse$DisassociatedAt' => 'The time, in milliseconds since the epoch, when the role was disassociated from the group.', 'DisassociateServiceRoleFromAccountResponse$DisassociatedAt' => 'The time when the service role was disassociated from the account.', 'ErrorDetail$DetailedErrorCode' => 'A detailed error code.', 'ErrorDetail$DetailedErrorMessage' => 'A detailed error message.', 'Function$FunctionArn' => 'The ARN of the Lambda function.', 'Function$Id' => 'A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'FunctionConfiguration$ExecArgs' => 'The execution arguments.', 'FunctionConfiguration$Executable' => 'The name of the function executable.', 'GeneralError$Message' => 'A message containing information about the error.', 'GetAssociatedRoleResponse$AssociatedAt' => 'The time when the role was associated with the group.', 'GetAssociatedRoleResponse$RoleArn' => 'The ARN of the role that is associated with the group.', 'GetBulkDeploymentStatusResponse$CreatedAt' => 'The time, in ISO format, when the deployment was created.', 'GetBulkDeploymentStatusResponse$ErrorMessage' => 'Error message', 'GetConnectivityInfoResponse$Message' => 'A message about the connectivity info request.', 'GetConnectorDefinitionVersionResponse$Arn' => 'The ARN of the connector definition version.', 'GetConnectorDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the connector definition version was created.', 'GetConnectorDefinitionVersionResponse$Id' => 'The ID of the connector definition version.', 'GetConnectorDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetConnectorDefinitionVersionResponse$Version' => 'The version of the connector definition version.', 'GetCoreDefinitionVersionResponse$Arn' => 'The ARN of the core definition version.', 'GetCoreDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the core definition version was created.', 'GetCoreDefinitionVersionResponse$Id' => 'The ID of the core definition version.', 'GetCoreDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetCoreDefinitionVersionResponse$Version' => 'The version of the core definition version.', 'GetDeploymentStatusResponse$DeploymentStatus' => 'The status of the deployment: \'\'Pending\'\', \'\'InProgress\'\', \'\'Success\'\', or \'\'Failure\'\'.', 'GetDeploymentStatusResponse$ErrorMessage' => 'Error message', 'GetDeploymentStatusResponse$UpdatedAt' => 'The time, in milliseconds since the epoch, when the deployment status was updated.', 'GetDeviceDefinitionVersionResponse$Arn' => 'The ARN of the device definition version.', 'GetDeviceDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the device definition version was created.', 'GetDeviceDefinitionVersionResponse$Id' => 'The ID of the device definition version.', 'GetDeviceDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetDeviceDefinitionVersionResponse$Version' => 'The version of the device definition version.', 'GetFunctionDefinitionVersionResponse$Arn' => 'The ARN of the function definition version.', 'GetFunctionDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the function definition version was created.', 'GetFunctionDefinitionVersionResponse$Id' => 'The ID of the function definition version.', 'GetFunctionDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetFunctionDefinitionVersionResponse$Version' => 'The version of the function definition version.', 'GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn' => 'The ARN of the certificate authority for the group.', 'GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityId' => 'The ID of the certificate authority for the group.', 'GetGroupCertificateAuthorityResponse$PemEncodedCertificate' => 'The PEM encoded certificate for the group.', 'GetGroupVersionResponse$Arn' => 'The ARN of the group version.', 'GetGroupVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the group version was created.', 'GetGroupVersionResponse$Id' => 'The ID of the group version.', 'GetGroupVersionResponse$Version' => 'The unique ID for the version of the group.', 'GetLoggerDefinitionVersionResponse$Arn' => 'The ARN of the logger definition version.', 'GetLoggerDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the logger definition version was created.', 'GetLoggerDefinitionVersionResponse$Id' => 'The ID of the logger definition version.', 'GetLoggerDefinitionVersionResponse$Version' => 'The version of the logger definition version.', 'GetResourceDefinitionVersionResponse$Arn' => 'Arn of the resource definition version.', 'GetResourceDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the resource definition version was created.', 'GetResourceDefinitionVersionResponse$Id' => 'The ID of the resource definition version.', 'GetResourceDefinitionVersionResponse$Version' => 'The version of the resource definition version.', 'GetServiceRoleForAccountResponse$AssociatedAt' => 'The time when the service role was associated with the account.', 'GetServiceRoleForAccountResponse$RoleArn' => 'The ARN of the role which is associated with the account.', 'GetSubscriptionDefinitionVersionResponse$Arn' => 'The ARN of the subscription definition version.', 'GetSubscriptionDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the subscription definition version was created.', 'GetSubscriptionDefinitionVersionResponse$Id' => 'The ID of the subscription definition version.', 'GetSubscriptionDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetSubscriptionDefinitionVersionResponse$Version' => 'The version of the subscription definition version.', 'GroupCertificateAuthorityProperties$GroupCertificateAuthorityArn' => 'The ARN of the certificate authority for the group.', 'GroupCertificateAuthorityProperties$GroupCertificateAuthorityId' => 'The ID of the certificate authority for the group.', 'GroupCertificateConfiguration$CertificateAuthorityExpiryInMilliseconds' => 'The amount of time remaining before the certificate authority expires, in milliseconds.', 'GroupCertificateConfiguration$CertificateExpiryInMilliseconds' => 'The amount of time remaining before the certificate expires, in milliseconds.', 'GroupCertificateConfiguration$GroupId' => 'The ID of the group certificate configuration.', 'GroupInformation$Arn' => 'The ARN of the group.', 'GroupInformation$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the group was created.', 'GroupInformation$Id' => 'The ID of the group.', 'GroupInformation$LastUpdatedTimestamp' => 'The time, in milliseconds since the epoch, when the group was last updated.', 'GroupInformation$LatestVersion' => 'The latest version of the group.', 'GroupInformation$LatestVersionArn' => 'The ARN of the latest version of the group.', 'GroupInformation$Name' => 'The name of the group.', 'GroupOwnerSetting$GroupOwner' => 'The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.', 'GroupVersion$ConnectorDefinitionVersionArn' => 'The ARN of the connector definition version for this group.', 'GroupVersion$CoreDefinitionVersionArn' => 'The ARN of the core definition version for this group.', 'GroupVersion$DeviceDefinitionVersionArn' => 'The ARN of the device definition version for this group.', 'GroupVersion$FunctionDefinitionVersionArn' => 'The ARN of the function definition version for this group.', 'GroupVersion$LoggerDefinitionVersionArn' => 'The ARN of the logger definition version for this group.', 'GroupVersion$ResourceDefinitionVersionArn' => 'The ARN of the resource definition version for this group.', 'GroupVersion$SubscriptionDefinitionVersionArn' => 'The ARN of the subscription definition version for this group.', 'ListBulkDeploymentDetailedReportsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListBulkDeploymentsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListDefinitionsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListDeploymentsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListGroupsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListVersionsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'LocalDeviceResourceData$SourcePath' => 'The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under \'\'/dev\'\'.', 'LocalVolumeResourceData$DestinationPath' => 'The absolute local path of the resource inside the Lambda environment.', 'LocalVolumeResourceData$SourcePath' => 'The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with \'\'/sys\'\'.', 'Logger$Id' => 'A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'ResetDeploymentsResponse$DeploymentArn' => 'The ARN of the deployment.', 'ResetDeploymentsResponse$DeploymentId' => 'The ID of the deployment.', 'Resource$Id' => 'The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'. This must be unique within a Greengrass group.', 'Resource$Name' => 'The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'. This must be unique within a Greengrass group.', 'ResourceAccessPolicy$ResourceId' => 'The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)', 'S3MachineLearningModelResourceData$DestinationPath' => 'The absolute local path of the resource inside the Lambda environment.', 'S3MachineLearningModelResourceData$S3Uri' => 'The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.', 'SageMakerMachineLearningModelResourceData$DestinationPath' => 'The absolute local path of the resource inside the Lambda environment.', 'SageMakerMachineLearningModelResourceData$SageMakerJobArn' => 'The ARN of the Amazon SageMaker training job that represents the source model.', 'SecretsManagerSecretResourceData$ARN' => 'The ARN of the Secrets Manager secret to make available on the core. The value of the secret\'s latest version (represented by the \'\'AWSCURRENT\'\' staging label) is included by default.', 'StartBulkDeploymentRequest$ExecutionRoleArn' => 'The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the \'\'greengrass:CreateDeployment\'\' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.', 'StartBulkDeploymentRequest$InputFileUri' => 'The URI of the input file contained in the S3 bucket. The execution role must have \'\'getObject\'\' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only \'\'NewDeployment\'\' deployment types.', 'StartBulkDeploymentResponse$BulkDeploymentArn' => 'The ARN of the bulk deployment.', 'StartBulkDeploymentResponse$BulkDeploymentId' => 'The ID of the bulk deployment.', 'Subscription$Id' => 'A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'Subscription$Source' => 'The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, \'cloud\' (which represents the AWS IoT cloud), or \'GGShadowService\'.', 'Subscription$Subject' => 'The subject of the message.', 'Subscription$Target' => 'Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, \'cloud\' (which represents the AWS IoT cloud), or \'GGShadowService\'.', 'UpdateConnectivityInfoResponse$Message' => 'A message about the connectivity info update request.', 'UpdateConnectivityInfoResponse$Version' => 'The new version of the connectivity info.', 'UpdateGroupCertificateConfigurationRequest$CertificateExpiryInMilliseconds' => 'The amount of time remaining before the certificate expires, in milliseconds.', 'UpdateTargets$member' => NULL, 'VersionInformation$Arn' => 'The ARN of the version.', 'VersionInformation$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the version was created.', 'VersionInformation$Id' => 'The ID of the version.', 'VersionInformation$Version' => 'The unique ID of the version.', '__listOf__string$member' => NULL, '__mapOf__string$member' => NULL, ], ], ],]; +return [ 'version' => '2.0', 'service' => 'AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.', 'operations' => [ 'AssociateRoleToGroup' => 'Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role\'s permissions should allow Greengrass core Lambda functions to perform actions against the cloud.', 'AssociateServiceRoleToAccount' => 'Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy \'\'AWSGreengrassResourceAccessRolePolicy\'\'.', 'CreateConnectorDefinition' => 'Creates a connector definition. You may provide the initial version of the connector definition now or use \'\'CreateConnectorDefinitionVersion\'\' at a later time.', 'CreateConnectorDefinitionVersion' => 'Creates a version of a connector definition which has already been defined.', 'CreateCoreDefinition' => 'Creates a core definition. You may provide the initial version of the core definition now or use \'\'CreateCoreDefinitionVersion\'\' at a later time. Greengrass groups must each contain exactly one Greengrass core.', 'CreateCoreDefinitionVersion' => 'Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.', 'CreateDeployment' => 'Creates a deployment. \'\'CreateDeployment\'\' requests are idempotent with respect to the \'\'X-Amzn-Client-Token\'\' token and the request parameters.', 'CreateDeviceDefinition' => 'Creates a device definition. You may provide the initial version of the device definition now or use \'\'CreateDeviceDefinitionVersion\'\' at a later time.', 'CreateDeviceDefinitionVersion' => 'Creates a version of a device definition that has already been defined.', 'CreateFunctionDefinition' => 'Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use \'\'CreateFunctionDefinitionVersion\'\' later.', 'CreateFunctionDefinitionVersion' => 'Creates a version of a Lambda function definition that has already been defined.', 'CreateGroup' => 'Creates a group. You may provide the initial version of the group or use \'\'CreateGroupVersion\'\' at a later time. Tip: You can use the \'\'gg_group_setup\'\' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.', 'CreateGroupCertificateAuthority' => 'Creates a CA for the group. If a CA already exists, it will rotate the existing CA.', 'CreateGroupVersion' => 'Creates a version of a group which has already been defined.', 'CreateLoggerDefinition' => 'Creates a logger definition. You may provide the initial version of the logger definition now or use \'\'CreateLoggerDefinitionVersion\'\' at a later time.', 'CreateLoggerDefinitionVersion' => 'Creates a version of a logger definition that has already been defined.', 'CreateResourceDefinition' => 'Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use \'\'CreateResourceDefinitionVersion\'\' later.', 'CreateResourceDefinitionVersion' => 'Creates a version of a resource definition that has already been defined.', 'CreateSoftwareUpdateJob' => 'Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.', 'CreateSubscriptionDefinition' => 'Creates a subscription definition. You may provide the initial version of the subscription definition now or use \'\'CreateSubscriptionDefinitionVersion\'\' at a later time.', 'CreateSubscriptionDefinitionVersion' => 'Creates a version of a subscription definition which has already been defined.', 'DeleteConnectorDefinition' => 'Deletes a connector definition.', 'DeleteCoreDefinition' => 'Deletes a core definition.', 'DeleteDeviceDefinition' => 'Deletes a device definition.', 'DeleteFunctionDefinition' => 'Deletes a Lambda function definition.', 'DeleteGroup' => 'Deletes a group.', 'DeleteLoggerDefinition' => 'Deletes a logger definition.', 'DeleteResourceDefinition' => 'Deletes a resource definition.', 'DeleteSubscriptionDefinition' => 'Deletes a subscription definition.', 'DisassociateRoleFromGroup' => 'Disassociates the role from a group.', 'DisassociateServiceRoleFromAccount' => 'Disassociates the service role from your account. Without a service role, deployments will not work.', 'GetAssociatedRole' => 'Retrieves the role associated with a particular group.', 'GetBulkDeploymentStatus' => 'Returns the status of a bulk deployment.', 'GetConnectivityInfo' => 'Retrieves the connectivity information for a core.', 'GetConnectorDefinition' => 'Retrieves information about a connector definition.', 'GetConnectorDefinitionVersion' => 'Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.', 'GetCoreDefinition' => 'Retrieves information about a core definition version.', 'GetCoreDefinitionVersion' => 'Retrieves information about a core definition version.', 'GetDeploymentStatus' => 'Returns the status of a deployment.', 'GetDeviceDefinition' => 'Retrieves information about a device definition.', 'GetDeviceDefinitionVersion' => 'Retrieves information about a device definition version.', 'GetFunctionDefinition' => 'Retrieves information about a Lambda function definition, including its creation time and latest version.', 'GetFunctionDefinitionVersion' => 'Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.', 'GetGroup' => 'Retrieves information about a group.', 'GetGroupCertificateAuthority' => 'Retreives the CA associated with a group. Returns the public key of the CA.', 'GetGroupCertificateConfiguration' => 'Retrieves the current configuration for the CA used by the group.', 'GetGroupVersion' => 'Retrieves information about a group version.', 'GetLoggerDefinition' => 'Retrieves information about a logger definition.', 'GetLoggerDefinitionVersion' => 'Retrieves information about a logger definition version.', 'GetResourceDefinition' => 'Retrieves information about a resource definition, including its creation time and latest version.', 'GetResourceDefinitionVersion' => 'Retrieves information about a resource definition version, including which resources are included in the version.', 'GetServiceRoleForAccount' => 'Retrieves the service role that is attached to your account.', 'GetSubscriptionDefinition' => 'Retrieves information about a subscription definition.', 'GetSubscriptionDefinitionVersion' => 'Retrieves information about a subscription definition version.', 'ListBulkDeploymentDetailedReports' => 'Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.', 'ListBulkDeployments' => 'Returns a list of bulk deployments.', 'ListConnectorDefinitionVersions' => 'Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.', 'ListConnectorDefinitions' => 'Retrieves a list of connector definitions.', 'ListCoreDefinitionVersions' => 'Lists the versions of a core definition.', 'ListCoreDefinitions' => 'Retrieves a list of core definitions.', 'ListDeployments' => 'Returns a history of deployments for the group.', 'ListDeviceDefinitionVersions' => 'Lists the versions of a device definition.', 'ListDeviceDefinitions' => 'Retrieves a list of device definitions.', 'ListFunctionDefinitionVersions' => 'Lists the versions of a Lambda function definition.', 'ListFunctionDefinitions' => 'Retrieves a list of Lambda function definitions.', 'ListGroupCertificateAuthorities' => 'Retrieves the current CAs for a group.', 'ListGroupVersions' => 'Lists the versions of a group.', 'ListGroups' => 'Retrieves a list of groups.', 'ListLoggerDefinitionVersions' => 'Lists the versions of a logger definition.', 'ListLoggerDefinitions' => 'Retrieves a list of logger definitions.', 'ListResourceDefinitionVersions' => 'Lists the versions of a resource definition.', 'ListResourceDefinitions' => 'Retrieves a list of resource definitions.', 'ListSubscriptionDefinitionVersions' => 'Lists the versions of a subscription definition.', 'ListSubscriptionDefinitions' => 'Retrieves a list of subscription definitions.', 'ResetDeployments' => 'Resets a group\'s deployments.', 'StartBulkDeployment' => 'Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an \'\'X-Amzn-Client-Token\'\' token in every \'\'StartBulkDeployment\'\' request. These requests are idempotent with respect to the token and the request parameters.', 'StopBulkDeployment' => 'Stops the execution of a bulk deployment. This action returns a status of \'\'Stopping\'\' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the \'\'Stopping\'\' state. This action doesn\'t rollback completed deployments or cancel pending deployments.', 'UpdateConnectivityInfo' => 'Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.', 'UpdateConnectorDefinition' => 'Updates a connector definition.', 'UpdateCoreDefinition' => 'Updates a core definition.', 'UpdateDeviceDefinition' => 'Updates a device definition.', 'UpdateFunctionDefinition' => 'Updates a Lambda function definition.', 'UpdateGroup' => 'Updates a group.', 'UpdateGroupCertificateConfiguration' => 'Updates the Certificate expiry time for a group.', 'UpdateLoggerDefinition' => 'Updates a logger definition.', 'UpdateResourceDefinition' => 'Updates a resource definition.', 'UpdateSubscriptionDefinition' => 'Updates a subscription definition.', ], 'shapes' => [ 'AssociateRoleToGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateRoleToGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceRoleToAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceRoleToAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'BadRequestException' => [ 'base' => 'General error information.', 'refs' => [], ], 'BulkDeployment' => [ 'base' => 'Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.', 'refs' => [ 'BulkDeployments$member' => NULL, ], ], 'BulkDeploymentMetrics' => [ 'base' => 'Relevant metrics on input records processed during bulk deployment.', 'refs' => [ 'GetBulkDeploymentStatusResponse$BulkDeploymentMetrics' => 'Relevant metrics on input records processed during bulk deployment.', ], ], 'BulkDeploymentResult' => [ 'base' => 'Information about an individual group deployment in a bulk deployment operation.', 'refs' => [ 'BulkDeploymentResults$member' => NULL, ], ], 'BulkDeploymentResults' => [ 'base' => NULL, 'refs' => [ 'ListBulkDeploymentDetailedReportsResponse$Deployments' => 'A list of the individual group deployments in the bulk deployment operation.', ], ], 'BulkDeploymentStatus' => [ 'base' => 'The current status of the bulk deployment.', 'refs' => [ 'GetBulkDeploymentStatusResponse$BulkDeploymentStatus' => 'The status of the bulk deployment.', ], ], 'BulkDeployments' => [ 'base' => NULL, 'refs' => [ 'ListBulkDeploymentsResponse$BulkDeployments' => 'A list of bulk deployments.', ], ], 'ConnectivityInfo' => [ 'base' => 'Information about a Greengrass core\'s connectivity.', 'refs' => [ '__listOfConnectivityInfo$member' => NULL, ], ], 'Connector' => [ 'base' => 'Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.', 'refs' => [ '__listOfConnector$member' => NULL, ], ], 'ConnectorDefinitionVersion' => [ 'base' => 'Information about the connector definition version, which is a container for connectors.', 'refs' => [ 'GetConnectorDefinitionVersionResponse$Definition' => 'Information about the connector definition version.', ], ], 'Core' => [ 'base' => 'Information about a core.', 'refs' => [ '__listOfCore$member' => NULL, ], ], 'CoreDefinitionVersion' => [ 'base' => 'Information about a core definition version.', 'refs' => [ 'GetCoreDefinitionVersionResponse$Definition' => 'Information about the core definition version.', ], ], 'CreateDeploymentRequest' => [ 'base' => 'Information about a deployment.', 'refs' => [], ], 'CreateDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupCertificateAuthorityResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSoftwareUpdateJobRequest' => [ 'base' => 'Request for the CreateSoftwareUpdateJob API.', 'refs' => [], ], 'CreateSoftwareUpdateJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DefinitionInformation' => [ 'base' => 'Information about a definition.', 'refs' => [ '__listOfDefinitionInformation$member' => NULL, ], ], 'Deployment' => [ 'base' => 'Information about a deployment.', 'refs' => [ 'Deployments$member' => NULL, ], ], 'DeploymentType' => [ 'base' => 'The type of deployment. When used for \'\'CreateDeployment\'\', only \'\'NewDeployment\'\' and \'\'Redeployment\'\' are valid.', 'refs' => [ 'BulkDeploymentResult$DeploymentType' => 'The type of the deployment.', 'CreateDeploymentRequest$DeploymentType' => 'The type of deployment. When used for \'\'CreateDeployment\'\', only \'\'NewDeployment\'\' and \'\'Redeployment\'\' are valid.', 'Deployment$DeploymentType' => 'The type of the deployment.', 'GetDeploymentStatusResponse$DeploymentType' => 'The type of the deployment.', ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsResponse$Deployments' => 'A list of deployments for the requested groups.', ], ], 'Device' => [ 'base' => 'Information about a device.', 'refs' => [ '__listOfDevice$member' => NULL, ], ], 'DeviceDefinitionVersion' => [ 'base' => 'Information about a device definition version.', 'refs' => [ 'GetDeviceDefinitionVersionResponse$Definition' => 'Information about the device definition version.', ], ], 'DisassociateRoleFromGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateServiceRoleFromAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'Empty' => [ 'base' => 'Empty', 'refs' => [], ], 'EncodingType' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$EncodingType' => 'The expected encoding type of the input payload for the function. The default is \'\'json\'\'.', ], ], 'ErrorDetail' => [ 'base' => 'Details about the error.', 'refs' => [ 'ErrorDetails$member' => NULL, ], ], 'ErrorDetails' => [ 'base' => 'A list of error details.', 'refs' => [ 'BulkDeploymentResult$ErrorDetails' => 'Details about the error.', 'GeneralError$ErrorDetails' => 'Details about the error.', 'GetBulkDeploymentStatusResponse$ErrorDetails' => 'Error details', 'GetDeploymentStatusResponse$ErrorDetails' => 'Error details', ], ], 'Function' => [ 'base' => 'Information about a Lambda function.', 'refs' => [ '__listOfFunction$member' => NULL, ], ], 'FunctionConfiguration' => [ 'base' => 'The configuration of the Lambda function.', 'refs' => [ 'Function$FunctionConfiguration' => 'The configuration of the Lambda function.', ], ], 'FunctionConfigurationEnvironment' => [ 'base' => 'The environment configuration of the function.', 'refs' => [ 'FunctionConfiguration$Environment' => 'The environment configuration of the function.', ], ], 'FunctionDefaultConfig' => [ 'base' => 'The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.', 'refs' => [ 'FunctionDefinitionVersion$DefaultConfig' => 'The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.', ], ], 'FunctionDefaultExecutionConfig' => [ 'base' => 'Configuration information that specifies how a Lambda function runs. ', 'refs' => [ 'FunctionDefaultConfig$Execution' => NULL, ], ], 'FunctionDefinitionVersion' => [ 'base' => 'Information about a function definition version.', 'refs' => [ 'GetFunctionDefinitionVersionResponse$Definition' => 'Information on the definition.', ], ], 'FunctionExecutionConfig' => [ 'base' => 'Configuration information that specifies how a Lambda function runs. ', 'refs' => [ 'FunctionConfigurationEnvironment$Execution' => 'Configuration related to executing the Lambda function', ], ], 'FunctionIsolationMode' => [ 'base' => 'Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.', 'refs' => [ 'FunctionExecutionConfig$IsolationMode' => NULL, ], ], 'FunctionRunAsConfig' => [ 'base' => 'Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set \'\'IsolationMode\'\' to \'\'NoContainer\'\' and update config.json in \'\'greengrass-root/config\'\' to set \'\'allowFunctionsToRunAsRoot\'\' to \'\'yes\'\'.', 'refs' => [ 'FunctionExecutionConfig$RunAs' => NULL, ], ], 'GeneralError' => [ 'base' => 'General error information.', 'refs' => [], ], 'GetAssociatedRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBulkDeploymentStatusResponse' => [ 'base' => 'Information about the status of a bulk deployment at the time of the request.', 'refs' => [], ], 'GetConnectivityInfoResponse' => [ 'base' => 'Information about a Greengrass core\'s connectivity.', 'refs' => [], ], 'GetConnectorDefinitionVersionResponse' => [ 'base' => 'Information about a connector definition version.', 'refs' => [], ], 'GetCoreDefinitionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDeploymentStatusResponse' => [ 'base' => 'Information about the status of a deployment for a group.', 'refs' => [], ], 'GetDeviceDefinitionVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionDefinitionVersionResponse' => [ 'base' => 'Information about a function definition version.', 'refs' => [], ], 'GetGroupCertificateAuthorityResponse' => [ 'base' => 'Information about a certificate authority for a group.', 'refs' => [], ], 'GetGroupVersionResponse' => [ 'base' => 'Information about a group version.', 'refs' => [], ], 'GetLoggerDefinitionVersionResponse' => [ 'base' => 'Information about a logger definition version.', 'refs' => [], ], 'GetResourceDefinitionVersionResponse' => [ 'base' => 'Information about a resource definition version.', 'refs' => [], ], 'GetServiceRoleForAccountResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSubscriptionDefinitionVersionResponse' => [ 'base' => 'Information about a subscription definition version.', 'refs' => [], ], 'GroupCertificateAuthorityProperties' => [ 'base' => 'Information about a certificate authority for a group.', 'refs' => [ '__listOfGroupCertificateAuthorityProperties$member' => NULL, ], ], 'GroupCertificateConfiguration' => [ 'base' => 'Information about a group certificate configuration.', 'refs' => [], ], 'GroupInformation' => [ 'base' => 'Information about a group.', 'refs' => [ '__listOfGroupInformation$member' => NULL, ], ], 'GroupOwnerSetting' => [ 'base' => 'Group owner related settings for local resources.', 'refs' => [ 'LocalDeviceResourceData$GroupOwnerSetting' => 'Group/owner related settings for local resources.', 'LocalVolumeResourceData$GroupOwnerSetting' => 'Allows you to configure additional group privileges for the Lambda process. This field is optional.', ], ], 'GroupVersion' => [ 'base' => 'Information about a group version.', 'refs' => [ 'GetGroupVersionResponse$Definition' => 'Information about the group version definition.', ], ], 'InternalServerErrorException' => [ 'base' => 'General error information.', 'refs' => [], ], 'ListBulkDeploymentDetailedReportsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListBulkDeploymentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDefinitionsResponse' => [ 'base' => 'A list of definitions.', 'refs' => [], ], 'ListDeploymentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupCertificateAuthoritiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVersionsResponse' => [ 'base' => 'A list of versions.', 'refs' => [], ], 'LocalDeviceResourceData' => [ 'base' => 'Attributes that define a local device resource.', 'refs' => [ 'ResourceDataContainer$LocalDeviceResourceData' => 'Attributes that define the local device resource.', ], ], 'LocalVolumeResourceData' => [ 'base' => 'Attributes that define a local volume resource.', 'refs' => [ 'ResourceDataContainer$LocalVolumeResourceData' => 'Attributes that define the local volume resource.', ], ], 'Logger' => [ 'base' => 'Information about a logger', 'refs' => [ '__listOfLogger$member' => NULL, ], ], 'LoggerComponent' => [ 'base' => NULL, 'refs' => [ 'Logger$Component' => 'The component that will be subject to logging.', ], ], 'LoggerDefinitionVersion' => [ 'base' => 'Information about a logger definition version.', 'refs' => [ 'GetLoggerDefinitionVersionResponse$Definition' => 'Information about the logger definition version.', ], ], 'LoggerLevel' => [ 'base' => NULL, 'refs' => [ 'Logger$Level' => 'The level of the logs.', ], ], 'LoggerType' => [ 'base' => NULL, 'refs' => [ 'Logger$Type' => 'The type of log output which will be used.', ], ], 'Permission' => [ 'base' => 'The type of permission a function has to access a resource.', 'refs' => [ 'ResourceAccessPolicy$Permission' => 'The permissions that the Lambda function has to the resource. Can be one of \'\'rw\'\' (read/write) or \'\'ro\'\' (read-only).', ], ], 'ResetDeploymentsRequest' => [ 'base' => 'Information about a group reset request.', 'refs' => [], ], 'ResetDeploymentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Resource' => [ 'base' => 'Information about a resource.', 'refs' => [ '__listOfResource$member' => NULL, ], ], 'ResourceAccessPolicy' => [ 'base' => 'A policy used by the function to access a resource.', 'refs' => [ '__listOfResourceAccessPolicy$member' => NULL, ], ], 'ResourceDataContainer' => [ 'base' => 'A container for resource data. The container takes only one of the following supported resource data types: \'\'LocalDeviceResourceData\'\', \'\'LocalVolumeResourceData\'\', \'\'SageMakerMachineLearningModelResourceData\'\', \'\'S3MachineLearningModelResourceData\'\', \'\'SecretsManagerSecretResourceData\'\'.', 'refs' => [ 'Resource$ResourceDataContainer' => 'A container of data for all resource types.', ], ], 'ResourceDefinitionVersion' => [ 'base' => 'Information about a resource definition version.', 'refs' => [ 'GetResourceDefinitionVersionResponse$Definition' => 'Information about the definition.', ], ], 'S3MachineLearningModelResourceData' => [ 'base' => 'Attributes that define an Amazon S3 machine learning resource.', 'refs' => [ 'ResourceDataContainer$S3MachineLearningModelResourceData' => 'Attributes that define an Amazon S3 machine learning resource.', ], ], 'S3UrlSignerRole' => [ 'base' => 'The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$S3UrlSignerRole' => NULL, ], ], 'SageMakerMachineLearningModelResourceData' => [ 'base' => 'Attributes that define an Amazon SageMaker machine learning resource.', 'refs' => [ 'ResourceDataContainer$SageMakerMachineLearningModelResourceData' => 'Attributes that define an Amazon SageMaker machine learning resource.', ], ], 'SecretsManagerSecretResourceData' => [ 'base' => 'Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.', 'refs' => [ 'ResourceDataContainer$SecretsManagerSecretResourceData' => 'Attributes that define a secret resource, which references a secret from AWS Secrets Manager.', ], ], 'SoftwareToUpdate' => [ 'base' => 'The piece of software on the Greengrass core that will be updated.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$SoftwareToUpdate' => NULL, ], ], 'StartBulkDeploymentRequest' => [ 'base' => 'Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.', 'refs' => [], ], 'StartBulkDeploymentResponse' => [ 'base' => NULL, 'refs' => [], ], 'Subscription' => [ 'base' => 'Information about a subscription.', 'refs' => [ '__listOfSubscription$member' => NULL, ], ], 'SubscriptionDefinitionVersion' => [ 'base' => 'Information about a subscription definition version.', 'refs' => [ 'GetSubscriptionDefinitionVersionResponse$Definition' => 'Information about the subscription definition version.', ], ], 'UpdateAgentLogLevel' => [ 'base' => 'The minimum level of log statements that should be logged by the OTA Agent during an update.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateAgentLogLevel' => NULL, ], ], 'UpdateConnectivityInfoRequest' => [ 'base' => 'Information required to update a Greengrass core\'s connectivity.', 'refs' => [], ], 'UpdateConnectivityInfoResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupCertificateConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTargets' => [ 'base' => 'The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateTargets' => NULL, ], ], 'UpdateTargetsArchitecture' => [ 'base' => 'The architecture of the cores which are the targets of an update.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateTargetsArchitecture' => NULL, ], ], 'UpdateTargetsOperatingSystem' => [ 'base' => 'The operating system of the cores which are the targets of an update.', 'refs' => [ 'CreateSoftwareUpdateJobRequest$UpdateTargetsOperatingSystem' => NULL, ], ], 'VersionInformation' => [ 'base' => 'Information about a version.', 'refs' => [ '__listOfVersionInformation$member' => NULL, ], ], '__boolean' => [ 'base' => NULL, 'refs' => [ 'Core$SyncShadow' => 'If true, the core\'s local shadow is automatically synced with the cloud.', 'Device$SyncShadow' => 'If true, the device\'s local shadow will be automatically synced with the cloud.', 'FunctionConfiguration$Pinned' => 'True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.', 'FunctionConfigurationEnvironment$AccessSysfs' => 'If true, the Lambda function is allowed to access the host\'s /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.', 'GroupOwnerSetting$AutoAddGroupOwner' => 'If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.', 'ResetDeploymentsRequest$Force' => 'If true, performs a best-effort only core reset.', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'BulkDeploymentMetrics$InvalidInputRecords' => 'The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn\'t grant permission to deploy a group or group version.', 'BulkDeploymentMetrics$RecordsProcessed' => 'The total number of group records from the input file that have been processed so far, or attempted.', 'BulkDeploymentMetrics$RetryAttempts' => 'The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. \'\'StartBulkDeployment\'\' retries a group deployment up to five times.', 'ConnectivityInfo$PortNumber' => 'The port of the Greengrass core. Usually 8883.', 'FunctionConfiguration$MemorySize' => 'The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.', 'FunctionConfiguration$Timeout' => 'The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.', 'FunctionRunAsConfig$Gid' => 'The group ID whose permissions are used to run a Lambda function.', 'FunctionRunAsConfig$Uid' => 'The user ID whose permissions are used to run a Lambda function.', 'Logger$Space' => 'The amount of file space, in KB, to use if the local file system is used for logging purposes.', ], ], '__listOfConnectivityInfo' => [ 'base' => NULL, 'refs' => [ 'GetConnectivityInfoResponse$ConnectivityInfo' => 'Connectivity info list.', 'UpdateConnectivityInfoRequest$ConnectivityInfo' => 'A list of connectivity info.', ], ], '__listOfConnector' => [ 'base' => NULL, 'refs' => [ 'ConnectorDefinitionVersion$Connectors' => 'A list of references to connectors in this version, with their corresponding configuration settings.', ], ], '__listOfCore' => [ 'base' => NULL, 'refs' => [ 'CoreDefinitionVersion$Cores' => 'A list of cores in the core definition version.', ], ], '__listOfDefinitionInformation' => [ 'base' => NULL, 'refs' => [ 'ListDefinitionsResponse$Definitions' => 'Information about a definition.', ], ], '__listOfDevice' => [ 'base' => NULL, 'refs' => [ 'DeviceDefinitionVersion$Devices' => 'A list of devices in the definition version.', ], ], '__listOfFunction' => [ 'base' => NULL, 'refs' => [ 'FunctionDefinitionVersion$Functions' => 'A list of Lambda functions in this function definition version.', ], ], '__listOfGroupCertificateAuthorityProperties' => [ 'base' => NULL, 'refs' => [ 'ListGroupCertificateAuthoritiesResponse$GroupCertificateAuthorities' => 'A list of certificate authorities associated with the group.', ], ], '__listOfGroupInformation' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$Groups' => 'Information about a group.', ], ], '__listOfLogger' => [ 'base' => NULL, 'refs' => [ 'LoggerDefinitionVersion$Loggers' => 'A list of loggers.', ], ], '__listOfResource' => [ 'base' => NULL, 'refs' => [ 'ResourceDefinitionVersion$Resources' => 'A list of resources.', ], ], '__listOfResourceAccessPolicy' => [ 'base' => NULL, 'refs' => [ 'FunctionConfigurationEnvironment$ResourceAccessPolicies' => 'A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.', ], ], '__listOfSubscription' => [ 'base' => NULL, 'refs' => [ 'SubscriptionDefinitionVersion$Subscriptions' => 'A list of subscriptions.', ], ], '__listOfVersionInformation' => [ 'base' => NULL, 'refs' => [ 'ListVersionsResponse$Versions' => 'Information about a version.', ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'SecretsManagerSecretResourceData$AdditionalStagingLabelsToDownload' => 'Optional. The staging labels whose values you want to make available on the core, in addition to \'\'AWSCURRENT\'\'.', ], ], '__mapOf__string' => [ 'base' => NULL, 'refs' => [ 'Connector$Parameters' => 'The parameters or configuration that the connector uses.', 'FunctionConfigurationEnvironment$Variables' => 'Environment variables for the Lambda function\'s configuration.', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'AssociateRoleToGroupRequest$RoleArn' => 'The ARN of the role you wish to associate with this group.', 'AssociateRoleToGroupResponse$AssociatedAt' => 'The time, in milliseconds since the epoch, when the role ARN was associated with the group.', 'AssociateServiceRoleToAccountRequest$RoleArn' => 'The ARN of the service role you wish to associate with your account.', 'AssociateServiceRoleToAccountResponse$AssociatedAt' => 'The time when the service role was associated with the account.', 'BulkDeployment$BulkDeploymentArn' => 'The ARN of the bulk deployment.', 'BulkDeployment$BulkDeploymentId' => 'The ID of the bulk deployment.', 'BulkDeployment$CreatedAt' => 'The time, in ISO format, when the deployment was created.', 'BulkDeploymentResult$CreatedAt' => 'The time, in ISO format, when the deployment was created.', 'BulkDeploymentResult$DeploymentArn' => 'The ARN of the group deployment.', 'BulkDeploymentResult$DeploymentId' => 'The ID of the group deployment.', 'BulkDeploymentResult$DeploymentStatus' => 'The current status of the group deployment: \'\'InProgress\'\', \'\'Building\'\', \'\'Success\'\', or \'\'Failure\'\'.', 'BulkDeploymentResult$ErrorMessage' => 'The error message for a failed deployment', 'BulkDeploymentResult$GroupArn' => 'The ARN of the Greengrass group.', 'ConnectivityInfo$HostAddress' => 'The endpoint for the Greengrass core. Can be an IP address or DNS.', 'ConnectivityInfo$Id' => 'The ID of the connectivity information.', 'ConnectivityInfo$Metadata' => 'Metadata for this endpoint.', 'Connector$ConnectorArn' => 'The ARN of the connector.', 'Connector$Id' => 'A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.', 'Core$CertificateArn' => 'The ARN of the certificate associated with the core.', 'Core$Id' => 'A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'Core$ThingArn' => 'The ARN of the thing which is the core.', 'CreateDeploymentRequest$DeploymentId' => 'The ID of the deployment if you wish to redeploy a previous deployment.', 'CreateDeploymentRequest$GroupVersionId' => 'The ID of the group version to be deployed.', 'CreateDeploymentResponse$DeploymentArn' => 'The ARN of the deployment.', 'CreateDeploymentResponse$DeploymentId' => 'The ID of the deployment.', 'CreateGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn' => 'The ARN of the group certificate authority.', 'CreateSoftwareUpdateJobResponse$IotJobArn' => 'The IoT Job ARN corresponding to this update.', 'CreateSoftwareUpdateJobResponse$IotJobId' => 'The IoT Job Id corresponding to this update.', 'DefinitionInformation$Arn' => 'The ARN of the definition.', 'DefinitionInformation$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the definition was created.', 'DefinitionInformation$Id' => 'The ID of the definition.', 'DefinitionInformation$LastUpdatedTimestamp' => 'The time, in milliseconds since the epoch, when the definition was last updated.', 'DefinitionInformation$LatestVersion' => 'The latest version of the definition.', 'DefinitionInformation$LatestVersionArn' => 'The ARN of the latest version of the definition.', 'DefinitionInformation$Name' => 'The name of the definition.', 'Deployment$CreatedAt' => 'The time, in milliseconds since the epoch, when the deployment was created.', 'Deployment$DeploymentArn' => 'The ARN of the deployment.', 'Deployment$DeploymentId' => 'The ID of the deployment.', 'Deployment$GroupArn' => 'The ARN of the group for this deployment.', 'Device$CertificateArn' => 'The ARN of the certificate associated with the device.', 'Device$Id' => 'A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'Device$ThingArn' => 'The thing ARN of the device.', 'DisassociateRoleFromGroupResponse$DisassociatedAt' => 'The time, in milliseconds since the epoch, when the role was disassociated from the group.', 'DisassociateServiceRoleFromAccountResponse$DisassociatedAt' => 'The time when the service role was disassociated from the account.', 'ErrorDetail$DetailedErrorCode' => 'A detailed error code.', 'ErrorDetail$DetailedErrorMessage' => 'A detailed error message.', 'Function$FunctionArn' => 'The ARN of the Lambda function.', 'Function$Id' => 'A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'FunctionConfiguration$ExecArgs' => 'The execution arguments.', 'FunctionConfiguration$Executable' => 'The name of the function executable.', 'GeneralError$Message' => 'A message containing information about the error.', 'GetAssociatedRoleResponse$AssociatedAt' => 'The time when the role was associated with the group.', 'GetAssociatedRoleResponse$RoleArn' => 'The ARN of the role that is associated with the group.', 'GetBulkDeploymentStatusResponse$CreatedAt' => 'The time, in ISO format, when the deployment was created.', 'GetBulkDeploymentStatusResponse$ErrorMessage' => 'Error message', 'GetConnectivityInfoResponse$Message' => 'A message about the connectivity info request.', 'GetConnectorDefinitionVersionResponse$Arn' => 'The ARN of the connector definition version.', 'GetConnectorDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the connector definition version was created.', 'GetConnectorDefinitionVersionResponse$Id' => 'The ID of the connector definition version.', 'GetConnectorDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetConnectorDefinitionVersionResponse$Version' => 'The version of the connector definition version.', 'GetCoreDefinitionVersionResponse$Arn' => 'The ARN of the core definition version.', 'GetCoreDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the core definition version was created.', 'GetCoreDefinitionVersionResponse$Id' => 'The ID of the core definition version.', 'GetCoreDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetCoreDefinitionVersionResponse$Version' => 'The version of the core definition version.', 'GetDeploymentStatusResponse$DeploymentStatus' => 'The status of the deployment: \'\'InProgress\'\', \'\'Building\'\', \'\'Success\'\', or \'\'Failure\'\'.', 'GetDeploymentStatusResponse$ErrorMessage' => 'Error message', 'GetDeploymentStatusResponse$UpdatedAt' => 'The time, in milliseconds since the epoch, when the deployment status was updated.', 'GetDeviceDefinitionVersionResponse$Arn' => 'The ARN of the device definition version.', 'GetDeviceDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the device definition version was created.', 'GetDeviceDefinitionVersionResponse$Id' => 'The ID of the device definition version.', 'GetDeviceDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetDeviceDefinitionVersionResponse$Version' => 'The version of the device definition version.', 'GetFunctionDefinitionVersionResponse$Arn' => 'The ARN of the function definition version.', 'GetFunctionDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the function definition version was created.', 'GetFunctionDefinitionVersionResponse$Id' => 'The ID of the function definition version.', 'GetFunctionDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetFunctionDefinitionVersionResponse$Version' => 'The version of the function definition version.', 'GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn' => 'The ARN of the certificate authority for the group.', 'GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityId' => 'The ID of the certificate authority for the group.', 'GetGroupCertificateAuthorityResponse$PemEncodedCertificate' => 'The PEM encoded certificate for the group.', 'GetGroupVersionResponse$Arn' => 'The ARN of the group version.', 'GetGroupVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the group version was created.', 'GetGroupVersionResponse$Id' => 'The ID of the group version.', 'GetGroupVersionResponse$Version' => 'The unique ID for the version of the group.', 'GetLoggerDefinitionVersionResponse$Arn' => 'The ARN of the logger definition version.', 'GetLoggerDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the logger definition version was created.', 'GetLoggerDefinitionVersionResponse$Id' => 'The ID of the logger definition version.', 'GetLoggerDefinitionVersionResponse$Version' => 'The version of the logger definition version.', 'GetResourceDefinitionVersionResponse$Arn' => 'Arn of the resource definition version.', 'GetResourceDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the resource definition version was created.', 'GetResourceDefinitionVersionResponse$Id' => 'The ID of the resource definition version.', 'GetResourceDefinitionVersionResponse$Version' => 'The version of the resource definition version.', 'GetServiceRoleForAccountResponse$AssociatedAt' => 'The time when the service role was associated with the account.', 'GetServiceRoleForAccountResponse$RoleArn' => 'The ARN of the role which is associated with the account.', 'GetSubscriptionDefinitionVersionResponse$Arn' => 'The ARN of the subscription definition version.', 'GetSubscriptionDefinitionVersionResponse$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the subscription definition version was created.', 'GetSubscriptionDefinitionVersionResponse$Id' => 'The ID of the subscription definition version.', 'GetSubscriptionDefinitionVersionResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'GetSubscriptionDefinitionVersionResponse$Version' => 'The version of the subscription definition version.', 'GroupCertificateAuthorityProperties$GroupCertificateAuthorityArn' => 'The ARN of the certificate authority for the group.', 'GroupCertificateAuthorityProperties$GroupCertificateAuthorityId' => 'The ID of the certificate authority for the group.', 'GroupCertificateConfiguration$CertificateAuthorityExpiryInMilliseconds' => 'The amount of time remaining before the certificate authority expires, in milliseconds.', 'GroupCertificateConfiguration$CertificateExpiryInMilliseconds' => 'The amount of time remaining before the certificate expires, in milliseconds.', 'GroupCertificateConfiguration$GroupId' => 'The ID of the group certificate configuration.', 'GroupInformation$Arn' => 'The ARN of the group.', 'GroupInformation$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the group was created.', 'GroupInformation$Id' => 'The ID of the group.', 'GroupInformation$LastUpdatedTimestamp' => 'The time, in milliseconds since the epoch, when the group was last updated.', 'GroupInformation$LatestVersion' => 'The latest version of the group.', 'GroupInformation$LatestVersionArn' => 'The ARN of the latest version of the group.', 'GroupInformation$Name' => 'The name of the group.', 'GroupOwnerSetting$GroupOwner' => 'The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.', 'GroupVersion$ConnectorDefinitionVersionArn' => 'The ARN of the connector definition version for this group.', 'GroupVersion$CoreDefinitionVersionArn' => 'The ARN of the core definition version for this group.', 'GroupVersion$DeviceDefinitionVersionArn' => 'The ARN of the device definition version for this group.', 'GroupVersion$FunctionDefinitionVersionArn' => 'The ARN of the function definition version for this group.', 'GroupVersion$LoggerDefinitionVersionArn' => 'The ARN of the logger definition version for this group.', 'GroupVersion$ResourceDefinitionVersionArn' => 'The ARN of the resource definition version for this group.', 'GroupVersion$SubscriptionDefinitionVersionArn' => 'The ARN of the subscription definition version for this group.', 'ListBulkDeploymentDetailedReportsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListBulkDeploymentsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListDefinitionsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListDeploymentsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListGroupsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'ListVersionsResponse$NextToken' => 'The token for the next set of results, or \'\'null\'\' if there are no additional results.', 'LocalDeviceResourceData$SourcePath' => 'The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under \'\'/dev\'\'.', 'LocalVolumeResourceData$DestinationPath' => 'The absolute local path of the resource inside the Lambda environment.', 'LocalVolumeResourceData$SourcePath' => 'The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with \'\'/sys\'\'.', 'Logger$Id' => 'A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'ResetDeploymentsResponse$DeploymentArn' => 'The ARN of the deployment.', 'ResetDeploymentsResponse$DeploymentId' => 'The ID of the deployment.', 'Resource$Id' => 'The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'. This must be unique within a Greengrass group.', 'Resource$Name' => 'The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'. This must be unique within a Greengrass group.', 'ResourceAccessPolicy$ResourceId' => 'The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)', 'S3MachineLearningModelResourceData$DestinationPath' => 'The absolute local path of the resource inside the Lambda environment.', 'S3MachineLearningModelResourceData$S3Uri' => 'The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.', 'SageMakerMachineLearningModelResourceData$DestinationPath' => 'The absolute local path of the resource inside the Lambda environment.', 'SageMakerMachineLearningModelResourceData$SageMakerJobArn' => 'The ARN of the Amazon SageMaker training job that represents the source model.', 'SecretsManagerSecretResourceData$ARN' => 'The ARN of the Secrets Manager secret to make available on the core. The value of the secret\'s latest version (represented by the \'\'AWSCURRENT\'\' staging label) is included by default.', 'StartBulkDeploymentRequest$ExecutionRoleArn' => 'The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the \'\'greengrass:CreateDeployment\'\' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.', 'StartBulkDeploymentRequest$InputFileUri' => 'The URI of the input file contained in the S3 bucket. The execution role must have \'\'getObject\'\' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only \'\'NewDeployment\'\' deployment types.', 'StartBulkDeploymentResponse$BulkDeploymentArn' => 'The ARN of the bulk deployment.', 'StartBulkDeploymentResponse$BulkDeploymentId' => 'The ID of the bulk deployment.', 'Subscription$Id' => 'A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern \'\'[a-zA-Z0-9:_-]+\'\'.', 'Subscription$Source' => 'The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, \'cloud\' (which represents the AWS IoT cloud), or \'GGShadowService\'.', 'Subscription$Subject' => 'The MQTT topic used to route the message.', 'Subscription$Target' => 'Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, \'cloud\' (which represents the AWS IoT cloud), or \'GGShadowService\'.', 'UpdateConnectivityInfoResponse$Message' => 'A message about the connectivity info update request.', 'UpdateConnectivityInfoResponse$Version' => 'The new version of the connectivity info.', 'UpdateGroupCertificateConfigurationRequest$CertificateExpiryInMilliseconds' => 'The amount of time remaining before the certificate expires, in milliseconds.', 'UpdateTargets$member' => NULL, 'VersionInformation$Arn' => 'The ARN of the version.', 'VersionInformation$CreationTimestamp' => 'The time, in milliseconds since the epoch, when the version was created.', 'VersionInformation$Id' => 'The ID of the version.', 'VersionInformation$Version' => 'The unique ID of the version.', '__listOf__string$member' => NULL, '__mapOf__string$member' => NULL, ], ], ],]; diff --git a/src/data/manifest.json b/src/data/manifest.json index 4cef3ab6d3..3f84805850 100644 --- a/src/data/manifest.json +++ b/src/data/manifest.json @@ -59,7 +59,8 @@ "appmesh": { "namespace": "AppMesh", "versions": { - "latest": "2018-10-01", + "latest": "2019-01-25", + "2019-01-25": "2019-01-25", "2018-10-01": "2018-10-01" } }, diff --git a/src/data/manifest.json.php b/src/data/manifest.json.php index b347397614..9098fb07b2 100644 --- a/src/data/manifest.json.php +++ b/src/data/manifest.json.php @@ -1,3 +1,3 @@ [ 'namespace' => 'ACMPCA', 'versions' => [ 'latest' => '2017-08-22', '2017-08-22' => '2017-08-22', ], ], 'acm' => [ 'namespace' => 'Acm', 'versions' => [ 'latest' => '2015-12-08', '2015-12-08' => '2015-12-08', ], ], 'alexaforbusiness' => [ 'namespace' => 'AlexaForBusiness', 'versions' => [ 'latest' => '2017-11-09', '2017-11-09' => '2017-11-09', ], ], 'amplify' => [ 'namespace' => 'Amplify', 'versions' => [ 'latest' => '2017-07-25', '2017-07-25' => '2017-07-25', ], ], 'apigateway' => [ 'namespace' => 'ApiGateway', 'versions' => [ 'latest' => '2015-07-09', '2015-07-09' => '2015-07-09', '2015-06-01' => '2015-07-09', ], ], 'apigatewaymanagementapi' => [ 'namespace' => 'ApiGatewayManagementApi', 'versions' => [ 'latest' => '2018-11-29', '2018-11-29' => '2018-11-29', ], ], 'apigatewayv2' => [ 'namespace' => 'ApiGatewayV2', 'versions' => [ 'latest' => '2018-11-29', '2018-11-29' => '2018-11-29', ], ], 'application-autoscaling' => [ 'namespace' => 'ApplicationAutoScaling', 'versions' => [ 'latest' => '2016-02-06', '2016-02-06' => '2016-02-06', ], ], 'appmesh' => [ 'namespace' => 'AppMesh', 'versions' => [ 'latest' => '2018-10-01', '2018-10-01' => '2018-10-01', ], ], 'appstream' => [ 'namespace' => 'Appstream', 'versions' => [ 'latest' => '2016-12-01', '2016-12-01' => '2016-12-01', ], ], 'appsync' => [ 'namespace' => 'AppSync', 'versions' => [ 'latest' => '2017-07-25', '2017-07-25' => '2017-07-25', ], ], 'athena' => [ 'namespace' => 'Athena', 'versions' => [ 'latest' => '2017-05-18', '2017-05-18' => '2017-05-18', ], ], 'autoscaling-plans' => [ 'namespace' => 'AutoScalingPlans', 'versions' => [ 'latest' => '2018-01-06', '2018-01-06' => '2018-01-06', ], ], 'autoscaling' => [ 'namespace' => 'AutoScaling', 'versions' => [ 'latest' => '2011-01-01', '2011-01-01' => '2011-01-01', ], ], 'backup' => [ 'namespace' => 'Backup', 'versions' => [ 'latest' => '2018-11-15', '2018-11-15' => '2018-11-15', ], ], 'batch' => [ 'namespace' => 'Batch', 'versions' => [ 'latest' => '2016-08-10', '2016-08-10' => '2016-08-10', ], ], 'budgets' => [ 'namespace' => 'Budgets', 'versions' => [ 'latest' => '2016-10-20', '2016-10-20' => '2016-10-20', ], ], 'ce' => [ 'namespace' => 'CostExplorer', 'versions' => [ 'latest' => '2017-10-25', '2017-10-25' => '2017-10-25', ], ], 'chime' => [ 'namespace' => 'Chime', 'versions' => [ 'latest' => '2018-05-01', '2018-05-01' => '2018-05-01', ], ], 'cloud9' => [ 'namespace' => 'Cloud9', 'versions' => [ 'latest' => '2017-09-23', '2017-09-23' => '2017-09-23', ], ], 'clouddirectory' => [ 'namespace' => 'CloudDirectory', 'versions' => [ 'latest' => '2017-01-11', '2017-01-11' => '2017-01-11', '2016-05-10' => '2016-05-10', ], ], 'cloudformation' => [ 'namespace' => 'CloudFormation', 'versions' => [ 'latest' => '2010-05-15', '2010-05-15' => '2010-05-15', ], ], 'cloudfront' => [ 'namespace' => 'CloudFront', 'versions' => [ 'latest' => '2018-11-05', '2018-11-05' => '2018-11-05', '2018-06-18' => '2018-06-18', '2017-10-30' => '2017-10-30', '2017-03-25' => '2017-03-25', '2016-11-25' => '2016-11-25', '2016-09-29' => '2016-09-29', '2016-09-07' => '2016-09-07', '2016-08-20' => '2016-08-20', '2016-08-01' => '2016-08-01', '2016-01-28' => '2016-01-28', '2016-01-13' => '2018-11-05', '2015-09-17' => '2018-11-05', '2015-07-27' => '2015-07-27', '2015-04-17' => '2015-07-27', '2014-11-06' => '2015-07-27', ], ], 'cloudhsm' => [ 'namespace' => 'CloudHsm', 'versions' => [ 'latest' => '2014-05-30', '2014-05-30' => '2014-05-30', ], ], 'cloudhsmv2' => [ 'namespace' => 'CloudHSMV2', 'versions' => [ 'latest' => '2017-04-28', '2017-04-28' => '2017-04-28', ], ], 'cloudsearch' => [ 'namespace' => 'CloudSearch', 'versions' => [ 'latest' => '2013-01-01', '2013-01-01' => '2013-01-01', ], ], 'cloudsearchdomain' => [ 'namespace' => 'CloudSearchDomain', 'versions' => [ 'latest' => '2013-01-01', '2013-01-01' => '2013-01-01', ], ], 'cloudtrail' => [ 'namespace' => 'CloudTrail', 'versions' => [ 'latest' => '2013-11-01', '2013-11-01' => '2013-11-01', ], ], 'codebuild' => [ 'namespace' => 'CodeBuild', 'versions' => [ 'latest' => '2016-10-06', '2016-10-06' => '2016-10-06', ], ], 'codecommit' => [ 'namespace' => 'CodeCommit', 'versions' => [ 'latest' => '2015-04-13', '2015-04-13' => '2015-04-13', ], ], 'codedeploy' => [ 'namespace' => 'CodeDeploy', 'versions' => [ 'latest' => '2014-10-06', '2014-10-06' => '2014-10-06', ], ], 'codepipeline' => [ 'namespace' => 'CodePipeline', 'versions' => [ 'latest' => '2015-07-09', '2015-07-09' => '2015-07-09', ], ], 'codestar' => [ 'namespace' => 'CodeStar', 'versions' => [ 'latest' => '2017-04-19', '2017-04-19' => '2017-04-19', ], ], 'cognito-identity' => [ 'namespace' => 'CognitoIdentity', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'cognito-idp' => [ 'namespace' => 'CognitoIdentityProvider', 'versions' => [ 'latest' => '2016-04-18', '2016-04-18' => '2016-04-18', ], ], 'cognito-sync' => [ 'namespace' => 'CognitoSync', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'comprehend' => [ 'namespace' => 'Comprehend', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'comprehendmedical' => [ 'namespace' => 'ComprehendMedical', 'versions' => [ 'latest' => '2018-10-30', '2018-10-30' => '2018-10-30', ], ], 'config' => [ 'namespace' => 'ConfigService', 'versions' => [ 'latest' => '2014-11-12', '2014-11-12' => '2014-11-12', ], ], 'connect' => [ 'namespace' => 'Connect', 'versions' => [ 'latest' => '2017-08-08', '2017-08-08' => '2017-08-08', ], ], 'cur' => [ 'namespace' => 'CostandUsageReportService', 'versions' => [ 'latest' => '2017-01-06', '2017-01-06' => '2017-01-06', ], ], 'data.iot' => [ 'namespace' => 'IotDataPlane', 'versions' => [ 'latest' => '2015-05-28', '2015-05-28' => '2015-05-28', ], ], 'datapipeline' => [ 'namespace' => 'DataPipeline', 'versions' => [ 'latest' => '2012-10-29', '2012-10-29' => '2012-10-29', ], ], 'datasync' => [ 'namespace' => 'DataSync', 'versions' => [ 'latest' => '2018-11-09', '2018-11-09' => '2018-11-09', ], ], 'dax' => [ 'namespace' => 'DAX', 'versions' => [ 'latest' => '2017-04-19', '2017-04-19' => '2017-04-19', ], ], 'devicefarm' => [ 'namespace' => 'DeviceFarm', 'versions' => [ 'latest' => '2015-06-23', '2015-06-23' => '2015-06-23', ], ], 'directconnect' => [ 'namespace' => 'DirectConnect', 'versions' => [ 'latest' => '2012-10-25', '2012-10-25' => '2012-10-25', ], ], 'discovery' => [ 'namespace' => 'ApplicationDiscoveryService', 'versions' => [ 'latest' => '2015-11-01', '2015-11-01' => '2015-11-01', ], ], 'dlm' => [ 'namespace' => 'DLM', 'versions' => [ 'latest' => '2018-01-12', '2018-01-12' => '2018-01-12', ], ], 'dms' => [ 'namespace' => 'DatabaseMigrationService', 'versions' => [ 'latest' => '2016-01-01', '2016-01-01' => '2016-01-01', ], ], 'docdb' => [ 'namespace' => 'DocDB', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', ], ], 'ds' => [ 'namespace' => 'DirectoryService', 'versions' => [ 'latest' => '2015-04-16', '2015-04-16' => '2015-04-16', ], ], 'dynamodb' => [ 'namespace' => 'DynamoDb', 'versions' => [ 'latest' => '2012-08-10', '2012-08-10' => '2012-08-10', '2011-12-05' => '2011-12-05', ], ], 'ec2' => [ 'namespace' => 'Ec2', 'versions' => [ 'latest' => '2016-11-15', '2016-11-15' => '2016-11-15', '2016-09-15' => '2016-09-15', '2016-04-01' => '2016-04-01', '2015-10-01' => '2015-10-01', '2015-04-15' => '2016-11-15', ], ], 'ecr' => [ 'namespace' => 'Ecr', 'versions' => [ 'latest' => '2015-09-21', '2015-09-21' => '2015-09-21', ], ], 'ecs' => [ 'namespace' => 'Ecs', 'versions' => [ 'latest' => '2014-11-13', '2014-11-13' => '2014-11-13', ], ], 'eks' => [ 'namespace' => 'EKS', 'versions' => [ 'latest' => '2017-11-01', '2017-11-01' => '2017-11-01', ], ], 'elasticache' => [ 'namespace' => 'ElastiCache', 'versions' => [ 'latest' => '2015-02-02', '2015-02-02' => '2015-02-02', ], ], 'elasticbeanstalk' => [ 'namespace' => 'ElasticBeanstalk', 'versions' => [ 'latest' => '2010-12-01', '2010-12-01' => '2010-12-01', ], ], 'elasticfilesystem' => [ 'namespace' => 'Efs', 'versions' => [ 'latest' => '2015-02-01', '2015-02-01' => '2015-02-01', ], ], 'elasticloadbalancing' => [ 'namespace' => 'ElasticLoadBalancing', 'versions' => [ 'latest' => '2012-06-01', '2012-06-01' => '2012-06-01', ], ], 'elasticloadbalancingv2' => [ 'namespace' => 'ElasticLoadBalancingV2', 'versions' => [ 'latest' => '2015-12-01', '2015-12-01' => '2015-12-01', ], ], 'elasticmapreduce' => [ 'namespace' => 'Emr', 'versions' => [ 'latest' => '2009-03-31', '2009-03-31' => '2009-03-31', ], ], 'elastictranscoder' => [ 'namespace' => 'ElasticTranscoder', 'versions' => [ 'latest' => '2012-09-25', '2012-09-25' => '2012-09-25', ], ], 'email' => [ 'namespace' => 'Ses', 'versions' => [ 'latest' => '2010-12-01', '2010-12-01' => '2010-12-01', ], ], 'entitlement.marketplace' => [ 'namespace' => 'MarketplaceEntitlementService', 'versions' => [ 'latest' => '2017-01-11', '2017-01-11' => '2017-01-11', ], ], 'es' => [ 'namespace' => 'ElasticsearchService', 'versions' => [ 'latest' => '2015-01-01', '2015-01-01' => '2015-01-01', ], ], 'events' => [ 'namespace' => 'CloudWatchEvents', 'versions' => [ 'latest' => '2015-10-07', '2015-10-07' => '2015-10-07', '2014-02-03' => '2015-10-07', ], ], 'firehose' => [ 'namespace' => 'Firehose', 'versions' => [ 'latest' => '2015-08-04', '2015-08-04' => '2015-08-04', ], ], 'fms' => [ 'namespace' => 'FMS', 'versions' => [ 'latest' => '2018-01-01', '2018-01-01' => '2018-01-01', ], ], 'fsx' => [ 'namespace' => 'FSx', 'versions' => [ 'latest' => '2018-03-01', '2018-03-01' => '2018-03-01', ], ], 'gamelift' => [ 'namespace' => 'GameLift', 'versions' => [ 'latest' => '2015-10-01', '2015-10-01' => '2015-10-01', ], ], 'glacier' => [ 'namespace' => 'Glacier', 'versions' => [ 'latest' => '2012-06-01', '2012-06-01' => '2012-06-01', ], ], 'globalaccelerator' => [ 'namespace' => 'GlobalAccelerator', 'versions' => [ 'latest' => '2018-08-08', '2018-08-08' => '2018-08-08', ], ], 'glue' => [ 'namespace' => 'Glue', 'versions' => [ 'latest' => '2017-03-31', '2017-03-31' => '2017-03-31', ], ], 'greengrass' => [ 'namespace' => 'Greengrass', 'versions' => [ 'latest' => '2017-06-07', '2017-06-07' => '2017-06-07', ], ], 'guardduty' => [ 'namespace' => 'GuardDuty', 'versions' => [ 'latest' => '2017-11-28', '2017-11-28' => '2017-11-28', ], ], 'health' => [ 'namespace' => 'Health', 'versions' => [ 'latest' => '2016-08-04', '2016-08-04' => '2016-08-04', ], ], 'iam' => [ 'namespace' => 'Iam', 'versions' => [ 'latest' => '2010-05-08', '2010-05-08' => '2010-05-08', ], ], 'importexport' => [ 'namespace' => 'ImportExport', 'versions' => [ 'latest' => '2010-06-01', '2010-06-01' => '2010-06-01', ], ], 'inspector' => [ 'namespace' => 'Inspector', 'versions' => [ 'latest' => '2016-02-16', '2016-02-16' => '2016-02-16', '2015-08-18' => '2016-02-16', ], ], 'iot-jobs-data' => [ 'namespace' => 'IoTJobsDataPlane', 'versions' => [ 'latest' => '2017-09-29', '2017-09-29' => '2017-09-29', ], ], 'iot' => [ 'namespace' => 'Iot', 'versions' => [ 'latest' => '2015-05-28', '2015-05-28' => '2015-05-28', ], ], 'iot1click-devices' => [ 'namespace' => 'IoT1ClickDevicesService', 'versions' => [ 'latest' => '2018-05-14', '2018-05-14' => '2018-05-14', ], ], 'iot1click-projects' => [ 'namespace' => 'IoT1ClickProjects', 'versions' => [ 'latest' => '2018-05-14', '2018-05-14' => '2018-05-14', ], ], 'iotanalytics' => [ 'namespace' => 'IoTAnalytics', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'kafka' => [ 'namespace' => 'Kafka', 'versions' => [ 'latest' => '2018-11-14', '2018-11-14' => '2018-11-14', ], ], 'kinesis-video-archived-media' => [ 'namespace' => 'KinesisVideoArchivedMedia', 'versions' => [ 'latest' => '2017-09-30', '2017-09-30' => '2017-09-30', ], ], 'kinesis-video-media' => [ 'namespace' => 'KinesisVideoMedia', 'versions' => [ 'latest' => '2017-09-30', '2017-09-30' => '2017-09-30', ], ], 'kinesis' => [ 'namespace' => 'Kinesis', 'versions' => [ 'latest' => '2013-12-02', '2013-12-02' => '2013-12-02', ], ], 'kinesisanalytics' => [ 'namespace' => 'KinesisAnalytics', 'versions' => [ 'latest' => '2015-08-14', '2015-08-14' => '2015-08-14', ], ], 'kinesisanalyticsv2' => [ 'namespace' => 'KinesisAnalyticsV2', 'versions' => [ 'latest' => '2018-05-23', '2018-05-23' => '2018-05-23', ], ], 'kinesisvideo' => [ 'namespace' => 'KinesisVideo', 'versions' => [ 'latest' => '2017-09-30', '2017-09-30' => '2017-09-30', ], ], 'kms' => [ 'namespace' => 'Kms', 'versions' => [ 'latest' => '2014-11-01', '2014-11-01' => '2014-11-01', ], ], 'lambda' => [ 'namespace' => 'Lambda', 'versions' => [ 'latest' => '2015-03-31', '2015-03-31' => '2015-03-31', ], ], 'lex-models' => [ 'namespace' => 'LexModelBuildingService', 'versions' => [ 'latest' => '2017-04-19', '2017-04-19' => '2017-04-19', ], ], 'license-manager' => [ 'namespace' => 'LicenseManager', 'versions' => [ 'latest' => '2018-08-01', '2018-08-01' => '2018-08-01', ], ], 'lightsail' => [ 'namespace' => 'Lightsail', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'logs' => [ 'namespace' => 'CloudWatchLogs', 'versions' => [ 'latest' => '2014-03-28', '2014-03-28' => '2014-03-28', ], ], 'machinelearning' => [ 'namespace' => 'MachineLearning', 'versions' => [ 'latest' => '2014-12-12', '2014-12-12' => '2014-12-12', ], ], 'macie' => [ 'namespace' => 'Macie', 'versions' => [ 'latest' => '2017-12-19', '2017-12-19' => '2017-12-19', ], ], 'marketplacecommerceanalytics' => [ 'namespace' => 'MarketplaceCommerceAnalytics', 'versions' => [ 'latest' => '2015-07-01', '2015-07-01' => '2015-07-01', ], ], 'mediaconnect' => [ 'namespace' => 'MediaConnect', 'versions' => [ 'latest' => '2018-11-14', '2018-11-14' => '2018-11-14', ], ], 'mediaconvert' => [ 'namespace' => 'MediaConvert', 'versions' => [ 'latest' => '2017-08-29', '2017-08-29' => '2017-08-29', ], ], 'medialive' => [ 'namespace' => 'MediaLive', 'versions' => [ 'latest' => '2017-10-14', '2017-10-14' => '2017-10-14', ], ], 'mediapackage' => [ 'namespace' => 'MediaPackage', 'versions' => [ 'latest' => '2017-10-12', '2017-10-12' => '2017-10-12', ], ], 'mediastore-data' => [ 'namespace' => 'MediaStoreData', 'versions' => [ 'latest' => '2017-09-01', '2017-09-01' => '2017-09-01', ], ], 'mediastore' => [ 'namespace' => 'MediaStore', 'versions' => [ 'latest' => '2017-09-01', '2017-09-01' => '2017-09-01', ], ], 'mediatailor' => [ 'namespace' => 'MediaTailor', 'versions' => [ 'latest' => '2018-04-23', '2018-04-23' => '2018-04-23', ], ], 'metering.marketplace' => [ 'namespace' => 'MarketplaceMetering', 'versions' => [ 'latest' => '2016-01-14', '2016-01-14' => '2016-01-14', ], ], 'mgh' => [ 'namespace' => 'MigrationHub', 'versions' => [ 'latest' => '2017-05-31', '2017-05-31' => '2017-05-31', ], ], 'mobile' => [ 'namespace' => 'Mobile', 'versions' => [ 'latest' => '2017-07-01', '2017-07-01' => '2017-07-01', ], ], 'monitoring' => [ 'namespace' => 'CloudWatch', 'versions' => [ 'latest' => '2010-08-01', '2010-08-01' => '2010-08-01', ], ], 'mq' => [ 'namespace' => 'MQ', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'mturk-requester' => [ 'namespace' => 'MTurk', 'versions' => [ 'latest' => '2017-01-17', '2017-01-17' => '2017-01-17', ], ], 'neptune' => [ 'namespace' => 'Neptune', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', ], ], 'opsworks' => [ 'namespace' => 'OpsWorks', 'versions' => [ 'latest' => '2013-02-18', '2013-02-18' => '2013-02-18', ], ], 'opsworkscm' => [ 'namespace' => 'OpsWorksCM', 'versions' => [ 'latest' => '2016-11-01', '2016-11-01' => '2016-11-01', ], ], 'organizations' => [ 'namespace' => 'Organizations', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'pi' => [ 'namespace' => 'PI', 'versions' => [ 'latest' => '2018-02-27', '2018-02-27' => '2018-02-27', ], ], 'pinpoint-email' => [ 'namespace' => 'PinpointEmail', 'versions' => [ 'latest' => '2018-07-26', '2018-07-26' => '2018-07-26', ], ], 'pinpoint' => [ 'namespace' => 'Pinpoint', 'versions' => [ 'latest' => '2016-12-01', '2016-12-01' => '2016-12-01', ], ], 'polly' => [ 'namespace' => 'Polly', 'versions' => [ 'latest' => '2016-06-10', '2016-06-10' => '2016-06-10', ], ], 'pricing' => [ 'namespace' => 'Pricing', 'versions' => [ 'latest' => '2017-10-15', '2017-10-15' => '2017-10-15', ], ], 'quicksight' => [ 'namespace' => 'QuickSight', 'versions' => [ 'latest' => '2018-04-01', '2018-04-01' => '2018-04-01', ], ], 'ram' => [ 'namespace' => 'RAM', 'versions' => [ 'latest' => '2018-01-04', '2018-01-04' => '2018-01-04', ], ], 'rds-data' => [ 'namespace' => 'RDSDataService', 'versions' => [ 'latest' => '2018-08-01', '2018-08-01' => '2018-08-01', ], ], 'rds' => [ 'namespace' => 'Rds', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', '2014-09-01' => '2014-09-01', ], ], 'redshift' => [ 'namespace' => 'Redshift', 'versions' => [ 'latest' => '2012-12-01', '2012-12-01' => '2012-12-01', ], ], 'rekognition' => [ 'namespace' => 'Rekognition', 'versions' => [ 'latest' => '2016-06-27', '2016-06-27' => '2016-06-27', ], ], 'resource-groups' => [ 'namespace' => 'ResourceGroups', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'resourcegroupstaggingapi' => [ 'namespace' => 'ResourceGroupsTaggingAPI', 'versions' => [ 'latest' => '2017-01-26', '2017-01-26' => '2017-01-26', ], ], 'robomaker' => [ 'namespace' => 'RoboMaker', 'versions' => [ 'latest' => '2018-06-29', '2018-06-29' => '2018-06-29', ], ], 'route53' => [ 'namespace' => 'Route53', 'versions' => [ 'latest' => '2013-04-01', '2013-04-01' => '2013-04-01', ], ], 'route53domains' => [ 'namespace' => 'Route53Domains', 'versions' => [ 'latest' => '2014-05-15', '2014-05-15' => '2014-05-15', ], ], 'route53resolver' => [ 'namespace' => 'Route53Resolver', 'versions' => [ 'latest' => '2018-04-01', '2018-04-01' => '2018-04-01', ], ], 'runtime.lex' => [ 'namespace' => 'LexRuntimeService', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'runtime.sagemaker' => [ 'namespace' => 'SageMakerRuntime', 'versions' => [ 'latest' => '2017-05-13', '2017-05-13' => '2017-05-13', ], ], 's3' => [ 'namespace' => 'S3', 'versions' => [ 'latest' => '2006-03-01', '2006-03-01' => '2006-03-01', ], ], 's3control' => [ 'namespace' => 'S3Control', 'versions' => [ 'latest' => '2018-08-20', '2018-08-20' => '2018-08-20', ], ], 'sagemaker' => [ 'namespace' => 'SageMaker', 'versions' => [ 'latest' => '2017-07-24', '2017-07-24' => '2017-07-24', ], ], 'secretsmanager' => [ 'namespace' => 'SecretsManager', 'versions' => [ 'latest' => '2017-10-17', '2017-10-17' => '2017-10-17', ], ], 'securityhub' => [ 'namespace' => 'SecurityHub', 'versions' => [ 'latest' => '2018-10-26', '2018-10-26' => '2018-10-26', ], ], 'serverlessrepo' => [ 'namespace' => 'ServerlessApplicationRepository', 'versions' => [ 'latest' => '2017-09-08', '2017-09-08' => '2017-09-08', ], ], 'servicecatalog' => [ 'namespace' => 'ServiceCatalog', 'versions' => [ 'latest' => '2015-12-10', '2015-12-10' => '2015-12-10', ], ], 'servicediscovery' => [ 'namespace' => 'ServiceDiscovery', 'versions' => [ 'latest' => '2017-03-14', '2017-03-14' => '2017-03-14', ], ], 'shield' => [ 'namespace' => 'Shield', 'versions' => [ 'latest' => '2016-06-02', '2016-06-02' => '2016-06-02', ], ], 'signer' => [ 'namespace' => 'signer', 'versions' => [ 'latest' => '2017-08-25', '2017-08-25' => '2017-08-25', ], ], 'sms-voice' => [ 'namespace' => 'PinpointSMSVoice', 'versions' => [ 'latest' => '2018-09-05', '2018-09-05' => '2018-09-05', ], ], 'sms' => [ 'namespace' => 'Sms', 'versions' => [ 'latest' => '2016-10-24', '2016-10-24' => '2016-10-24', ], ], 'snowball' => [ 'namespace' => 'SnowBall', 'versions' => [ 'latest' => '2016-06-30', '2016-06-30' => '2016-06-30', ], ], 'sns' => [ 'namespace' => 'Sns', 'versions' => [ 'latest' => '2010-03-31', '2010-03-31' => '2010-03-31', ], ], 'sqs' => [ 'namespace' => 'Sqs', 'versions' => [ 'latest' => '2012-11-05', '2012-11-05' => '2012-11-05', ], ], 'ssm' => [ 'namespace' => 'Ssm', 'versions' => [ 'latest' => '2014-11-06', '2014-11-06' => '2014-11-06', ], ], 'states' => [ 'namespace' => 'Sfn', 'versions' => [ 'latest' => '2016-11-23', '2016-11-23' => '2016-11-23', ], ], 'storagegateway' => [ 'namespace' => 'StorageGateway', 'versions' => [ 'latest' => '2013-06-30', '2013-06-30' => '2013-06-30', ], ], 'streams.dynamodb' => [ 'namespace' => 'DynamoDbStreams', 'versions' => [ 'latest' => '2012-08-10', '2012-08-10' => '2012-08-10', ], ], 'sts' => [ 'namespace' => 'Sts', 'versions' => [ 'latest' => '2011-06-15', '2011-06-15' => '2011-06-15', ], ], 'support' => [ 'namespace' => 'Support', 'versions' => [ 'latest' => '2013-04-15', '2013-04-15' => '2013-04-15', ], ], 'swf' => [ 'namespace' => 'Swf', 'versions' => [ 'latest' => '2012-01-25', '2012-01-25' => '2012-01-25', ], ], 'textract' => [ 'namespace' => 'Textract', 'versions' => [ 'latest' => '2018-06-27', '2018-06-27' => '2018-06-27', ], ], 'transcribe' => [ 'namespace' => 'TranscribeService', 'versions' => [ 'latest' => '2017-10-26', '2017-10-26' => '2017-10-26', ], ], 'transfer' => [ 'namespace' => 'Transfer', 'versions' => [ 'latest' => '2018-11-05', '2018-11-05' => '2018-11-05', ], ], 'translate' => [ 'namespace' => 'Translate', 'versions' => [ 'latest' => '2017-07-01', '2017-07-01' => '2017-07-01', ], ], 'waf-regional' => [ 'namespace' => 'WafRegional', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'waf' => [ 'namespace' => 'Waf', 'versions' => [ 'latest' => '2015-08-24', '2015-08-24' => '2015-08-24', ], ], 'workdocs' => [ 'namespace' => 'WorkDocs', 'versions' => [ 'latest' => '2016-05-01', '2016-05-01' => '2016-05-01', ], ], 'worklink' => [ 'namespace' => 'WorkLink', 'versions' => [ 'latest' => '2018-09-25', '2018-09-25' => '2018-09-25', ], ], 'workmail' => [ 'namespace' => 'WorkMail', 'versions' => [ 'latest' => '2017-10-01', '2017-10-01' => '2017-10-01', ], ], 'workspaces' => [ 'namespace' => 'WorkSpaces', 'versions' => [ 'latest' => '2015-04-08', '2015-04-08' => '2015-04-08', ], ], 'xray' => [ 'namespace' => 'XRay', 'versions' => [ 'latest' => '2016-04-12', '2016-04-12' => '2016-04-12', ], ],]; +return [ 'acm-pca' => [ 'namespace' => 'ACMPCA', 'versions' => [ 'latest' => '2017-08-22', '2017-08-22' => '2017-08-22', ], ], 'acm' => [ 'namespace' => 'Acm', 'versions' => [ 'latest' => '2015-12-08', '2015-12-08' => '2015-12-08', ], ], 'alexaforbusiness' => [ 'namespace' => 'AlexaForBusiness', 'versions' => [ 'latest' => '2017-11-09', '2017-11-09' => '2017-11-09', ], ], 'amplify' => [ 'namespace' => 'Amplify', 'versions' => [ 'latest' => '2017-07-25', '2017-07-25' => '2017-07-25', ], ], 'apigateway' => [ 'namespace' => 'ApiGateway', 'versions' => [ 'latest' => '2015-07-09', '2015-07-09' => '2015-07-09', '2015-06-01' => '2015-07-09', ], ], 'apigatewaymanagementapi' => [ 'namespace' => 'ApiGatewayManagementApi', 'versions' => [ 'latest' => '2018-11-29', '2018-11-29' => '2018-11-29', ], ], 'apigatewayv2' => [ 'namespace' => 'ApiGatewayV2', 'versions' => [ 'latest' => '2018-11-29', '2018-11-29' => '2018-11-29', ], ], 'application-autoscaling' => [ 'namespace' => 'ApplicationAutoScaling', 'versions' => [ 'latest' => '2016-02-06', '2016-02-06' => '2016-02-06', ], ], 'appmesh' => [ 'namespace' => 'AppMesh', 'versions' => [ 'latest' => '2019-01-25', '2019-01-25' => '2019-01-25', '2018-10-01' => '2018-10-01', ], ], 'appstream' => [ 'namespace' => 'Appstream', 'versions' => [ 'latest' => '2016-12-01', '2016-12-01' => '2016-12-01', ], ], 'appsync' => [ 'namespace' => 'AppSync', 'versions' => [ 'latest' => '2017-07-25', '2017-07-25' => '2017-07-25', ], ], 'athena' => [ 'namespace' => 'Athena', 'versions' => [ 'latest' => '2017-05-18', '2017-05-18' => '2017-05-18', ], ], 'autoscaling-plans' => [ 'namespace' => 'AutoScalingPlans', 'versions' => [ 'latest' => '2018-01-06', '2018-01-06' => '2018-01-06', ], ], 'autoscaling' => [ 'namespace' => 'AutoScaling', 'versions' => [ 'latest' => '2011-01-01', '2011-01-01' => '2011-01-01', ], ], 'backup' => [ 'namespace' => 'Backup', 'versions' => [ 'latest' => '2018-11-15', '2018-11-15' => '2018-11-15', ], ], 'batch' => [ 'namespace' => 'Batch', 'versions' => [ 'latest' => '2016-08-10', '2016-08-10' => '2016-08-10', ], ], 'budgets' => [ 'namespace' => 'Budgets', 'versions' => [ 'latest' => '2016-10-20', '2016-10-20' => '2016-10-20', ], ], 'ce' => [ 'namespace' => 'CostExplorer', 'versions' => [ 'latest' => '2017-10-25', '2017-10-25' => '2017-10-25', ], ], 'chime' => [ 'namespace' => 'Chime', 'versions' => [ 'latest' => '2018-05-01', '2018-05-01' => '2018-05-01', ], ], 'cloud9' => [ 'namespace' => 'Cloud9', 'versions' => [ 'latest' => '2017-09-23', '2017-09-23' => '2017-09-23', ], ], 'clouddirectory' => [ 'namespace' => 'CloudDirectory', 'versions' => [ 'latest' => '2017-01-11', '2017-01-11' => '2017-01-11', '2016-05-10' => '2016-05-10', ], ], 'cloudformation' => [ 'namespace' => 'CloudFormation', 'versions' => [ 'latest' => '2010-05-15', '2010-05-15' => '2010-05-15', ], ], 'cloudfront' => [ 'namespace' => 'CloudFront', 'versions' => [ 'latest' => '2018-11-05', '2018-11-05' => '2018-11-05', '2018-06-18' => '2018-06-18', '2017-10-30' => '2017-10-30', '2017-03-25' => '2017-03-25', '2016-11-25' => '2016-11-25', '2016-09-29' => '2016-09-29', '2016-09-07' => '2016-09-07', '2016-08-20' => '2016-08-20', '2016-08-01' => '2016-08-01', '2016-01-28' => '2016-01-28', '2016-01-13' => '2018-11-05', '2015-09-17' => '2018-11-05', '2015-07-27' => '2015-07-27', '2015-04-17' => '2015-07-27', '2014-11-06' => '2015-07-27', ], ], 'cloudhsm' => [ 'namespace' => 'CloudHsm', 'versions' => [ 'latest' => '2014-05-30', '2014-05-30' => '2014-05-30', ], ], 'cloudhsmv2' => [ 'namespace' => 'CloudHSMV2', 'versions' => [ 'latest' => '2017-04-28', '2017-04-28' => '2017-04-28', ], ], 'cloudsearch' => [ 'namespace' => 'CloudSearch', 'versions' => [ 'latest' => '2013-01-01', '2013-01-01' => '2013-01-01', ], ], 'cloudsearchdomain' => [ 'namespace' => 'CloudSearchDomain', 'versions' => [ 'latest' => '2013-01-01', '2013-01-01' => '2013-01-01', ], ], 'cloudtrail' => [ 'namespace' => 'CloudTrail', 'versions' => [ 'latest' => '2013-11-01', '2013-11-01' => '2013-11-01', ], ], 'codebuild' => [ 'namespace' => 'CodeBuild', 'versions' => [ 'latest' => '2016-10-06', '2016-10-06' => '2016-10-06', ], ], 'codecommit' => [ 'namespace' => 'CodeCommit', 'versions' => [ 'latest' => '2015-04-13', '2015-04-13' => '2015-04-13', ], ], 'codedeploy' => [ 'namespace' => 'CodeDeploy', 'versions' => [ 'latest' => '2014-10-06', '2014-10-06' => '2014-10-06', ], ], 'codepipeline' => [ 'namespace' => 'CodePipeline', 'versions' => [ 'latest' => '2015-07-09', '2015-07-09' => '2015-07-09', ], ], 'codestar' => [ 'namespace' => 'CodeStar', 'versions' => [ 'latest' => '2017-04-19', '2017-04-19' => '2017-04-19', ], ], 'cognito-identity' => [ 'namespace' => 'CognitoIdentity', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'cognito-idp' => [ 'namespace' => 'CognitoIdentityProvider', 'versions' => [ 'latest' => '2016-04-18', '2016-04-18' => '2016-04-18', ], ], 'cognito-sync' => [ 'namespace' => 'CognitoSync', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'comprehend' => [ 'namespace' => 'Comprehend', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'comprehendmedical' => [ 'namespace' => 'ComprehendMedical', 'versions' => [ 'latest' => '2018-10-30', '2018-10-30' => '2018-10-30', ], ], 'config' => [ 'namespace' => 'ConfigService', 'versions' => [ 'latest' => '2014-11-12', '2014-11-12' => '2014-11-12', ], ], 'connect' => [ 'namespace' => 'Connect', 'versions' => [ 'latest' => '2017-08-08', '2017-08-08' => '2017-08-08', ], ], 'cur' => [ 'namespace' => 'CostandUsageReportService', 'versions' => [ 'latest' => '2017-01-06', '2017-01-06' => '2017-01-06', ], ], 'data.iot' => [ 'namespace' => 'IotDataPlane', 'versions' => [ 'latest' => '2015-05-28', '2015-05-28' => '2015-05-28', ], ], 'datapipeline' => [ 'namespace' => 'DataPipeline', 'versions' => [ 'latest' => '2012-10-29', '2012-10-29' => '2012-10-29', ], ], 'datasync' => [ 'namespace' => 'DataSync', 'versions' => [ 'latest' => '2018-11-09', '2018-11-09' => '2018-11-09', ], ], 'dax' => [ 'namespace' => 'DAX', 'versions' => [ 'latest' => '2017-04-19', '2017-04-19' => '2017-04-19', ], ], 'devicefarm' => [ 'namespace' => 'DeviceFarm', 'versions' => [ 'latest' => '2015-06-23', '2015-06-23' => '2015-06-23', ], ], 'directconnect' => [ 'namespace' => 'DirectConnect', 'versions' => [ 'latest' => '2012-10-25', '2012-10-25' => '2012-10-25', ], ], 'discovery' => [ 'namespace' => 'ApplicationDiscoveryService', 'versions' => [ 'latest' => '2015-11-01', '2015-11-01' => '2015-11-01', ], ], 'dlm' => [ 'namespace' => 'DLM', 'versions' => [ 'latest' => '2018-01-12', '2018-01-12' => '2018-01-12', ], ], 'dms' => [ 'namespace' => 'DatabaseMigrationService', 'versions' => [ 'latest' => '2016-01-01', '2016-01-01' => '2016-01-01', ], ], 'docdb' => [ 'namespace' => 'DocDB', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', ], ], 'ds' => [ 'namespace' => 'DirectoryService', 'versions' => [ 'latest' => '2015-04-16', '2015-04-16' => '2015-04-16', ], ], 'dynamodb' => [ 'namespace' => 'DynamoDb', 'versions' => [ 'latest' => '2012-08-10', '2012-08-10' => '2012-08-10', '2011-12-05' => '2011-12-05', ], ], 'ec2' => [ 'namespace' => 'Ec2', 'versions' => [ 'latest' => '2016-11-15', '2016-11-15' => '2016-11-15', '2016-09-15' => '2016-09-15', '2016-04-01' => '2016-04-01', '2015-10-01' => '2015-10-01', '2015-04-15' => '2016-11-15', ], ], 'ecr' => [ 'namespace' => 'Ecr', 'versions' => [ 'latest' => '2015-09-21', '2015-09-21' => '2015-09-21', ], ], 'ecs' => [ 'namespace' => 'Ecs', 'versions' => [ 'latest' => '2014-11-13', '2014-11-13' => '2014-11-13', ], ], 'eks' => [ 'namespace' => 'EKS', 'versions' => [ 'latest' => '2017-11-01', '2017-11-01' => '2017-11-01', ], ], 'elasticache' => [ 'namespace' => 'ElastiCache', 'versions' => [ 'latest' => '2015-02-02', '2015-02-02' => '2015-02-02', ], ], 'elasticbeanstalk' => [ 'namespace' => 'ElasticBeanstalk', 'versions' => [ 'latest' => '2010-12-01', '2010-12-01' => '2010-12-01', ], ], 'elasticfilesystem' => [ 'namespace' => 'Efs', 'versions' => [ 'latest' => '2015-02-01', '2015-02-01' => '2015-02-01', ], ], 'elasticloadbalancing' => [ 'namespace' => 'ElasticLoadBalancing', 'versions' => [ 'latest' => '2012-06-01', '2012-06-01' => '2012-06-01', ], ], 'elasticloadbalancingv2' => [ 'namespace' => 'ElasticLoadBalancingV2', 'versions' => [ 'latest' => '2015-12-01', '2015-12-01' => '2015-12-01', ], ], 'elasticmapreduce' => [ 'namespace' => 'Emr', 'versions' => [ 'latest' => '2009-03-31', '2009-03-31' => '2009-03-31', ], ], 'elastictranscoder' => [ 'namespace' => 'ElasticTranscoder', 'versions' => [ 'latest' => '2012-09-25', '2012-09-25' => '2012-09-25', ], ], 'email' => [ 'namespace' => 'Ses', 'versions' => [ 'latest' => '2010-12-01', '2010-12-01' => '2010-12-01', ], ], 'entitlement.marketplace' => [ 'namespace' => 'MarketplaceEntitlementService', 'versions' => [ 'latest' => '2017-01-11', '2017-01-11' => '2017-01-11', ], ], 'es' => [ 'namespace' => 'ElasticsearchService', 'versions' => [ 'latest' => '2015-01-01', '2015-01-01' => '2015-01-01', ], ], 'events' => [ 'namespace' => 'CloudWatchEvents', 'versions' => [ 'latest' => '2015-10-07', '2015-10-07' => '2015-10-07', '2014-02-03' => '2015-10-07', ], ], 'firehose' => [ 'namespace' => 'Firehose', 'versions' => [ 'latest' => '2015-08-04', '2015-08-04' => '2015-08-04', ], ], 'fms' => [ 'namespace' => 'FMS', 'versions' => [ 'latest' => '2018-01-01', '2018-01-01' => '2018-01-01', ], ], 'fsx' => [ 'namespace' => 'FSx', 'versions' => [ 'latest' => '2018-03-01', '2018-03-01' => '2018-03-01', ], ], 'gamelift' => [ 'namespace' => 'GameLift', 'versions' => [ 'latest' => '2015-10-01', '2015-10-01' => '2015-10-01', ], ], 'glacier' => [ 'namespace' => 'Glacier', 'versions' => [ 'latest' => '2012-06-01', '2012-06-01' => '2012-06-01', ], ], 'globalaccelerator' => [ 'namespace' => 'GlobalAccelerator', 'versions' => [ 'latest' => '2018-08-08', '2018-08-08' => '2018-08-08', ], ], 'glue' => [ 'namespace' => 'Glue', 'versions' => [ 'latest' => '2017-03-31', '2017-03-31' => '2017-03-31', ], ], 'greengrass' => [ 'namespace' => 'Greengrass', 'versions' => [ 'latest' => '2017-06-07', '2017-06-07' => '2017-06-07', ], ], 'guardduty' => [ 'namespace' => 'GuardDuty', 'versions' => [ 'latest' => '2017-11-28', '2017-11-28' => '2017-11-28', ], ], 'health' => [ 'namespace' => 'Health', 'versions' => [ 'latest' => '2016-08-04', '2016-08-04' => '2016-08-04', ], ], 'iam' => [ 'namespace' => 'Iam', 'versions' => [ 'latest' => '2010-05-08', '2010-05-08' => '2010-05-08', ], ], 'importexport' => [ 'namespace' => 'ImportExport', 'versions' => [ 'latest' => '2010-06-01', '2010-06-01' => '2010-06-01', ], ], 'inspector' => [ 'namespace' => 'Inspector', 'versions' => [ 'latest' => '2016-02-16', '2016-02-16' => '2016-02-16', '2015-08-18' => '2016-02-16', ], ], 'iot-jobs-data' => [ 'namespace' => 'IoTJobsDataPlane', 'versions' => [ 'latest' => '2017-09-29', '2017-09-29' => '2017-09-29', ], ], 'iot' => [ 'namespace' => 'Iot', 'versions' => [ 'latest' => '2015-05-28', '2015-05-28' => '2015-05-28', ], ], 'iot1click-devices' => [ 'namespace' => 'IoT1ClickDevicesService', 'versions' => [ 'latest' => '2018-05-14', '2018-05-14' => '2018-05-14', ], ], 'iot1click-projects' => [ 'namespace' => 'IoT1ClickProjects', 'versions' => [ 'latest' => '2018-05-14', '2018-05-14' => '2018-05-14', ], ], 'iotanalytics' => [ 'namespace' => 'IoTAnalytics', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'kafka' => [ 'namespace' => 'Kafka', 'versions' => [ 'latest' => '2018-11-14', '2018-11-14' => '2018-11-14', ], ], 'kinesis-video-archived-media' => [ 'namespace' => 'KinesisVideoArchivedMedia', 'versions' => [ 'latest' => '2017-09-30', '2017-09-30' => '2017-09-30', ], ], 'kinesis-video-media' => [ 'namespace' => 'KinesisVideoMedia', 'versions' => [ 'latest' => '2017-09-30', '2017-09-30' => '2017-09-30', ], ], 'kinesis' => [ 'namespace' => 'Kinesis', 'versions' => [ 'latest' => '2013-12-02', '2013-12-02' => '2013-12-02', ], ], 'kinesisanalytics' => [ 'namespace' => 'KinesisAnalytics', 'versions' => [ 'latest' => '2015-08-14', '2015-08-14' => '2015-08-14', ], ], 'kinesisanalyticsv2' => [ 'namespace' => 'KinesisAnalyticsV2', 'versions' => [ 'latest' => '2018-05-23', '2018-05-23' => '2018-05-23', ], ], 'kinesisvideo' => [ 'namespace' => 'KinesisVideo', 'versions' => [ 'latest' => '2017-09-30', '2017-09-30' => '2017-09-30', ], ], 'kms' => [ 'namespace' => 'Kms', 'versions' => [ 'latest' => '2014-11-01', '2014-11-01' => '2014-11-01', ], ], 'lambda' => [ 'namespace' => 'Lambda', 'versions' => [ 'latest' => '2015-03-31', '2015-03-31' => '2015-03-31', ], ], 'lex-models' => [ 'namespace' => 'LexModelBuildingService', 'versions' => [ 'latest' => '2017-04-19', '2017-04-19' => '2017-04-19', ], ], 'license-manager' => [ 'namespace' => 'LicenseManager', 'versions' => [ 'latest' => '2018-08-01', '2018-08-01' => '2018-08-01', ], ], 'lightsail' => [ 'namespace' => 'Lightsail', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'logs' => [ 'namespace' => 'CloudWatchLogs', 'versions' => [ 'latest' => '2014-03-28', '2014-03-28' => '2014-03-28', ], ], 'machinelearning' => [ 'namespace' => 'MachineLearning', 'versions' => [ 'latest' => '2014-12-12', '2014-12-12' => '2014-12-12', ], ], 'macie' => [ 'namespace' => 'Macie', 'versions' => [ 'latest' => '2017-12-19', '2017-12-19' => '2017-12-19', ], ], 'marketplacecommerceanalytics' => [ 'namespace' => 'MarketplaceCommerceAnalytics', 'versions' => [ 'latest' => '2015-07-01', '2015-07-01' => '2015-07-01', ], ], 'mediaconnect' => [ 'namespace' => 'MediaConnect', 'versions' => [ 'latest' => '2018-11-14', '2018-11-14' => '2018-11-14', ], ], 'mediaconvert' => [ 'namespace' => 'MediaConvert', 'versions' => [ 'latest' => '2017-08-29', '2017-08-29' => '2017-08-29', ], ], 'medialive' => [ 'namespace' => 'MediaLive', 'versions' => [ 'latest' => '2017-10-14', '2017-10-14' => '2017-10-14', ], ], 'mediapackage' => [ 'namespace' => 'MediaPackage', 'versions' => [ 'latest' => '2017-10-12', '2017-10-12' => '2017-10-12', ], ], 'mediastore-data' => [ 'namespace' => 'MediaStoreData', 'versions' => [ 'latest' => '2017-09-01', '2017-09-01' => '2017-09-01', ], ], 'mediastore' => [ 'namespace' => 'MediaStore', 'versions' => [ 'latest' => '2017-09-01', '2017-09-01' => '2017-09-01', ], ], 'mediatailor' => [ 'namespace' => 'MediaTailor', 'versions' => [ 'latest' => '2018-04-23', '2018-04-23' => '2018-04-23', ], ], 'metering.marketplace' => [ 'namespace' => 'MarketplaceMetering', 'versions' => [ 'latest' => '2016-01-14', '2016-01-14' => '2016-01-14', ], ], 'mgh' => [ 'namespace' => 'MigrationHub', 'versions' => [ 'latest' => '2017-05-31', '2017-05-31' => '2017-05-31', ], ], 'mobile' => [ 'namespace' => 'Mobile', 'versions' => [ 'latest' => '2017-07-01', '2017-07-01' => '2017-07-01', ], ], 'monitoring' => [ 'namespace' => 'CloudWatch', 'versions' => [ 'latest' => '2010-08-01', '2010-08-01' => '2010-08-01', ], ], 'mq' => [ 'namespace' => 'MQ', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'mturk-requester' => [ 'namespace' => 'MTurk', 'versions' => [ 'latest' => '2017-01-17', '2017-01-17' => '2017-01-17', ], ], 'neptune' => [ 'namespace' => 'Neptune', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', ], ], 'opsworks' => [ 'namespace' => 'OpsWorks', 'versions' => [ 'latest' => '2013-02-18', '2013-02-18' => '2013-02-18', ], ], 'opsworkscm' => [ 'namespace' => 'OpsWorksCM', 'versions' => [ 'latest' => '2016-11-01', '2016-11-01' => '2016-11-01', ], ], 'organizations' => [ 'namespace' => 'Organizations', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'pi' => [ 'namespace' => 'PI', 'versions' => [ 'latest' => '2018-02-27', '2018-02-27' => '2018-02-27', ], ], 'pinpoint-email' => [ 'namespace' => 'PinpointEmail', 'versions' => [ 'latest' => '2018-07-26', '2018-07-26' => '2018-07-26', ], ], 'pinpoint' => [ 'namespace' => 'Pinpoint', 'versions' => [ 'latest' => '2016-12-01', '2016-12-01' => '2016-12-01', ], ], 'polly' => [ 'namespace' => 'Polly', 'versions' => [ 'latest' => '2016-06-10', '2016-06-10' => '2016-06-10', ], ], 'pricing' => [ 'namespace' => 'Pricing', 'versions' => [ 'latest' => '2017-10-15', '2017-10-15' => '2017-10-15', ], ], 'quicksight' => [ 'namespace' => 'QuickSight', 'versions' => [ 'latest' => '2018-04-01', '2018-04-01' => '2018-04-01', ], ], 'ram' => [ 'namespace' => 'RAM', 'versions' => [ 'latest' => '2018-01-04', '2018-01-04' => '2018-01-04', ], ], 'rds-data' => [ 'namespace' => 'RDSDataService', 'versions' => [ 'latest' => '2018-08-01', '2018-08-01' => '2018-08-01', ], ], 'rds' => [ 'namespace' => 'Rds', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', '2014-09-01' => '2014-09-01', ], ], 'redshift' => [ 'namespace' => 'Redshift', 'versions' => [ 'latest' => '2012-12-01', '2012-12-01' => '2012-12-01', ], ], 'rekognition' => [ 'namespace' => 'Rekognition', 'versions' => [ 'latest' => '2016-06-27', '2016-06-27' => '2016-06-27', ], ], 'resource-groups' => [ 'namespace' => 'ResourceGroups', 'versions' => [ 'latest' => '2017-11-27', '2017-11-27' => '2017-11-27', ], ], 'resourcegroupstaggingapi' => [ 'namespace' => 'ResourceGroupsTaggingAPI', 'versions' => [ 'latest' => '2017-01-26', '2017-01-26' => '2017-01-26', ], ], 'robomaker' => [ 'namespace' => 'RoboMaker', 'versions' => [ 'latest' => '2018-06-29', '2018-06-29' => '2018-06-29', ], ], 'route53' => [ 'namespace' => 'Route53', 'versions' => [ 'latest' => '2013-04-01', '2013-04-01' => '2013-04-01', ], ], 'route53domains' => [ 'namespace' => 'Route53Domains', 'versions' => [ 'latest' => '2014-05-15', '2014-05-15' => '2014-05-15', ], ], 'route53resolver' => [ 'namespace' => 'Route53Resolver', 'versions' => [ 'latest' => '2018-04-01', '2018-04-01' => '2018-04-01', ], ], 'runtime.lex' => [ 'namespace' => 'LexRuntimeService', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'runtime.sagemaker' => [ 'namespace' => 'SageMakerRuntime', 'versions' => [ 'latest' => '2017-05-13', '2017-05-13' => '2017-05-13', ], ], 's3' => [ 'namespace' => 'S3', 'versions' => [ 'latest' => '2006-03-01', '2006-03-01' => '2006-03-01', ], ], 's3control' => [ 'namespace' => 'S3Control', 'versions' => [ 'latest' => '2018-08-20', '2018-08-20' => '2018-08-20', ], ], 'sagemaker' => [ 'namespace' => 'SageMaker', 'versions' => [ 'latest' => '2017-07-24', '2017-07-24' => '2017-07-24', ], ], 'secretsmanager' => [ 'namespace' => 'SecretsManager', 'versions' => [ 'latest' => '2017-10-17', '2017-10-17' => '2017-10-17', ], ], 'securityhub' => [ 'namespace' => 'SecurityHub', 'versions' => [ 'latest' => '2018-10-26', '2018-10-26' => '2018-10-26', ], ], 'serverlessrepo' => [ 'namespace' => 'ServerlessApplicationRepository', 'versions' => [ 'latest' => '2017-09-08', '2017-09-08' => '2017-09-08', ], ], 'servicecatalog' => [ 'namespace' => 'ServiceCatalog', 'versions' => [ 'latest' => '2015-12-10', '2015-12-10' => '2015-12-10', ], ], 'servicediscovery' => [ 'namespace' => 'ServiceDiscovery', 'versions' => [ 'latest' => '2017-03-14', '2017-03-14' => '2017-03-14', ], ], 'shield' => [ 'namespace' => 'Shield', 'versions' => [ 'latest' => '2016-06-02', '2016-06-02' => '2016-06-02', ], ], 'signer' => [ 'namespace' => 'signer', 'versions' => [ 'latest' => '2017-08-25', '2017-08-25' => '2017-08-25', ], ], 'sms-voice' => [ 'namespace' => 'PinpointSMSVoice', 'versions' => [ 'latest' => '2018-09-05', '2018-09-05' => '2018-09-05', ], ], 'sms' => [ 'namespace' => 'Sms', 'versions' => [ 'latest' => '2016-10-24', '2016-10-24' => '2016-10-24', ], ], 'snowball' => [ 'namespace' => 'SnowBall', 'versions' => [ 'latest' => '2016-06-30', '2016-06-30' => '2016-06-30', ], ], 'sns' => [ 'namespace' => 'Sns', 'versions' => [ 'latest' => '2010-03-31', '2010-03-31' => '2010-03-31', ], ], 'sqs' => [ 'namespace' => 'Sqs', 'versions' => [ 'latest' => '2012-11-05', '2012-11-05' => '2012-11-05', ], ], 'ssm' => [ 'namespace' => 'Ssm', 'versions' => [ 'latest' => '2014-11-06', '2014-11-06' => '2014-11-06', ], ], 'states' => [ 'namespace' => 'Sfn', 'versions' => [ 'latest' => '2016-11-23', '2016-11-23' => '2016-11-23', ], ], 'storagegateway' => [ 'namespace' => 'StorageGateway', 'versions' => [ 'latest' => '2013-06-30', '2013-06-30' => '2013-06-30', ], ], 'streams.dynamodb' => [ 'namespace' => 'DynamoDbStreams', 'versions' => [ 'latest' => '2012-08-10', '2012-08-10' => '2012-08-10', ], ], 'sts' => [ 'namespace' => 'Sts', 'versions' => [ 'latest' => '2011-06-15', '2011-06-15' => '2011-06-15', ], ], 'support' => [ 'namespace' => 'Support', 'versions' => [ 'latest' => '2013-04-15', '2013-04-15' => '2013-04-15', ], ], 'swf' => [ 'namespace' => 'Swf', 'versions' => [ 'latest' => '2012-01-25', '2012-01-25' => '2012-01-25', ], ], 'textract' => [ 'namespace' => 'Textract', 'versions' => [ 'latest' => '2018-06-27', '2018-06-27' => '2018-06-27', ], ], 'transcribe' => [ 'namespace' => 'TranscribeService', 'versions' => [ 'latest' => '2017-10-26', '2017-10-26' => '2017-10-26', ], ], 'transfer' => [ 'namespace' => 'Transfer', 'versions' => [ 'latest' => '2018-11-05', '2018-11-05' => '2018-11-05', ], ], 'translate' => [ 'namespace' => 'Translate', 'versions' => [ 'latest' => '2017-07-01', '2017-07-01' => '2017-07-01', ], ], 'waf-regional' => [ 'namespace' => 'WafRegional', 'versions' => [ 'latest' => '2016-11-28', '2016-11-28' => '2016-11-28', ], ], 'waf' => [ 'namespace' => 'Waf', 'versions' => [ 'latest' => '2015-08-24', '2015-08-24' => '2015-08-24', ], ], 'workdocs' => [ 'namespace' => 'WorkDocs', 'versions' => [ 'latest' => '2016-05-01', '2016-05-01' => '2016-05-01', ], ], 'worklink' => [ 'namespace' => 'WorkLink', 'versions' => [ 'latest' => '2018-09-25', '2018-09-25' => '2018-09-25', ], ], 'workmail' => [ 'namespace' => 'WorkMail', 'versions' => [ 'latest' => '2017-10-01', '2017-10-01' => '2017-10-01', ], ], 'workspaces' => [ 'namespace' => 'WorkSpaces', 'versions' => [ 'latest' => '2015-04-08', '2015-04-08' => '2015-04-08', ], ], 'xray' => [ 'namespace' => 'XRay', 'versions' => [ 'latest' => '2016-04-12', '2016-04-12' => '2016-04-12', ], ],]; diff --git a/src/data/medialive/2017-10-14/api-2.json b/src/data/medialive/2017-10-14/api-2.json index c7f2aab1dc..0b1b284400 100644 --- a/src/data/medialive/2017-10-14/api-2.json +++ b/src/data/medialive/2017-10-14/api-2.json @@ -5742,6 +5742,32 @@ } } }, + "MediaPackageGroupSettings": { + "type": "structure", + "members": { + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination" + } + }, + "required": [ + "Destination" + ] + }, + "MediaPackageOutputDestinationSettings": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__stringMin1", + "locationName": "channelId" + } + } + }, + "MediaPackageOutputSettings": { + "type": "structure", + "members": { + } + }, "Mp2CodingMode": { "type": "string", "enum": [ @@ -5988,6 +6014,10 @@ "shape": "__string", "locationName": "id" }, + "MediaPackageSettings": { + "shape": "__listOfMediaPackageOutputDestinationSettings", + "locationName": "mediaPackageSettings" + }, "Settings": { "shape": "__listOfOutputDestinationSettings", "locationName": "settings" @@ -6051,6 +6081,10 @@ "shape": "HlsGroupSettings", "locationName": "hlsGroupSettings" }, + "MediaPackageGroupSettings": { + "shape": "MediaPackageGroupSettings", + "locationName": "mediaPackageGroupSettings" + }, "MsSmoothGroupSettings": { "shape": "MsSmoothGroupSettings", "locationName": "msSmoothGroupSettings" @@ -6089,6 +6123,10 @@ "shape": "HlsOutputSettings", "locationName": "hlsOutputSettings" }, + "MediaPackageOutputSettings": { + "shape": "MediaPackageOutputSettings", + "locationName": "mediaPackageOutputSettings" + }, "MsSmoothOutputSettings": { "shape": "MsSmoothOutputSettings", "locationName": "msSmoothOutputSettings" @@ -8038,6 +8076,12 @@ "shape": "MediaConnectFlowRequest" } }, + "__listOfMediaPackageOutputDestinationSettings": { + "type": "list", + "member": { + "shape": "MediaPackageOutputDestinationSettings" + } + }, "__listOfOffering": { "type": "list", "member": { diff --git a/src/data/medialive/2017-10-14/api-2.json.php b/src/data/medialive/2017-10-14/api-2.json.php index 426832708d..a59c9ce6a1 100644 --- a/src/data/medialive/2017-10-14/api-2.json.php +++ b/src/data/medialive/2017-10-14/api-2.json.php @@ -1,3 +1,3 @@ [ 'apiVersion' => '2017-10-14', 'endpointPrefix' => 'medialive', 'signingName' => 'medialive', 'serviceFullName' => 'AWS Elemental MediaLive', 'serviceId' => 'MediaLive', 'protocol' => 'rest-json', 'jsonVersion' => '1.1', 'uid' => 'medialive-2017-10-14', 'signatureVersion' => 'v4', 'serviceAbbreviation' => 'MediaLive', ], 'operations' => [ 'BatchUpdateSchedule' => [ 'name' => 'BatchUpdateSchedule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/channels/{channelId}/schedule', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchUpdateScheduleRequest', ], 'output' => [ 'shape' => 'BatchUpdateScheduleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'CreateChannel' => [ 'name' => 'CreateChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/channels', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateChannelRequest', ], 'output' => [ 'shape' => 'CreateChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateInput' => [ 'name' => 'CreateInput', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/inputs', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateInputRequest', ], 'output' => [ 'shape' => 'CreateInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'CreateInputSecurityGroup' => [ 'name' => 'CreateInputSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/inputSecurityGroups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'CreateInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'CreateTags' => [ 'name' => 'CreateTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/tags/{resource-arn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'CreateTagsRequest', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'DeleteChannel' => [ 'name' => 'DeleteChannel', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/channels/{channelId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteChannelRequest', ], 'output' => [ 'shape' => 'DeleteChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteInput' => [ 'name' => 'DeleteInput', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/inputs/{inputId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteInputRequest', ], 'output' => [ 'shape' => 'DeleteInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteInputSecurityGroup' => [ 'name' => 'DeleteInputSecurityGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/inputSecurityGroups/{inputSecurityGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'DeleteInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DeleteReservation' => [ 'name' => 'DeleteReservation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/reservations/{reservationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteReservationRequest', ], 'output' => [ 'shape' => 'DeleteReservationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/tags/{resource-arn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteTagsRequest', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'DescribeChannel' => [ 'name' => 'DescribeChannel', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/channels/{channelId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeChannelRequest', ], 'output' => [ 'shape' => 'DescribeChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeInput' => [ 'name' => 'DescribeInput', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputs/{inputId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeInputRequest', ], 'output' => [ 'shape' => 'DescribeInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeInputSecurityGroup' => [ 'name' => 'DescribeInputSecurityGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputSecurityGroups/{inputSecurityGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'DescribeInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeOffering' => [ 'name' => 'DescribeOffering', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/offerings/{offeringId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeOfferingRequest', ], 'output' => [ 'shape' => 'DescribeOfferingResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeReservation' => [ 'name' => 'DescribeReservation', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/reservations/{reservationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeReservationRequest', ], 'output' => [ 'shape' => 'DescribeReservationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeSchedule' => [ 'name' => 'DescribeSchedule', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/channels/{channelId}/schedule', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeScheduleRequest', ], 'output' => [ 'shape' => 'DescribeScheduleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListChannels' => [ 'name' => 'ListChannels', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/channels', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListChannelsRequest', ], 'output' => [ 'shape' => 'ListChannelsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListInputSecurityGroups' => [ 'name' => 'ListInputSecurityGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputSecurityGroups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListInputSecurityGroupsRequest', ], 'output' => [ 'shape' => 'ListInputSecurityGroupsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListInputs' => [ 'name' => 'ListInputs', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListInputsRequest', ], 'output' => [ 'shape' => 'ListInputsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListOfferings' => [ 'name' => 'ListOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/offerings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListOfferingsRequest', ], 'output' => [ 'shape' => 'ListOfferingsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListReservations' => [ 'name' => 'ListReservations', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/reservations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReservationsRequest', ], 'output' => [ 'shape' => 'ListReservationsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/tags/{resource-arn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'PurchaseOffering' => [ 'name' => 'PurchaseOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/offerings/{offeringId}/purchase', 'responseCode' => 201, ], 'input' => [ 'shape' => 'PurchaseOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseOfferingResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'StartChannel' => [ 'name' => 'StartChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/channels/{channelId}/start', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartChannelRequest', ], 'output' => [ 'shape' => 'StartChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'StopChannel' => [ 'name' => 'StopChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/channels/{channelId}/stop', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StopChannelRequest', ], 'output' => [ 'shape' => 'StopChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateChannel' => [ 'name' => 'UpdateChannel', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/channels/{channelId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateChannelRequest', ], 'output' => [ 'shape' => 'UpdateChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateInput' => [ 'name' => 'UpdateInput', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/inputs/{inputId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateInputRequest', ], 'output' => [ 'shape' => 'UpdateInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateInputSecurityGroup' => [ 'name' => 'UpdateInputSecurityGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/inputSecurityGroups/{inputSecurityGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'UpdateInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'ConflictException', ], ], ], ], 'shapes' => [ 'AacCodingMode' => [ 'type' => 'string', 'enum' => [ 'AD_RECEIVER_MIX', 'CODING_MODE_1_0', 'CODING_MODE_1_1', 'CODING_MODE_2_0', 'CODING_MODE_5_1', ], ], 'AacInputType' => [ 'type' => 'string', 'enum' => [ 'BROADCASTER_MIXED_AD', 'NORMAL', ], ], 'AacProfile' => [ 'type' => 'string', 'enum' => [ 'HEV1', 'HEV2', 'LC', ], ], 'AacRateControlMode' => [ 'type' => 'string', 'enum' => [ 'CBR', 'VBR', ], ], 'AacRawFormat' => [ 'type' => 'string', 'enum' => [ 'LATM_LOAS', 'NONE', ], ], 'AacSettings' => [ 'type' => 'structure', 'members' => [ 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'CodingMode' => [ 'shape' => 'AacCodingMode', 'locationName' => 'codingMode', ], 'InputType' => [ 'shape' => 'AacInputType', 'locationName' => 'inputType', ], 'Profile' => [ 'shape' => 'AacProfile', 'locationName' => 'profile', ], 'RateControlMode' => [ 'shape' => 'AacRateControlMode', 'locationName' => 'rateControlMode', ], 'RawFormat' => [ 'shape' => 'AacRawFormat', 'locationName' => 'rawFormat', ], 'SampleRate' => [ 'shape' => '__double', 'locationName' => 'sampleRate', ], 'Spec' => [ 'shape' => 'AacSpec', 'locationName' => 'spec', ], 'VbrQuality' => [ 'shape' => 'AacVbrQuality', 'locationName' => 'vbrQuality', ], ], ], 'AacSpec' => [ 'type' => 'string', 'enum' => [ 'MPEG2', 'MPEG4', ], ], 'AacVbrQuality' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'LOW', 'MEDIUM_HIGH', 'MEDIUM_LOW', ], ], 'Ac3BitstreamMode' => [ 'type' => 'string', 'enum' => [ 'COMMENTARY', 'COMPLETE_MAIN', 'DIALOGUE', 'EMERGENCY', 'HEARING_IMPAIRED', 'MUSIC_AND_EFFECTS', 'VISUALLY_IMPAIRED', 'VOICE_OVER', ], ], 'Ac3CodingMode' => [ 'type' => 'string', 'enum' => [ 'CODING_MODE_1_0', 'CODING_MODE_1_1', 'CODING_MODE_2_0', 'CODING_MODE_3_2_LFE', ], ], 'Ac3DrcProfile' => [ 'type' => 'string', 'enum' => [ 'FILM_STANDARD', 'NONE', ], ], 'Ac3LfeFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'Ac3MetadataControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'Ac3Settings' => [ 'type' => 'structure', 'members' => [ 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'BitstreamMode' => [ 'shape' => 'Ac3BitstreamMode', 'locationName' => 'bitstreamMode', ], 'CodingMode' => [ 'shape' => 'Ac3CodingMode', 'locationName' => 'codingMode', ], 'Dialnorm' => [ 'shape' => '__integerMin1Max31', 'locationName' => 'dialnorm', ], 'DrcProfile' => [ 'shape' => 'Ac3DrcProfile', 'locationName' => 'drcProfile', ], 'LfeFilter' => [ 'shape' => 'Ac3LfeFilter', 'locationName' => 'lfeFilter', ], 'MetadataControl' => [ 'shape' => 'Ac3MetadataControl', 'locationName' => 'metadataControl', ], ], ], 'AccessDenied' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'AfdSignaling' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'FIXED', 'NONE', ], ], 'ArchiveContainerSettings' => [ 'type' => 'structure', 'members' => [ 'M2tsSettings' => [ 'shape' => 'M2tsSettings', 'locationName' => 'm2tsSettings', ], ], ], 'ArchiveGroupSettings' => [ 'type' => 'structure', 'members' => [ 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'RolloverInterval' => [ 'shape' => '__integerMin1', 'locationName' => 'rolloverInterval', ], ], 'required' => [ 'Destination', ], ], 'ArchiveOutputSettings' => [ 'type' => 'structure', 'members' => [ 'ContainerSettings' => [ 'shape' => 'ArchiveContainerSettings', 'locationName' => 'containerSettings', ], 'Extension' => [ 'shape' => '__string', 'locationName' => 'extension', ], 'NameModifier' => [ 'shape' => '__string', 'locationName' => 'nameModifier', ], ], 'required' => [ 'ContainerSettings', ], ], 'AribDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'AribSourceSettings' => [ 'type' => 'structure', 'members' => [], ], 'AudioChannelMapping' => [ 'type' => 'structure', 'members' => [ 'InputChannelLevels' => [ 'shape' => '__listOfInputChannelLevel', 'locationName' => 'inputChannelLevels', ], 'OutputChannel' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'outputChannel', ], ], 'required' => [ 'OutputChannel', 'InputChannelLevels', ], ], 'AudioCodecSettings' => [ 'type' => 'structure', 'members' => [ 'AacSettings' => [ 'shape' => 'AacSettings', 'locationName' => 'aacSettings', ], 'Ac3Settings' => [ 'shape' => 'Ac3Settings', 'locationName' => 'ac3Settings', ], 'Eac3Settings' => [ 'shape' => 'Eac3Settings', 'locationName' => 'eac3Settings', ], 'Mp2Settings' => [ 'shape' => 'Mp2Settings', 'locationName' => 'mp2Settings', ], 'PassThroughSettings' => [ 'shape' => 'PassThroughSettings', 'locationName' => 'passThroughSettings', ], ], ], 'AudioDescription' => [ 'type' => 'structure', 'members' => [ 'AudioNormalizationSettings' => [ 'shape' => 'AudioNormalizationSettings', 'locationName' => 'audioNormalizationSettings', ], 'AudioSelectorName' => [ 'shape' => '__string', 'locationName' => 'audioSelectorName', ], 'AudioType' => [ 'shape' => 'AudioType', 'locationName' => 'audioType', ], 'AudioTypeControl' => [ 'shape' => 'AudioDescriptionAudioTypeControl', 'locationName' => 'audioTypeControl', ], 'CodecSettings' => [ 'shape' => 'AudioCodecSettings', 'locationName' => 'codecSettings', ], 'LanguageCode' => [ 'shape' => '__stringMin3Max3', 'locationName' => 'languageCode', ], 'LanguageCodeControl' => [ 'shape' => 'AudioDescriptionLanguageCodeControl', 'locationName' => 'languageCodeControl', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RemixSettings' => [ 'shape' => 'RemixSettings', 'locationName' => 'remixSettings', ], 'StreamName' => [ 'shape' => '__string', 'locationName' => 'streamName', ], ], 'required' => [ 'AudioSelectorName', 'Name', ], ], 'AudioDescriptionAudioTypeControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'AudioDescriptionLanguageCodeControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'AudioLanguageSelection' => [ 'type' => 'structure', 'members' => [ 'LanguageCode' => [ 'shape' => '__string', 'locationName' => 'languageCode', ], 'LanguageSelectionPolicy' => [ 'shape' => 'AudioLanguageSelectionPolicy', 'locationName' => 'languageSelectionPolicy', ], ], 'required' => [ 'LanguageCode', ], ], 'AudioLanguageSelectionPolicy' => [ 'type' => 'string', 'enum' => [ 'LOOSE', 'STRICT', ], ], 'AudioNormalizationAlgorithm' => [ 'type' => 'string', 'enum' => [ 'ITU_1770_1', 'ITU_1770_2', ], ], 'AudioNormalizationAlgorithmControl' => [ 'type' => 'string', 'enum' => [ 'CORRECT_AUDIO', ], ], 'AudioNormalizationSettings' => [ 'type' => 'structure', 'members' => [ 'Algorithm' => [ 'shape' => 'AudioNormalizationAlgorithm', 'locationName' => 'algorithm', ], 'AlgorithmControl' => [ 'shape' => 'AudioNormalizationAlgorithmControl', 'locationName' => 'algorithmControl', ], 'TargetLkfs' => [ 'shape' => '__doubleMinNegative59Max0', 'locationName' => 'targetLkfs', ], ], ], 'AudioOnlyHlsSettings' => [ 'type' => 'structure', 'members' => [ 'AudioGroupId' => [ 'shape' => '__string', 'locationName' => 'audioGroupId', ], 'AudioOnlyImage' => [ 'shape' => 'InputLocation', 'locationName' => 'audioOnlyImage', ], 'AudioTrackType' => [ 'shape' => 'AudioOnlyHlsTrackType', 'locationName' => 'audioTrackType', ], ], ], 'AudioOnlyHlsTrackType' => [ 'type' => 'string', 'enum' => [ 'ALTERNATE_AUDIO_AUTO_SELECT', 'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT', 'ALTERNATE_AUDIO_NOT_AUTO_SELECT', 'AUDIO_ONLY_VARIANT_STREAM', ], ], 'AudioPidSelection' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin0Max8191', 'locationName' => 'pid', ], ], 'required' => [ 'Pid', ], ], 'AudioSelector' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__stringMin1', 'locationName' => 'name', ], 'SelectorSettings' => [ 'shape' => 'AudioSelectorSettings', 'locationName' => 'selectorSettings', ], ], 'required' => [ 'Name', ], ], 'AudioSelectorSettings' => [ 'type' => 'structure', 'members' => [ 'AudioLanguageSelection' => [ 'shape' => 'AudioLanguageSelection', 'locationName' => 'audioLanguageSelection', ], 'AudioPidSelection' => [ 'shape' => 'AudioPidSelection', 'locationName' => 'audioPidSelection', ], ], ], 'AudioType' => [ 'type' => 'string', 'enum' => [ 'CLEAN_EFFECTS', 'HEARING_IMPAIRED', 'UNDEFINED', 'VISUAL_IMPAIRED_COMMENTARY', ], ], 'AuthenticationScheme' => [ 'type' => 'string', 'enum' => [ 'AKAMAI', 'COMMON', ], ], 'AvailBlanking' => [ 'type' => 'structure', 'members' => [ 'AvailBlankingImage' => [ 'shape' => 'InputLocation', 'locationName' => 'availBlankingImage', ], 'State' => [ 'shape' => 'AvailBlankingState', 'locationName' => 'state', ], ], ], 'AvailBlankingState' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'AvailConfiguration' => [ 'type' => 'structure', 'members' => [ 'AvailSettings' => [ 'shape' => 'AvailSettings', 'locationName' => 'availSettings', ], ], ], 'AvailSettings' => [ 'type' => 'structure', 'members' => [ 'Scte35SpliceInsert' => [ 'shape' => 'Scte35SpliceInsert', 'locationName' => 'scte35SpliceInsert', ], 'Scte35TimeSignalApos' => [ 'shape' => 'Scte35TimeSignalApos', 'locationName' => 'scte35TimeSignalApos', ], ], ], 'BadGatewayException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 502, ], ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 400, ], ], 'BatchScheduleActionCreateRequest' => [ 'type' => 'structure', 'members' => [ 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'BatchScheduleActionCreateResult' => [ 'type' => 'structure', 'members' => [ 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'BatchScheduleActionDeleteRequest' => [ 'type' => 'structure', 'members' => [ 'ActionNames' => [ 'shape' => '__listOf__string', 'locationName' => 'actionNames', ], ], 'required' => [ 'ActionNames', ], ], 'BatchScheduleActionDeleteResult' => [ 'type' => 'structure', 'members' => [ 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'BatchUpdateScheduleRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], 'Creates' => [ 'shape' => 'BatchScheduleActionCreateRequest', 'locationName' => 'creates', ], 'Deletes' => [ 'shape' => 'BatchScheduleActionDeleteRequest', 'locationName' => 'deletes', ], ], 'required' => [ 'ChannelId', ], ], 'BatchUpdateScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Creates' => [ 'shape' => 'BatchScheduleActionCreateResult', 'locationName' => 'creates', ], 'Deletes' => [ 'shape' => 'BatchScheduleActionDeleteResult', 'locationName' => 'deletes', ], ], ], 'BatchUpdateScheduleResult' => [ 'type' => 'structure', 'members' => [ 'Creates' => [ 'shape' => 'BatchScheduleActionCreateResult', 'locationName' => 'creates', ], 'Deletes' => [ 'shape' => 'BatchScheduleActionDeleteResult', 'locationName' => 'deletes', ], ], ], 'BlackoutSlate' => [ 'type' => 'structure', 'members' => [ 'BlackoutSlateImage' => [ 'shape' => 'InputLocation', 'locationName' => 'blackoutSlateImage', ], 'NetworkEndBlackout' => [ 'shape' => 'BlackoutSlateNetworkEndBlackout', 'locationName' => 'networkEndBlackout', ], 'NetworkEndBlackoutImage' => [ 'shape' => 'InputLocation', 'locationName' => 'networkEndBlackoutImage', ], 'NetworkId' => [ 'shape' => '__stringMin34Max34', 'locationName' => 'networkId', ], 'State' => [ 'shape' => 'BlackoutSlateState', 'locationName' => 'state', ], ], ], 'BlackoutSlateNetworkEndBlackout' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'BlackoutSlateState' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'BurnInAlignment' => [ 'type' => 'string', 'enum' => [ 'CENTERED', 'LEFT', 'SMART', ], ], 'BurnInBackgroundColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'BurnInDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'Alignment' => [ 'shape' => 'BurnInAlignment', 'locationName' => 'alignment', ], 'BackgroundColor' => [ 'shape' => 'BurnInBackgroundColor', 'locationName' => 'backgroundColor', ], 'BackgroundOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'backgroundOpacity', ], 'Font' => [ 'shape' => 'InputLocation', 'locationName' => 'font', ], 'FontColor' => [ 'shape' => 'BurnInFontColor', 'locationName' => 'fontColor', ], 'FontOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'fontOpacity', ], 'FontResolution' => [ 'shape' => '__integerMin96Max600', 'locationName' => 'fontResolution', ], 'FontSize' => [ 'shape' => '__string', 'locationName' => 'fontSize', ], 'OutlineColor' => [ 'shape' => 'BurnInOutlineColor', 'locationName' => 'outlineColor', ], 'OutlineSize' => [ 'shape' => '__integerMin0Max10', 'locationName' => 'outlineSize', ], 'ShadowColor' => [ 'shape' => 'BurnInShadowColor', 'locationName' => 'shadowColor', ], 'ShadowOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'shadowOpacity', ], 'ShadowXOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowXOffset', ], 'ShadowYOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowYOffset', ], 'TeletextGridControl' => [ 'shape' => 'BurnInTeletextGridControl', 'locationName' => 'teletextGridControl', ], 'XPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'xPosition', ], 'YPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'yPosition', ], ], ], 'BurnInFontColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'BurnInOutlineColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'BurnInShadowColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'BurnInTeletextGridControl' => [ 'type' => 'string', 'enum' => [ 'FIXED', 'SCALED', ], ], 'CaptionDescription' => [ 'type' => 'structure', 'members' => [ 'CaptionSelectorName' => [ 'shape' => '__string', 'locationName' => 'captionSelectorName', ], 'DestinationSettings' => [ 'shape' => 'CaptionDestinationSettings', 'locationName' => 'destinationSettings', ], 'LanguageCode' => [ 'shape' => '__string', 'locationName' => 'languageCode', ], 'LanguageDescription' => [ 'shape' => '__string', 'locationName' => 'languageDescription', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], ], 'required' => [ 'CaptionSelectorName', 'Name', ], ], 'CaptionDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'AribDestinationSettings' => [ 'shape' => 'AribDestinationSettings', 'locationName' => 'aribDestinationSettings', ], 'BurnInDestinationSettings' => [ 'shape' => 'BurnInDestinationSettings', 'locationName' => 'burnInDestinationSettings', ], 'DvbSubDestinationSettings' => [ 'shape' => 'DvbSubDestinationSettings', 'locationName' => 'dvbSubDestinationSettings', ], 'EmbeddedDestinationSettings' => [ 'shape' => 'EmbeddedDestinationSettings', 'locationName' => 'embeddedDestinationSettings', ], 'EmbeddedPlusScte20DestinationSettings' => [ 'shape' => 'EmbeddedPlusScte20DestinationSettings', 'locationName' => 'embeddedPlusScte20DestinationSettings', ], 'RtmpCaptionInfoDestinationSettings' => [ 'shape' => 'RtmpCaptionInfoDestinationSettings', 'locationName' => 'rtmpCaptionInfoDestinationSettings', ], 'Scte20PlusEmbeddedDestinationSettings' => [ 'shape' => 'Scte20PlusEmbeddedDestinationSettings', 'locationName' => 'scte20PlusEmbeddedDestinationSettings', ], 'Scte27DestinationSettings' => [ 'shape' => 'Scte27DestinationSettings', 'locationName' => 'scte27DestinationSettings', ], 'SmpteTtDestinationSettings' => [ 'shape' => 'SmpteTtDestinationSettings', 'locationName' => 'smpteTtDestinationSettings', ], 'TeletextDestinationSettings' => [ 'shape' => 'TeletextDestinationSettings', 'locationName' => 'teletextDestinationSettings', ], 'TtmlDestinationSettings' => [ 'shape' => 'TtmlDestinationSettings', 'locationName' => 'ttmlDestinationSettings', ], 'WebvttDestinationSettings' => [ 'shape' => 'WebvttDestinationSettings', 'locationName' => 'webvttDestinationSettings', ], ], ], 'CaptionLanguageMapping' => [ 'type' => 'structure', 'members' => [ 'CaptionChannel' => [ 'shape' => '__integerMin1Max4', 'locationName' => 'captionChannel', ], 'LanguageCode' => [ 'shape' => '__stringMin3Max3', 'locationName' => 'languageCode', ], 'LanguageDescription' => [ 'shape' => '__stringMin1', 'locationName' => 'languageDescription', ], ], 'required' => [ 'LanguageCode', 'LanguageDescription', 'CaptionChannel', ], ], 'CaptionSelector' => [ 'type' => 'structure', 'members' => [ 'LanguageCode' => [ 'shape' => '__string', 'locationName' => 'languageCode', ], 'Name' => [ 'shape' => '__stringMin1', 'locationName' => 'name', ], 'SelectorSettings' => [ 'shape' => 'CaptionSelectorSettings', 'locationName' => 'selectorSettings', ], ], 'required' => [ 'Name', ], ], 'CaptionSelectorSettings' => [ 'type' => 'structure', 'members' => [ 'AribSourceSettings' => [ 'shape' => 'AribSourceSettings', 'locationName' => 'aribSourceSettings', ], 'DvbSubSourceSettings' => [ 'shape' => 'DvbSubSourceSettings', 'locationName' => 'dvbSubSourceSettings', ], 'EmbeddedSourceSettings' => [ 'shape' => 'EmbeddedSourceSettings', 'locationName' => 'embeddedSourceSettings', ], 'Scte20SourceSettings' => [ 'shape' => 'Scte20SourceSettings', 'locationName' => 'scte20SourceSettings', ], 'Scte27SourceSettings' => [ 'shape' => 'Scte27SourceSettings', 'locationName' => 'scte27SourceSettings', ], 'TeletextSourceSettings' => [ 'shape' => 'TeletextSourceSettings', 'locationName' => 'teletextSourceSettings', ], ], ], 'Channel' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'ChannelConfigurationValidationError' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], 'ValidationErrors' => [ 'shape' => '__listOfValidationError', 'locationName' => 'validationErrors', ], ], ], 'ChannelEgressEndpoint' => [ 'type' => 'structure', 'members' => [ 'SourceIp' => [ 'shape' => '__string', 'locationName' => 'sourceIp', ], ], ], 'ChannelState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATE_FAILED', 'IDLE', 'STARTING', 'RUNNING', 'RECOVERING', 'STOPPING', 'DELETING', 'DELETED', ], ], 'ChannelSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 409, ], ], 'CreateChannel' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Reserved' => [ 'shape' => '__string', 'locationName' => 'reserved', 'deprecated' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'CreateChannelRequest' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Reserved' => [ 'shape' => '__string', 'locationName' => 'reserved', 'deprecated' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'CreateChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'CreateChannelResultModel' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'CreateInput' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], 'Vpc' => [ 'shape' => 'InputVpcRequest', 'locationName' => 'vpc', ], ], ], 'CreateInputRequest' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], 'Vpc' => [ 'shape' => 'InputVpcRequest', 'locationName' => 'vpc', ], ], ], 'CreateInputResponse' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'CreateInputResultModel' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'CreateInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRuleCidr', 'locationName' => 'whitelistRules', ], ], ], 'CreateInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'CreateInputSecurityGroupResultModel' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'CreateTagsRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'resource-arn', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], 'required' => [ 'ResourceArn', ], ], 'DeleteChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'DeleteChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'DeleteInputRequest' => [ 'type' => 'structure', 'members' => [ 'InputId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputId', ], ], 'required' => [ 'InputId', ], ], 'DeleteInputResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputSecurityGroupId', ], ], 'required' => [ 'InputSecurityGroupId', ], ], 'DeleteInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteReservationRequest' => [ 'type' => 'structure', 'members' => [ 'ReservationId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'reservationId', ], ], 'required' => [ 'ReservationId', ], ], 'DeleteReservationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Count' => [ 'shape' => '__integer', 'locationName' => 'count', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'End' => [ 'shape' => '__string', 'locationName' => 'end', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ReservationId' => [ 'shape' => '__string', 'locationName' => 'reservationId', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], 'State' => [ 'shape' => 'ReservationState', 'locationName' => 'state', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'DeleteTagsRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'resource-arn', ], 'TagKeys' => [ 'shape' => '__listOf__string', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], 'required' => [ 'TagKeys', 'ResourceArn', ], ], 'DescribeChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'DescribeChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'DescribeInputRequest' => [ 'type' => 'structure', 'members' => [ 'InputId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputId', ], ], 'required' => [ 'InputId', ], ], 'DescribeInputResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'AttachedChannels' => [ 'shape' => '__listOf__string', 'locationName' => 'attachedChannels', ], 'Destinations' => [ 'shape' => '__listOfInputDestination', 'locationName' => 'destinations', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlow', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'SecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'securityGroups', ], 'Sources' => [ 'shape' => '__listOfInputSource', 'locationName' => 'sources', ], 'State' => [ 'shape' => 'InputState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], ], ], 'DescribeInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputSecurityGroupId', ], ], 'required' => [ 'InputSecurityGroupId', ], ], 'DescribeInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'Inputs' => [ 'shape' => '__listOf__string', 'locationName' => 'inputs', ], 'State' => [ 'shape' => 'InputSecurityGroupState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRule', 'locationName' => 'whitelistRules', ], ], ], 'DescribeOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'OfferingId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'offeringId', ], ], 'required' => [ 'OfferingId', ], ], 'DescribeOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'DescribeReservationRequest' => [ 'type' => 'structure', 'members' => [ 'ReservationId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'reservationId', ], ], 'required' => [ 'ReservationId', ], ], 'DescribeReservationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Count' => [ 'shape' => '__integer', 'locationName' => 'count', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'End' => [ 'shape' => '__string', 'locationName' => 'end', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ReservationId' => [ 'shape' => '__string', 'locationName' => 'reservationId', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], 'State' => [ 'shape' => 'ReservationState', 'locationName' => 'state', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'DescribeScheduleRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], 'required' => [ 'ChannelId', ], ], 'DescribeScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], ], 'DvbNitSettings' => [ 'type' => 'structure', 'members' => [ 'NetworkId' => [ 'shape' => '__integerMin0Max65536', 'locationName' => 'networkId', ], 'NetworkName' => [ 'shape' => '__stringMin1Max256', 'locationName' => 'networkName', ], 'RepInterval' => [ 'shape' => '__integerMin25Max10000', 'locationName' => 'repInterval', ], ], 'required' => [ 'NetworkName', 'NetworkId', ], ], 'DvbSdtOutputSdt' => [ 'type' => 'string', 'enum' => [ 'SDT_FOLLOW', 'SDT_FOLLOW_IF_PRESENT', 'SDT_MANUAL', 'SDT_NONE', ], ], 'DvbSdtSettings' => [ 'type' => 'structure', 'members' => [ 'OutputSdt' => [ 'shape' => 'DvbSdtOutputSdt', 'locationName' => 'outputSdt', ], 'RepInterval' => [ 'shape' => '__integerMin25Max2000', 'locationName' => 'repInterval', ], 'ServiceName' => [ 'shape' => '__stringMin1Max256', 'locationName' => 'serviceName', ], 'ServiceProviderName' => [ 'shape' => '__stringMin1Max256', 'locationName' => 'serviceProviderName', ], ], ], 'DvbSubDestinationAlignment' => [ 'type' => 'string', 'enum' => [ 'CENTERED', 'LEFT', 'SMART', ], ], 'DvbSubDestinationBackgroundColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'DvbSubDestinationFontColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'DvbSubDestinationOutlineColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'DvbSubDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'Alignment' => [ 'shape' => 'DvbSubDestinationAlignment', 'locationName' => 'alignment', ], 'BackgroundColor' => [ 'shape' => 'DvbSubDestinationBackgroundColor', 'locationName' => 'backgroundColor', ], 'BackgroundOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'backgroundOpacity', ], 'Font' => [ 'shape' => 'InputLocation', 'locationName' => 'font', ], 'FontColor' => [ 'shape' => 'DvbSubDestinationFontColor', 'locationName' => 'fontColor', ], 'FontOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'fontOpacity', ], 'FontResolution' => [ 'shape' => '__integerMin96Max600', 'locationName' => 'fontResolution', ], 'FontSize' => [ 'shape' => '__string', 'locationName' => 'fontSize', ], 'OutlineColor' => [ 'shape' => 'DvbSubDestinationOutlineColor', 'locationName' => 'outlineColor', ], 'OutlineSize' => [ 'shape' => '__integerMin0Max10', 'locationName' => 'outlineSize', ], 'ShadowColor' => [ 'shape' => 'DvbSubDestinationShadowColor', 'locationName' => 'shadowColor', ], 'ShadowOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'shadowOpacity', ], 'ShadowXOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowXOffset', ], 'ShadowYOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowYOffset', ], 'TeletextGridControl' => [ 'shape' => 'DvbSubDestinationTeletextGridControl', 'locationName' => 'teletextGridControl', ], 'XPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'xPosition', ], 'YPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'yPosition', ], ], ], 'DvbSubDestinationShadowColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'DvbSubDestinationTeletextGridControl' => [ 'type' => 'string', 'enum' => [ 'FIXED', 'SCALED', ], ], 'DvbSubSourceSettings' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin1', 'locationName' => 'pid', ], ], ], 'DvbTdtSettings' => [ 'type' => 'structure', 'members' => [ 'RepInterval' => [ 'shape' => '__integerMin1000Max30000', 'locationName' => 'repInterval', ], ], ], 'Eac3AttenuationControl' => [ 'type' => 'string', 'enum' => [ 'ATTENUATE_3_DB', 'NONE', ], ], 'Eac3BitstreamMode' => [ 'type' => 'string', 'enum' => [ 'COMMENTARY', 'COMPLETE_MAIN', 'EMERGENCY', 'HEARING_IMPAIRED', 'VISUALLY_IMPAIRED', ], ], 'Eac3CodingMode' => [ 'type' => 'string', 'enum' => [ 'CODING_MODE_1_0', 'CODING_MODE_2_0', 'CODING_MODE_3_2', ], ], 'Eac3DcFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'Eac3DrcLine' => [ 'type' => 'string', 'enum' => [ 'FILM_LIGHT', 'FILM_STANDARD', 'MUSIC_LIGHT', 'MUSIC_STANDARD', 'NONE', 'SPEECH', ], ], 'Eac3DrcRf' => [ 'type' => 'string', 'enum' => [ 'FILM_LIGHT', 'FILM_STANDARD', 'MUSIC_LIGHT', 'MUSIC_STANDARD', 'NONE', 'SPEECH', ], ], 'Eac3LfeControl' => [ 'type' => 'string', 'enum' => [ 'LFE', 'NO_LFE', ], ], 'Eac3LfeFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'Eac3MetadataControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'Eac3PassthroughControl' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'WHEN_POSSIBLE', ], ], 'Eac3PhaseControl' => [ 'type' => 'string', 'enum' => [ 'NO_SHIFT', 'SHIFT_90_DEGREES', ], ], 'Eac3Settings' => [ 'type' => 'structure', 'members' => [ 'AttenuationControl' => [ 'shape' => 'Eac3AttenuationControl', 'locationName' => 'attenuationControl', ], 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'BitstreamMode' => [ 'shape' => 'Eac3BitstreamMode', 'locationName' => 'bitstreamMode', ], 'CodingMode' => [ 'shape' => 'Eac3CodingMode', 'locationName' => 'codingMode', ], 'DcFilter' => [ 'shape' => 'Eac3DcFilter', 'locationName' => 'dcFilter', ], 'Dialnorm' => [ 'shape' => '__integerMin1Max31', 'locationName' => 'dialnorm', ], 'DrcLine' => [ 'shape' => 'Eac3DrcLine', 'locationName' => 'drcLine', ], 'DrcRf' => [ 'shape' => 'Eac3DrcRf', 'locationName' => 'drcRf', ], 'LfeControl' => [ 'shape' => 'Eac3LfeControl', 'locationName' => 'lfeControl', ], 'LfeFilter' => [ 'shape' => 'Eac3LfeFilter', 'locationName' => 'lfeFilter', ], 'LoRoCenterMixLevel' => [ 'shape' => '__double', 'locationName' => 'loRoCenterMixLevel', ], 'LoRoSurroundMixLevel' => [ 'shape' => '__double', 'locationName' => 'loRoSurroundMixLevel', ], 'LtRtCenterMixLevel' => [ 'shape' => '__double', 'locationName' => 'ltRtCenterMixLevel', ], 'LtRtSurroundMixLevel' => [ 'shape' => '__double', 'locationName' => 'ltRtSurroundMixLevel', ], 'MetadataControl' => [ 'shape' => 'Eac3MetadataControl', 'locationName' => 'metadataControl', ], 'PassthroughControl' => [ 'shape' => 'Eac3PassthroughControl', 'locationName' => 'passthroughControl', ], 'PhaseControl' => [ 'shape' => 'Eac3PhaseControl', 'locationName' => 'phaseControl', ], 'StereoDownmix' => [ 'shape' => 'Eac3StereoDownmix', 'locationName' => 'stereoDownmix', ], 'SurroundExMode' => [ 'shape' => 'Eac3SurroundExMode', 'locationName' => 'surroundExMode', ], 'SurroundMode' => [ 'shape' => 'Eac3SurroundMode', 'locationName' => 'surroundMode', ], ], ], 'Eac3StereoDownmix' => [ 'type' => 'string', 'enum' => [ 'DPL2', 'LO_RO', 'LT_RT', 'NOT_INDICATED', ], ], 'Eac3SurroundExMode' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', 'NOT_INDICATED', ], ], 'Eac3SurroundMode' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', 'NOT_INDICATED', ], ], 'EmbeddedConvert608To708' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'UPCONVERT', ], ], 'EmbeddedDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'EmbeddedPlusScte20DestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'EmbeddedScte20Detection' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'OFF', ], ], 'EmbeddedSourceSettings' => [ 'type' => 'structure', 'members' => [ 'Convert608To708' => [ 'shape' => 'EmbeddedConvert608To708', 'locationName' => 'convert608To708', ], 'Scte20Detection' => [ 'shape' => 'EmbeddedScte20Detection', 'locationName' => 'scte20Detection', ], 'Source608ChannelNumber' => [ 'shape' => '__integerMin1Max4', 'locationName' => 'source608ChannelNumber', ], 'Source608TrackNumber' => [ 'shape' => '__integerMin1Max5', 'locationName' => 'source608TrackNumber', ], ], ], 'Empty' => [ 'type' => 'structure', 'members' => [], ], 'EncoderSettings' => [ 'type' => 'structure', 'members' => [ 'AudioDescriptions' => [ 'shape' => '__listOfAudioDescription', 'locationName' => 'audioDescriptions', ], 'AvailBlanking' => [ 'shape' => 'AvailBlanking', 'locationName' => 'availBlanking', ], 'AvailConfiguration' => [ 'shape' => 'AvailConfiguration', 'locationName' => 'availConfiguration', ], 'BlackoutSlate' => [ 'shape' => 'BlackoutSlate', 'locationName' => 'blackoutSlate', ], 'CaptionDescriptions' => [ 'shape' => '__listOfCaptionDescription', 'locationName' => 'captionDescriptions', ], 'GlobalConfiguration' => [ 'shape' => 'GlobalConfiguration', 'locationName' => 'globalConfiguration', ], 'OutputGroups' => [ 'shape' => '__listOfOutputGroup', 'locationName' => 'outputGroups', ], 'TimecodeConfig' => [ 'shape' => 'TimecodeConfig', 'locationName' => 'timecodeConfig', ], 'VideoDescriptions' => [ 'shape' => '__listOfVideoDescription', 'locationName' => 'videoDescriptions', ], ], 'required' => [ 'VideoDescriptions', 'AudioDescriptions', 'OutputGroups', 'TimecodeConfig', ], ], 'FecOutputIncludeFec' => [ 'type' => 'string', 'enum' => [ 'COLUMN', 'COLUMN_AND_ROW', ], ], 'FecOutputSettings' => [ 'type' => 'structure', 'members' => [ 'ColumnDepth' => [ 'shape' => '__integerMin4Max20', 'locationName' => 'columnDepth', ], 'IncludeFec' => [ 'shape' => 'FecOutputIncludeFec', 'locationName' => 'includeFec', ], 'RowLength' => [ 'shape' => '__integerMin1Max20', 'locationName' => 'rowLength', ], ], ], 'FixedAfd' => [ 'type' => 'string', 'enum' => [ 'AFD_0000', 'AFD_0010', 'AFD_0011', 'AFD_0100', 'AFD_1000', 'AFD_1001', 'AFD_1010', 'AFD_1011', 'AFD_1101', 'AFD_1110', 'AFD_1111', ], ], 'FixedModeScheduleActionStartSettings' => [ 'type' => 'structure', 'members' => [ 'Time' => [ 'shape' => '__string', 'locationName' => 'time', ], ], 'required' => [ 'Time', ], ], 'FollowModeScheduleActionStartSettings' => [ 'type' => 'structure', 'members' => [ 'FollowPoint' => [ 'shape' => 'FollowPoint', 'locationName' => 'followPoint', ], 'ReferenceActionName' => [ 'shape' => '__string', 'locationName' => 'referenceActionName', ], ], 'required' => [ 'ReferenceActionName', 'FollowPoint', ], ], 'FollowPoint' => [ 'type' => 'string', 'enum' => [ 'END', 'START', ], ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 403, ], ], 'FrameCaptureGroupSettings' => [ 'type' => 'structure', 'members' => [ 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], ], 'required' => [ 'Destination', ], ], 'FrameCaptureOutputSettings' => [ 'type' => 'structure', 'members' => [ 'NameModifier' => [ 'shape' => '__string', 'locationName' => 'nameModifier', ], ], ], 'FrameCaptureSettings' => [ 'type' => 'structure', 'members' => [ 'CaptureInterval' => [ 'shape' => '__integerMin1Max3600', 'locationName' => 'captureInterval', ], ], 'required' => [ 'CaptureInterval', ], ], 'GatewayTimeoutException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 504, ], ], 'GlobalConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialAudioGain' => [ 'shape' => '__integerMinNegative60Max60', 'locationName' => 'initialAudioGain', ], 'InputEndAction' => [ 'shape' => 'GlobalConfigurationInputEndAction', 'locationName' => 'inputEndAction', ], 'InputLossBehavior' => [ 'shape' => 'InputLossBehavior', 'locationName' => 'inputLossBehavior', ], 'OutputTimingSource' => [ 'shape' => 'GlobalConfigurationOutputTimingSource', 'locationName' => 'outputTimingSource', ], 'SupportLowFramerateInputs' => [ 'shape' => 'GlobalConfigurationLowFramerateInputs', 'locationName' => 'supportLowFramerateInputs', ], ], ], 'GlobalConfigurationInputEndAction' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SWITCH_AND_LOOP_INPUTS', ], ], 'GlobalConfigurationLowFramerateInputs' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'GlobalConfigurationOutputTimingSource' => [ 'type' => 'string', 'enum' => [ 'INPUT_CLOCK', 'SYSTEM_CLOCK', ], ], 'H264AdaptiveQuantization' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'HIGHER', 'LOW', 'MAX', 'MEDIUM', 'OFF', ], ], 'H264ColorMetadata' => [ 'type' => 'string', 'enum' => [ 'IGNORE', 'INSERT', ], ], 'H264EntropyEncoding' => [ 'type' => 'string', 'enum' => [ 'CABAC', 'CAVLC', ], ], 'H264FlickerAq' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264FramerateControl' => [ 'type' => 'string', 'enum' => [ 'INITIALIZE_FROM_SOURCE', 'SPECIFIED', ], ], 'H264GopBReference' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264GopSizeUnits' => [ 'type' => 'string', 'enum' => [ 'FRAMES', 'SECONDS', ], ], 'H264Level' => [ 'type' => 'string', 'enum' => [ 'H264_LEVEL_1', 'H264_LEVEL_1_1', 'H264_LEVEL_1_2', 'H264_LEVEL_1_3', 'H264_LEVEL_2', 'H264_LEVEL_2_1', 'H264_LEVEL_2_2', 'H264_LEVEL_3', 'H264_LEVEL_3_1', 'H264_LEVEL_3_2', 'H264_LEVEL_4', 'H264_LEVEL_4_1', 'H264_LEVEL_4_2', 'H264_LEVEL_5', 'H264_LEVEL_5_1', 'H264_LEVEL_5_2', 'H264_LEVEL_AUTO', ], ], 'H264LookAheadRateControl' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'LOW', 'MEDIUM', ], ], 'H264ParControl' => [ 'type' => 'string', 'enum' => [ 'INITIALIZE_FROM_SOURCE', 'SPECIFIED', ], ], 'H264Profile' => [ 'type' => 'string', 'enum' => [ 'BASELINE', 'HIGH', 'HIGH_10BIT', 'HIGH_422', 'HIGH_422_10BIT', 'MAIN', ], ], 'H264RateControlMode' => [ 'type' => 'string', 'enum' => [ 'CBR', 'QVBR', 'VBR', ], ], 'H264ScanType' => [ 'type' => 'string', 'enum' => [ 'INTERLACED', 'PROGRESSIVE', ], ], 'H264SceneChangeDetect' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264Settings' => [ 'type' => 'structure', 'members' => [ 'AdaptiveQuantization' => [ 'shape' => 'H264AdaptiveQuantization', 'locationName' => 'adaptiveQuantization', ], 'AfdSignaling' => [ 'shape' => 'AfdSignaling', 'locationName' => 'afdSignaling', ], 'Bitrate' => [ 'shape' => '__integerMin1000', 'locationName' => 'bitrate', ], 'BufFillPct' => [ 'shape' => '__integerMin0Max100', 'locationName' => 'bufFillPct', ], 'BufSize' => [ 'shape' => '__integerMin0', 'locationName' => 'bufSize', ], 'ColorMetadata' => [ 'shape' => 'H264ColorMetadata', 'locationName' => 'colorMetadata', ], 'EntropyEncoding' => [ 'shape' => 'H264EntropyEncoding', 'locationName' => 'entropyEncoding', ], 'FixedAfd' => [ 'shape' => 'FixedAfd', 'locationName' => 'fixedAfd', ], 'FlickerAq' => [ 'shape' => 'H264FlickerAq', 'locationName' => 'flickerAq', ], 'FramerateControl' => [ 'shape' => 'H264FramerateControl', 'locationName' => 'framerateControl', ], 'FramerateDenominator' => [ 'shape' => '__integerMin1', 'locationName' => 'framerateDenominator', ], 'FramerateNumerator' => [ 'shape' => '__integerMin1', 'locationName' => 'framerateNumerator', ], 'GopBReference' => [ 'shape' => 'H264GopBReference', 'locationName' => 'gopBReference', ], 'GopClosedCadence' => [ 'shape' => '__integerMin0', 'locationName' => 'gopClosedCadence', ], 'GopNumBFrames' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'gopNumBFrames', ], 'GopSize' => [ 'shape' => '__doubleMin1', 'locationName' => 'gopSize', ], 'GopSizeUnits' => [ 'shape' => 'H264GopSizeUnits', 'locationName' => 'gopSizeUnits', ], 'Level' => [ 'shape' => 'H264Level', 'locationName' => 'level', ], 'LookAheadRateControl' => [ 'shape' => 'H264LookAheadRateControl', 'locationName' => 'lookAheadRateControl', ], 'MaxBitrate' => [ 'shape' => '__integerMin1000', 'locationName' => 'maxBitrate', ], 'MinIInterval' => [ 'shape' => '__integerMin0Max30', 'locationName' => 'minIInterval', ], 'NumRefFrames' => [ 'shape' => '__integerMin1Max6', 'locationName' => 'numRefFrames', ], 'ParControl' => [ 'shape' => 'H264ParControl', 'locationName' => 'parControl', ], 'ParDenominator' => [ 'shape' => '__integerMin1', 'locationName' => 'parDenominator', ], 'ParNumerator' => [ 'shape' => '__integer', 'locationName' => 'parNumerator', ], 'Profile' => [ 'shape' => 'H264Profile', 'locationName' => 'profile', ], 'QvbrQualityLevel' => [ 'shape' => '__integerMin1Max10', 'locationName' => 'qvbrQualityLevel', ], 'RateControlMode' => [ 'shape' => 'H264RateControlMode', 'locationName' => 'rateControlMode', ], 'ScanType' => [ 'shape' => 'H264ScanType', 'locationName' => 'scanType', ], 'SceneChangeDetect' => [ 'shape' => 'H264SceneChangeDetect', 'locationName' => 'sceneChangeDetect', ], 'Slices' => [ 'shape' => '__integerMin1Max32', 'locationName' => 'slices', ], 'Softness' => [ 'shape' => '__integerMin0Max128', 'locationName' => 'softness', ], 'SpatialAq' => [ 'shape' => 'H264SpatialAq', 'locationName' => 'spatialAq', ], 'SubgopLength' => [ 'shape' => 'H264SubGopLength', 'locationName' => 'subgopLength', ], 'Syntax' => [ 'shape' => 'H264Syntax', 'locationName' => 'syntax', ], 'TemporalAq' => [ 'shape' => 'H264TemporalAq', 'locationName' => 'temporalAq', ], 'TimecodeInsertion' => [ 'shape' => 'H264TimecodeInsertionBehavior', 'locationName' => 'timecodeInsertion', ], ], ], 'H264SpatialAq' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264SubGopLength' => [ 'type' => 'string', 'enum' => [ 'DYNAMIC', 'FIXED', ], ], 'H264Syntax' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'RP2027', ], ], 'H264TemporalAq' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264TimecodeInsertionBehavior' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'PIC_TIMING_SEI', ], ], 'HlsAdMarkers' => [ 'type' => 'string', 'enum' => [ 'ADOBE', 'ELEMENTAL', 'ELEMENTAL_SCTE35', ], ], 'HlsAkamaiHttpTransferMode' => [ 'type' => 'string', 'enum' => [ 'CHUNKED', 'NON_CHUNKED', ], ], 'HlsAkamaiSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'HttpTransferMode' => [ 'shape' => 'HlsAkamaiHttpTransferMode', 'locationName' => 'httpTransferMode', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], 'Salt' => [ 'shape' => '__string', 'locationName' => 'salt', ], 'Token' => [ 'shape' => '__string', 'locationName' => 'token', ], ], ], 'HlsBasicPutSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], ], ], 'HlsCaptionLanguageSetting' => [ 'type' => 'string', 'enum' => [ 'INSERT', 'NONE', 'OMIT', ], ], 'HlsCdnSettings' => [ 'type' => 'structure', 'members' => [ 'HlsAkamaiSettings' => [ 'shape' => 'HlsAkamaiSettings', 'locationName' => 'hlsAkamaiSettings', ], 'HlsBasicPutSettings' => [ 'shape' => 'HlsBasicPutSettings', 'locationName' => 'hlsBasicPutSettings', ], 'HlsMediaStoreSettings' => [ 'shape' => 'HlsMediaStoreSettings', 'locationName' => 'hlsMediaStoreSettings', ], 'HlsWebdavSettings' => [ 'shape' => 'HlsWebdavSettings', 'locationName' => 'hlsWebdavSettings', ], ], ], 'HlsClientCache' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'HlsCodecSpecification' => [ 'type' => 'string', 'enum' => [ 'RFC_4281', 'RFC_6381', ], ], 'HlsDirectoryStructure' => [ 'type' => 'string', 'enum' => [ 'SINGLE_DIRECTORY', 'SUBDIRECTORY_PER_STREAM', ], ], 'HlsEncryptionType' => [ 'type' => 'string', 'enum' => [ 'AES128', 'SAMPLE_AES', ], ], 'HlsGroupSettings' => [ 'type' => 'structure', 'members' => [ 'AdMarkers' => [ 'shape' => '__listOfHlsAdMarkers', 'locationName' => 'adMarkers', ], 'BaseUrlContent' => [ 'shape' => '__string', 'locationName' => 'baseUrlContent', ], 'BaseUrlManifest' => [ 'shape' => '__string', 'locationName' => 'baseUrlManifest', ], 'CaptionLanguageMappings' => [ 'shape' => '__listOfCaptionLanguageMapping', 'locationName' => 'captionLanguageMappings', ], 'CaptionLanguageSetting' => [ 'shape' => 'HlsCaptionLanguageSetting', 'locationName' => 'captionLanguageSetting', ], 'ClientCache' => [ 'shape' => 'HlsClientCache', 'locationName' => 'clientCache', ], 'CodecSpecification' => [ 'shape' => 'HlsCodecSpecification', 'locationName' => 'codecSpecification', ], 'ConstantIv' => [ 'shape' => '__stringMin32Max32', 'locationName' => 'constantIv', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'DirectoryStructure' => [ 'shape' => 'HlsDirectoryStructure', 'locationName' => 'directoryStructure', ], 'EncryptionType' => [ 'shape' => 'HlsEncryptionType', 'locationName' => 'encryptionType', ], 'HlsCdnSettings' => [ 'shape' => 'HlsCdnSettings', 'locationName' => 'hlsCdnSettings', ], 'IFrameOnlyPlaylists' => [ 'shape' => 'IFrameOnlyPlaylistType', 'locationName' => 'iFrameOnlyPlaylists', ], 'IndexNSegments' => [ 'shape' => '__integerMin3', 'locationName' => 'indexNSegments', ], 'InputLossAction' => [ 'shape' => 'InputLossActionForHlsOut', 'locationName' => 'inputLossAction', ], 'IvInManifest' => [ 'shape' => 'HlsIvInManifest', 'locationName' => 'ivInManifest', ], 'IvSource' => [ 'shape' => 'HlsIvSource', 'locationName' => 'ivSource', ], 'KeepSegments' => [ 'shape' => '__integerMin1', 'locationName' => 'keepSegments', ], 'KeyFormat' => [ 'shape' => '__string', 'locationName' => 'keyFormat', ], 'KeyFormatVersions' => [ 'shape' => '__string', 'locationName' => 'keyFormatVersions', ], 'KeyProviderSettings' => [ 'shape' => 'KeyProviderSettings', 'locationName' => 'keyProviderSettings', ], 'ManifestCompression' => [ 'shape' => 'HlsManifestCompression', 'locationName' => 'manifestCompression', ], 'ManifestDurationFormat' => [ 'shape' => 'HlsManifestDurationFormat', 'locationName' => 'manifestDurationFormat', ], 'MinSegmentLength' => [ 'shape' => '__integerMin0', 'locationName' => 'minSegmentLength', ], 'Mode' => [ 'shape' => 'HlsMode', 'locationName' => 'mode', ], 'OutputSelection' => [ 'shape' => 'HlsOutputSelection', 'locationName' => 'outputSelection', ], 'ProgramDateTime' => [ 'shape' => 'HlsProgramDateTime', 'locationName' => 'programDateTime', ], 'ProgramDateTimePeriod' => [ 'shape' => '__integerMin0Max3600', 'locationName' => 'programDateTimePeriod', ], 'RedundantManifest' => [ 'shape' => 'HlsRedundantManifest', 'locationName' => 'redundantManifest', ], 'SegmentLength' => [ 'shape' => '__integerMin1', 'locationName' => 'segmentLength', ], 'SegmentationMode' => [ 'shape' => 'HlsSegmentationMode', 'locationName' => 'segmentationMode', ], 'SegmentsPerSubdirectory' => [ 'shape' => '__integerMin1', 'locationName' => 'segmentsPerSubdirectory', ], 'StreamInfResolution' => [ 'shape' => 'HlsStreamInfResolution', 'locationName' => 'streamInfResolution', ], 'TimedMetadataId3Frame' => [ 'shape' => 'HlsTimedMetadataId3Frame', 'locationName' => 'timedMetadataId3Frame', ], 'TimedMetadataId3Period' => [ 'shape' => '__integerMin0', 'locationName' => 'timedMetadataId3Period', ], 'TimestampDeltaMilliseconds' => [ 'shape' => '__integerMin0', 'locationName' => 'timestampDeltaMilliseconds', ], 'TsFileMode' => [ 'shape' => 'HlsTsFileMode', 'locationName' => 'tsFileMode', ], ], 'required' => [ 'Destination', ], ], 'HlsInputSettings' => [ 'type' => 'structure', 'members' => [ 'Bandwidth' => [ 'shape' => '__integerMin0', 'locationName' => 'bandwidth', ], 'BufferSegments' => [ 'shape' => '__integerMin0', 'locationName' => 'bufferSegments', ], 'Retries' => [ 'shape' => '__integerMin0', 'locationName' => 'retries', ], 'RetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'retryInterval', ], ], ], 'HlsIvInManifest' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'HlsIvSource' => [ 'type' => 'string', 'enum' => [ 'EXPLICIT', 'FOLLOWS_SEGMENT_NUMBER', ], ], 'HlsManifestCompression' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'HlsManifestDurationFormat' => [ 'type' => 'string', 'enum' => [ 'FLOATING_POINT', 'INTEGER', ], ], 'HlsMediaStoreSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'MediaStoreStorageClass' => [ 'shape' => 'HlsMediaStoreStorageClass', 'locationName' => 'mediaStoreStorageClass', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], ], ], 'HlsMediaStoreStorageClass' => [ 'type' => 'string', 'enum' => [ 'TEMPORAL', ], ], 'HlsMode' => [ 'type' => 'string', 'enum' => [ 'LIVE', 'VOD', ], ], 'HlsOutputSelection' => [ 'type' => 'string', 'enum' => [ 'MANIFESTS_AND_SEGMENTS', 'SEGMENTS_ONLY', ], ], 'HlsOutputSettings' => [ 'type' => 'structure', 'members' => [ 'HlsSettings' => [ 'shape' => 'HlsSettings', 'locationName' => 'hlsSettings', ], 'NameModifier' => [ 'shape' => '__stringMin1', 'locationName' => 'nameModifier', ], 'SegmentModifier' => [ 'shape' => '__string', 'locationName' => 'segmentModifier', ], ], 'required' => [ 'HlsSettings', ], ], 'HlsProgramDateTime' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'HlsRedundantManifest' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'HlsSegmentationMode' => [ 'type' => 'string', 'enum' => [ 'USE_INPUT_SEGMENTATION', 'USE_SEGMENT_DURATION', ], ], 'HlsSettings' => [ 'type' => 'structure', 'members' => [ 'AudioOnlyHlsSettings' => [ 'shape' => 'AudioOnlyHlsSettings', 'locationName' => 'audioOnlyHlsSettings', ], 'StandardHlsSettings' => [ 'shape' => 'StandardHlsSettings', 'locationName' => 'standardHlsSettings', ], ], ], 'HlsStreamInfResolution' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'HlsTimedMetadataId3Frame' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PRIV', 'TDRL', ], ], 'HlsTimedMetadataScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Id3' => [ 'shape' => '__string', 'locationName' => 'id3', ], ], 'required' => [ 'Id3', ], ], 'HlsTsFileMode' => [ 'type' => 'string', 'enum' => [ 'SEGMENTED_FILES', 'SINGLE_FILE', ], ], 'HlsWebdavHttpTransferMode' => [ 'type' => 'string', 'enum' => [ 'CHUNKED', 'NON_CHUNKED', ], ], 'HlsWebdavSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'HttpTransferMode' => [ 'shape' => 'HlsWebdavHttpTransferMode', 'locationName' => 'httpTransferMode', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], ], ], 'IFrameOnlyPlaylistType' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'STANDARD', ], ], 'Input' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'AttachedChannels' => [ 'shape' => '__listOf__string', 'locationName' => 'attachedChannels', ], 'Destinations' => [ 'shape' => '__listOfInputDestination', 'locationName' => 'destinations', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlow', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'SecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'securityGroups', ], 'Sources' => [ 'shape' => '__listOfInputSource', 'locationName' => 'sources', ], 'State' => [ 'shape' => 'InputState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], ], ], 'InputAttachment' => [ 'type' => 'structure', 'members' => [ 'InputAttachmentName' => [ 'shape' => '__string', 'locationName' => 'inputAttachmentName', ], 'InputId' => [ 'shape' => '__string', 'locationName' => 'inputId', ], 'InputSettings' => [ 'shape' => 'InputSettings', 'locationName' => 'inputSettings', ], ], ], 'InputChannelLevel' => [ 'type' => 'structure', 'members' => [ 'Gain' => [ 'shape' => '__integerMinNegative60Max6', 'locationName' => 'gain', ], 'InputChannel' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'inputChannel', ], ], 'required' => [ 'InputChannel', 'Gain', ], ], 'InputCodec' => [ 'type' => 'string', 'enum' => [ 'MPEG2', 'AVC', 'HEVC', ], ], 'InputDeblockFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'InputDenoiseFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'InputDestination' => [ 'type' => 'structure', 'members' => [ 'Ip' => [ 'shape' => '__string', 'locationName' => 'ip', ], 'Port' => [ 'shape' => '__string', 'locationName' => 'port', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Vpc' => [ 'shape' => 'InputDestinationVpc', 'locationName' => 'vpc', ], ], ], 'InputDestinationRequest' => [ 'type' => 'structure', 'members' => [ 'StreamName' => [ 'shape' => '__string', 'locationName' => 'streamName', ], ], ], 'InputDestinationVpc' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZone' => [ 'shape' => '__string', 'locationName' => 'availabilityZone', ], 'NetworkInterfaceId' => [ 'shape' => '__string', 'locationName' => 'networkInterfaceId', ], ], ], 'InputFilter' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'DISABLED', 'FORCED', ], ], 'InputLocation' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'Uri' => [ 'shape' => '__string', 'locationName' => 'uri', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], 'required' => [ 'Uri', ], ], 'InputLossActionForHlsOut' => [ 'type' => 'string', 'enum' => [ 'EMIT_OUTPUT', 'PAUSE_OUTPUT', ], ], 'InputLossActionForMsSmoothOut' => [ 'type' => 'string', 'enum' => [ 'EMIT_OUTPUT', 'PAUSE_OUTPUT', ], ], 'InputLossActionForRtmpOut' => [ 'type' => 'string', 'enum' => [ 'EMIT_OUTPUT', 'PAUSE_OUTPUT', ], ], 'InputLossActionForUdpOut' => [ 'type' => 'string', 'enum' => [ 'DROP_PROGRAM', 'DROP_TS', 'EMIT_PROGRAM', ], ], 'InputLossBehavior' => [ 'type' => 'structure', 'members' => [ 'BlackFrameMsec' => [ 'shape' => '__integerMin0Max1000000', 'locationName' => 'blackFrameMsec', ], 'InputLossImageColor' => [ 'shape' => '__stringMin6Max6', 'locationName' => 'inputLossImageColor', ], 'InputLossImageSlate' => [ 'shape' => 'InputLocation', 'locationName' => 'inputLossImageSlate', ], 'InputLossImageType' => [ 'shape' => 'InputLossImageType', 'locationName' => 'inputLossImageType', ], 'RepeatFrameMsec' => [ 'shape' => '__integerMin0Max1000000', 'locationName' => 'repeatFrameMsec', ], ], ], 'InputLossImageType' => [ 'type' => 'string', 'enum' => [ 'COLOR', 'SLATE', ], ], 'InputMaximumBitrate' => [ 'type' => 'string', 'enum' => [ 'MAX_10_MBPS', 'MAX_20_MBPS', 'MAX_50_MBPS', ], ], 'InputResolution' => [ 'type' => 'string', 'enum' => [ 'SD', 'HD', 'UHD', ], ], 'InputSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'Inputs' => [ 'shape' => '__listOf__string', 'locationName' => 'inputs', ], 'State' => [ 'shape' => 'InputSecurityGroupState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRule', 'locationName' => 'whitelistRules', ], ], ], 'InputSecurityGroupState' => [ 'type' => 'string', 'enum' => [ 'IDLE', 'IN_USE', 'UPDATING', 'DELETED', ], ], 'InputSecurityGroupWhitelistRequest' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRuleCidr', 'locationName' => 'whitelistRules', ], ], ], 'InputSettings' => [ 'type' => 'structure', 'members' => [ 'AudioSelectors' => [ 'shape' => '__listOfAudioSelector', 'locationName' => 'audioSelectors', ], 'CaptionSelectors' => [ 'shape' => '__listOfCaptionSelector', 'locationName' => 'captionSelectors', ], 'DeblockFilter' => [ 'shape' => 'InputDeblockFilter', 'locationName' => 'deblockFilter', ], 'DenoiseFilter' => [ 'shape' => 'InputDenoiseFilter', 'locationName' => 'denoiseFilter', ], 'FilterStrength' => [ 'shape' => '__integerMin1Max5', 'locationName' => 'filterStrength', ], 'InputFilter' => [ 'shape' => 'InputFilter', 'locationName' => 'inputFilter', ], 'NetworkInputSettings' => [ 'shape' => 'NetworkInputSettings', 'locationName' => 'networkInputSettings', ], 'SourceEndBehavior' => [ 'shape' => 'InputSourceEndBehavior', 'locationName' => 'sourceEndBehavior', ], 'VideoSelector' => [ 'shape' => 'VideoSelector', 'locationName' => 'videoSelector', ], ], ], 'InputSource' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], ], 'InputSourceEndBehavior' => [ 'type' => 'string', 'enum' => [ 'CONTINUE', 'LOOP', ], ], 'InputSourceRequest' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], ], 'InputSpecification' => [ 'type' => 'structure', 'members' => [ 'Codec' => [ 'shape' => 'InputCodec', 'locationName' => 'codec', ], 'MaximumBitrate' => [ 'shape' => 'InputMaximumBitrate', 'locationName' => 'maximumBitrate', ], 'Resolution' => [ 'shape' => 'InputResolution', 'locationName' => 'resolution', ], ], ], 'InputState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'DETACHED', 'ATTACHED', 'DELETING', 'DELETED', ], ], 'InputSwitchScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'InputAttachmentNameReference' => [ 'shape' => '__string', 'locationName' => 'inputAttachmentNameReference', ], ], 'required' => [ 'InputAttachmentNameReference', ], ], 'InputType' => [ 'type' => 'string', 'enum' => [ 'UDP_PUSH', 'RTP_PUSH', 'RTMP_PUSH', 'RTMP_PULL', 'URL_PULL', 'MP4_FILE', 'MEDIACONNECT', ], ], 'InputVpcRequest' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => '__listOf__string', 'locationName' => 'securityGroupIds', ], 'SubnetIds' => [ 'shape' => '__listOf__string', 'locationName' => 'subnetIds', ], ], 'required' => [ 'SubnetIds', ], ], 'InputWhitelistRule' => [ 'type' => 'structure', 'members' => [ 'Cidr' => [ 'shape' => '__string', 'locationName' => 'cidr', ], ], ], 'InputWhitelistRuleCidr' => [ 'type' => 'structure', 'members' => [ 'Cidr' => [ 'shape' => '__string', 'locationName' => 'cidr', ], ], ], 'InternalServerErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 500, ], ], 'InternalServiceError' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'InvalidRequest' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'KeyProviderSettings' => [ 'type' => 'structure', 'members' => [ 'StaticKeySettings' => [ 'shape' => 'StaticKeySettings', 'locationName' => 'staticKeySettings', ], ], ], 'LimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'ListChannelsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListChannelsResponse' => [ 'type' => 'structure', 'members' => [ 'Channels' => [ 'shape' => '__listOfChannelSummary', 'locationName' => 'channels', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListChannelsResultModel' => [ 'type' => 'structure', 'members' => [ 'Channels' => [ 'shape' => '__listOfChannelSummary', 'locationName' => 'channels', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputSecurityGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListInputSecurityGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroups' => [ 'shape' => '__listOfInputSecurityGroup', 'locationName' => 'inputSecurityGroups', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputSecurityGroupsResultModel' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroups' => [ 'shape' => '__listOfInputSecurityGroup', 'locationName' => 'inputSecurityGroups', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListInputsResponse' => [ 'type' => 'structure', 'members' => [ 'Inputs' => [ 'shape' => '__listOfInput', 'locationName' => 'inputs', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputsResultModel' => [ 'type' => 'structure', 'members' => [ 'Inputs' => [ 'shape' => '__listOfInput', 'locationName' => 'inputs', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelConfiguration' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'channelConfiguration', ], 'Codec' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'codec', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'MaximumBitrate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumBitrate', ], 'MaximumFramerate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumFramerate', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'Resolution' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resolution', ], 'ResourceType' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'SpecialFeature' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'specialFeature', ], 'VideoQuality' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'videoQuality', ], ], ], 'ListOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Offerings' => [ 'shape' => '__listOfOffering', 'locationName' => 'offerings', ], ], ], 'ListOfferingsResultModel' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Offerings' => [ 'shape' => '__listOfOffering', 'locationName' => 'offerings', ], ], ], 'ListReservationsRequest' => [ 'type' => 'structure', 'members' => [ 'Codec' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'codec', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'MaximumBitrate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumBitrate', ], 'MaximumFramerate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumFramerate', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'Resolution' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resolution', ], 'ResourceType' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'SpecialFeature' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'specialFeature', ], 'VideoQuality' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'videoQuality', ], ], ], 'ListReservationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Reservations' => [ 'shape' => '__listOfReservation', 'locationName' => 'reservations', ], ], ], 'ListReservationsResultModel' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Reservations' => [ 'shape' => '__listOfReservation', 'locationName' => 'reservations', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'resource-arn', ], ], 'required' => [ 'ResourceArn', ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'DISABLED', ], ], 'M2tsAbsentInputAudioBehavior' => [ 'type' => 'string', 'enum' => [ 'DROP', 'ENCODE_SILENCE', ], ], 'M2tsArib' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'M2tsAribCaptionsPidControl' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'USE_CONFIGURED', ], ], 'M2tsAudioBufferModel' => [ 'type' => 'string', 'enum' => [ 'ATSC', 'DVB', ], ], 'M2tsAudioInterval' => [ 'type' => 'string', 'enum' => [ 'VIDEO_AND_FIXED_INTERVALS', 'VIDEO_INTERVAL', ], ], 'M2tsAudioStreamType' => [ 'type' => 'string', 'enum' => [ 'ATSC', 'DVB', ], ], 'M2tsBufferModel' => [ 'type' => 'string', 'enum' => [ 'MULTIPLEX', 'NONE', ], ], 'M2tsCcDescriptor' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'M2tsEbifControl' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', ], ], 'M2tsEbpPlacement' => [ 'type' => 'string', 'enum' => [ 'VIDEO_AND_AUDIO_PIDS', 'VIDEO_PID', ], ], 'M2tsEsRateInPes' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'M2tsKlv' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', ], ], 'M2tsPcrControl' => [ 'type' => 'string', 'enum' => [ 'CONFIGURED_PCR_PERIOD', 'PCR_EVERY_PES_PACKET', ], ], 'M2tsRateMode' => [ 'type' => 'string', 'enum' => [ 'CBR', 'VBR', ], ], 'M2tsScte35Control' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', ], ], 'M2tsSegmentationMarkers' => [ 'type' => 'string', 'enum' => [ 'EBP', 'EBP_LEGACY', 'NONE', 'PSI_SEGSTART', 'RAI_ADAPT', 'RAI_SEGSTART', ], ], 'M2tsSegmentationStyle' => [ 'type' => 'string', 'enum' => [ 'MAINTAIN_CADENCE', 'RESET_CADENCE', ], ], 'M2tsSettings' => [ 'type' => 'structure', 'members' => [ 'AbsentInputAudioBehavior' => [ 'shape' => 'M2tsAbsentInputAudioBehavior', 'locationName' => 'absentInputAudioBehavior', ], 'Arib' => [ 'shape' => 'M2tsArib', 'locationName' => 'arib', ], 'AribCaptionsPid' => [ 'shape' => '__string', 'locationName' => 'aribCaptionsPid', ], 'AribCaptionsPidControl' => [ 'shape' => 'M2tsAribCaptionsPidControl', 'locationName' => 'aribCaptionsPidControl', ], 'AudioBufferModel' => [ 'shape' => 'M2tsAudioBufferModel', 'locationName' => 'audioBufferModel', ], 'AudioFramesPerPes' => [ 'shape' => '__integerMin0', 'locationName' => 'audioFramesPerPes', ], 'AudioPids' => [ 'shape' => '__string', 'locationName' => 'audioPids', ], 'AudioStreamType' => [ 'shape' => 'M2tsAudioStreamType', 'locationName' => 'audioStreamType', ], 'Bitrate' => [ 'shape' => '__integerMin0', 'locationName' => 'bitrate', ], 'BufferModel' => [ 'shape' => 'M2tsBufferModel', 'locationName' => 'bufferModel', ], 'CcDescriptor' => [ 'shape' => 'M2tsCcDescriptor', 'locationName' => 'ccDescriptor', ], 'DvbNitSettings' => [ 'shape' => 'DvbNitSettings', 'locationName' => 'dvbNitSettings', ], 'DvbSdtSettings' => [ 'shape' => 'DvbSdtSettings', 'locationName' => 'dvbSdtSettings', ], 'DvbSubPids' => [ 'shape' => '__string', 'locationName' => 'dvbSubPids', ], 'DvbTdtSettings' => [ 'shape' => 'DvbTdtSettings', 'locationName' => 'dvbTdtSettings', ], 'DvbTeletextPid' => [ 'shape' => '__string', 'locationName' => 'dvbTeletextPid', ], 'Ebif' => [ 'shape' => 'M2tsEbifControl', 'locationName' => 'ebif', ], 'EbpAudioInterval' => [ 'shape' => 'M2tsAudioInterval', 'locationName' => 'ebpAudioInterval', ], 'EbpLookaheadMs' => [ 'shape' => '__integerMin0Max10000', 'locationName' => 'ebpLookaheadMs', ], 'EbpPlacement' => [ 'shape' => 'M2tsEbpPlacement', 'locationName' => 'ebpPlacement', ], 'EcmPid' => [ 'shape' => '__string', 'locationName' => 'ecmPid', ], 'EsRateInPes' => [ 'shape' => 'M2tsEsRateInPes', 'locationName' => 'esRateInPes', ], 'EtvPlatformPid' => [ 'shape' => '__string', 'locationName' => 'etvPlatformPid', ], 'EtvSignalPid' => [ 'shape' => '__string', 'locationName' => 'etvSignalPid', ], 'FragmentTime' => [ 'shape' => '__doubleMin0', 'locationName' => 'fragmentTime', ], 'Klv' => [ 'shape' => 'M2tsKlv', 'locationName' => 'klv', ], 'KlvDataPids' => [ 'shape' => '__string', 'locationName' => 'klvDataPids', ], 'NullPacketBitrate' => [ 'shape' => '__doubleMin0', 'locationName' => 'nullPacketBitrate', ], 'PatInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'patInterval', ], 'PcrControl' => [ 'shape' => 'M2tsPcrControl', 'locationName' => 'pcrControl', ], 'PcrPeriod' => [ 'shape' => '__integerMin0Max500', 'locationName' => 'pcrPeriod', ], 'PcrPid' => [ 'shape' => '__string', 'locationName' => 'pcrPid', ], 'PmtInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'pmtInterval', ], 'PmtPid' => [ 'shape' => '__string', 'locationName' => 'pmtPid', ], 'ProgramNum' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'programNum', ], 'RateMode' => [ 'shape' => 'M2tsRateMode', 'locationName' => 'rateMode', ], 'Scte27Pids' => [ 'shape' => '__string', 'locationName' => 'scte27Pids', ], 'Scte35Control' => [ 'shape' => 'M2tsScte35Control', 'locationName' => 'scte35Control', ], 'Scte35Pid' => [ 'shape' => '__string', 'locationName' => 'scte35Pid', ], 'SegmentationMarkers' => [ 'shape' => 'M2tsSegmentationMarkers', 'locationName' => 'segmentationMarkers', ], 'SegmentationStyle' => [ 'shape' => 'M2tsSegmentationStyle', 'locationName' => 'segmentationStyle', ], 'SegmentationTime' => [ 'shape' => '__doubleMin1', 'locationName' => 'segmentationTime', ], 'TimedMetadataBehavior' => [ 'shape' => 'M2tsTimedMetadataBehavior', 'locationName' => 'timedMetadataBehavior', ], 'TimedMetadataPid' => [ 'shape' => '__string', 'locationName' => 'timedMetadataPid', ], 'TransportStreamId' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'transportStreamId', ], 'VideoPid' => [ 'shape' => '__string', 'locationName' => 'videoPid', ], ], ], 'M2tsTimedMetadataBehavior' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'PASSTHROUGH', ], ], 'M3u8PcrControl' => [ 'type' => 'string', 'enum' => [ 'CONFIGURED_PCR_PERIOD', 'PCR_EVERY_PES_PACKET', ], ], 'M3u8Scte35Behavior' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'PASSTHROUGH', ], ], 'M3u8Settings' => [ 'type' => 'structure', 'members' => [ 'AudioFramesPerPes' => [ 'shape' => '__integerMin0', 'locationName' => 'audioFramesPerPes', ], 'AudioPids' => [ 'shape' => '__string', 'locationName' => 'audioPids', ], 'EcmPid' => [ 'shape' => '__string', 'locationName' => 'ecmPid', ], 'PatInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'patInterval', ], 'PcrControl' => [ 'shape' => 'M3u8PcrControl', 'locationName' => 'pcrControl', ], 'PcrPeriod' => [ 'shape' => '__integerMin0Max500', 'locationName' => 'pcrPeriod', ], 'PcrPid' => [ 'shape' => '__string', 'locationName' => 'pcrPid', ], 'PmtInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'pmtInterval', ], 'PmtPid' => [ 'shape' => '__string', 'locationName' => 'pmtPid', ], 'ProgramNum' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'programNum', ], 'Scte35Behavior' => [ 'shape' => 'M3u8Scte35Behavior', 'locationName' => 'scte35Behavior', ], 'Scte35Pid' => [ 'shape' => '__string', 'locationName' => 'scte35Pid', ], 'TimedMetadataBehavior' => [ 'shape' => 'M3u8TimedMetadataBehavior', 'locationName' => 'timedMetadataBehavior', ], 'TimedMetadataPid' => [ 'shape' => '__string', 'locationName' => 'timedMetadataPid', ], 'TransportStreamId' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'transportStreamId', ], 'VideoPid' => [ 'shape' => '__string', 'locationName' => 'videoPid', ], ], ], 'M3u8TimedMetadataBehavior' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'PASSTHROUGH', ], ], 'MaxResults' => [ 'type' => 'integer', 'min' => 1, 'max' => 1000, ], 'MediaConnectFlow' => [ 'type' => 'structure', 'members' => [ 'FlowArn' => [ 'shape' => '__string', 'locationName' => 'flowArn', ], ], ], 'MediaConnectFlowRequest' => [ 'type' => 'structure', 'members' => [ 'FlowArn' => [ 'shape' => '__string', 'locationName' => 'flowArn', ], ], ], 'Mp2CodingMode' => [ 'type' => 'string', 'enum' => [ 'CODING_MODE_1_0', 'CODING_MODE_2_0', ], ], 'Mp2Settings' => [ 'type' => 'structure', 'members' => [ 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'CodingMode' => [ 'shape' => 'Mp2CodingMode', 'locationName' => 'codingMode', ], 'SampleRate' => [ 'shape' => '__double', 'locationName' => 'sampleRate', ], ], ], 'MsSmoothGroupSettings' => [ 'type' => 'structure', 'members' => [ 'AcquisitionPointId' => [ 'shape' => '__string', 'locationName' => 'acquisitionPointId', ], 'AudioOnlyTimecodeControl' => [ 'shape' => 'SmoothGroupAudioOnlyTimecodeControl', 'locationName' => 'audioOnlyTimecodeControl', ], 'CertificateMode' => [ 'shape' => 'SmoothGroupCertificateMode', 'locationName' => 'certificateMode', ], 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'EventId' => [ 'shape' => '__string', 'locationName' => 'eventId', ], 'EventIdMode' => [ 'shape' => 'SmoothGroupEventIdMode', 'locationName' => 'eventIdMode', ], 'EventStopBehavior' => [ 'shape' => 'SmoothGroupEventStopBehavior', 'locationName' => 'eventStopBehavior', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0', 'locationName' => 'filecacheDuration', ], 'FragmentLength' => [ 'shape' => '__integerMin1', 'locationName' => 'fragmentLength', ], 'InputLossAction' => [ 'shape' => 'InputLossActionForMsSmoothOut', 'locationName' => 'inputLossAction', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0', 'locationName' => 'restartDelay', ], 'SegmentationMode' => [ 'shape' => 'SmoothGroupSegmentationMode', 'locationName' => 'segmentationMode', ], 'SendDelayMs' => [ 'shape' => '__integerMin0Max10000', 'locationName' => 'sendDelayMs', ], 'SparseTrackType' => [ 'shape' => 'SmoothGroupSparseTrackType', 'locationName' => 'sparseTrackType', ], 'StreamManifestBehavior' => [ 'shape' => 'SmoothGroupStreamManifestBehavior', 'locationName' => 'streamManifestBehavior', ], 'TimestampOffset' => [ 'shape' => '__string', 'locationName' => 'timestampOffset', ], 'TimestampOffsetMode' => [ 'shape' => 'SmoothGroupTimestampOffsetMode', 'locationName' => 'timestampOffsetMode', ], ], 'required' => [ 'Destination', ], ], 'MsSmoothOutputSettings' => [ 'type' => 'structure', 'members' => [ 'NameModifier' => [ 'shape' => '__string', 'locationName' => 'nameModifier', ], ], ], 'NetworkInputServerValidation' => [ 'type' => 'string', 'enum' => [ 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME', 'CHECK_CRYPTOGRAPHY_ONLY', ], ], 'NetworkInputSettings' => [ 'type' => 'structure', 'members' => [ 'HlsInputSettings' => [ 'shape' => 'HlsInputSettings', 'locationName' => 'hlsInputSettings', ], 'ServerValidation' => [ 'shape' => 'NetworkInputServerValidation', 'locationName' => 'serverValidation', ], ], ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 404, ], ], 'Offering' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'OfferingDurationUnits' => [ 'type' => 'string', 'enum' => [ 'MONTHS', ], ], 'OfferingType' => [ 'type' => 'string', 'enum' => [ 'NO_UPFRONT', ], ], 'Output' => [ 'type' => 'structure', 'members' => [ 'AudioDescriptionNames' => [ 'shape' => '__listOf__string', 'locationName' => 'audioDescriptionNames', ], 'CaptionDescriptionNames' => [ 'shape' => '__listOf__string', 'locationName' => 'captionDescriptionNames', ], 'OutputName' => [ 'shape' => '__stringMin1Max255', 'locationName' => 'outputName', ], 'OutputSettings' => [ 'shape' => 'OutputSettings', 'locationName' => 'outputSettings', ], 'VideoDescriptionName' => [ 'shape' => '__string', 'locationName' => 'videoDescriptionName', ], ], 'required' => [ 'OutputSettings', ], ], 'OutputDestination' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'Settings' => [ 'shape' => '__listOfOutputDestinationSettings', 'locationName' => 'settings', ], ], ], 'OutputDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'StreamName' => [ 'shape' => '__string', 'locationName' => 'streamName', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], ], 'OutputGroup' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__stringMax32', 'locationName' => 'name', ], 'OutputGroupSettings' => [ 'shape' => 'OutputGroupSettings', 'locationName' => 'outputGroupSettings', ], 'Outputs' => [ 'shape' => '__listOfOutput', 'locationName' => 'outputs', ], ], 'required' => [ 'Outputs', 'OutputGroupSettings', ], ], 'OutputGroupSettings' => [ 'type' => 'structure', 'members' => [ 'ArchiveGroupSettings' => [ 'shape' => 'ArchiveGroupSettings', 'locationName' => 'archiveGroupSettings', ], 'FrameCaptureGroupSettings' => [ 'shape' => 'FrameCaptureGroupSettings', 'locationName' => 'frameCaptureGroupSettings', ], 'HlsGroupSettings' => [ 'shape' => 'HlsGroupSettings', 'locationName' => 'hlsGroupSettings', ], 'MsSmoothGroupSettings' => [ 'shape' => 'MsSmoothGroupSettings', 'locationName' => 'msSmoothGroupSettings', ], 'RtmpGroupSettings' => [ 'shape' => 'RtmpGroupSettings', 'locationName' => 'rtmpGroupSettings', ], 'UdpGroupSettings' => [ 'shape' => 'UdpGroupSettings', 'locationName' => 'udpGroupSettings', ], ], ], 'OutputLocationRef' => [ 'type' => 'structure', 'members' => [ 'DestinationRefId' => [ 'shape' => '__string', 'locationName' => 'destinationRefId', ], ], ], 'OutputSettings' => [ 'type' => 'structure', 'members' => [ 'ArchiveOutputSettings' => [ 'shape' => 'ArchiveOutputSettings', 'locationName' => 'archiveOutputSettings', ], 'FrameCaptureOutputSettings' => [ 'shape' => 'FrameCaptureOutputSettings', 'locationName' => 'frameCaptureOutputSettings', ], 'HlsOutputSettings' => [ 'shape' => 'HlsOutputSettings', 'locationName' => 'hlsOutputSettings', ], 'MsSmoothOutputSettings' => [ 'shape' => 'MsSmoothOutputSettings', 'locationName' => 'msSmoothOutputSettings', ], 'RtmpOutputSettings' => [ 'shape' => 'RtmpOutputSettings', 'locationName' => 'rtmpOutputSettings', ], 'UdpOutputSettings' => [ 'shape' => 'UdpOutputSettings', 'locationName' => 'udpOutputSettings', ], ], ], 'PassThroughSettings' => [ 'type' => 'structure', 'members' => [], ], 'PauseStateScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Pipelines' => [ 'shape' => '__listOfPipelinePauseStateSettings', 'locationName' => 'pipelines', ], ], ], 'PipelineId' => [ 'type' => 'string', 'enum' => [ 'PIPELINE_0', 'PIPELINE_1', ], ], 'PipelinePauseStateSettings' => [ 'type' => 'structure', 'members' => [ 'PipelineId' => [ 'shape' => 'PipelineId', 'locationName' => 'pipelineId', ], ], 'required' => [ 'PipelineId', ], ], 'PurchaseOffering' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => '__integerMin1', 'locationName' => 'count', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], ], 'required' => [ 'Count', ], ], 'PurchaseOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => '__integerMin1', 'locationName' => 'count', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'offeringId', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], ], 'required' => [ 'OfferingId', 'Count', ], ], 'PurchaseOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'Reservation' => [ 'shape' => 'Reservation', 'locationName' => 'reservation', ], ], ], 'PurchaseOfferingResultModel' => [ 'type' => 'structure', 'members' => [ 'Reservation' => [ 'shape' => 'Reservation', 'locationName' => 'reservation', ], ], ], 'RemixSettings' => [ 'type' => 'structure', 'members' => [ 'ChannelMappings' => [ 'shape' => '__listOfAudioChannelMapping', 'locationName' => 'channelMappings', ], 'ChannelsIn' => [ 'shape' => '__integerMin1Max16', 'locationName' => 'channelsIn', ], 'ChannelsOut' => [ 'shape' => '__integerMin1Max8', 'locationName' => 'channelsOut', ], ], 'required' => [ 'ChannelMappings', ], ], 'Reservation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Count' => [ 'shape' => '__integer', 'locationName' => 'count', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'End' => [ 'shape' => '__string', 'locationName' => 'end', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ReservationId' => [ 'shape' => '__string', 'locationName' => 'reservationId', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], 'State' => [ 'shape' => 'ReservationState', 'locationName' => 'state', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'ReservationCodec' => [ 'type' => 'string', 'enum' => [ 'MPEG2', 'AVC', 'HEVC', 'AUDIO', ], ], 'ReservationMaximumBitrate' => [ 'type' => 'string', 'enum' => [ 'MAX_10_MBPS', 'MAX_20_MBPS', 'MAX_50_MBPS', ], ], 'ReservationMaximumFramerate' => [ 'type' => 'string', 'enum' => [ 'MAX_30_FPS', 'MAX_60_FPS', ], ], 'ReservationResolution' => [ 'type' => 'string', 'enum' => [ 'SD', 'HD', 'UHD', ], ], 'ReservationResourceSpecification' => [ 'type' => 'structure', 'members' => [ 'Codec' => [ 'shape' => 'ReservationCodec', 'locationName' => 'codec', ], 'MaximumBitrate' => [ 'shape' => 'ReservationMaximumBitrate', 'locationName' => 'maximumBitrate', ], 'MaximumFramerate' => [ 'shape' => 'ReservationMaximumFramerate', 'locationName' => 'maximumFramerate', ], 'Resolution' => [ 'shape' => 'ReservationResolution', 'locationName' => 'resolution', ], 'ResourceType' => [ 'shape' => 'ReservationResourceType', 'locationName' => 'resourceType', ], 'SpecialFeature' => [ 'shape' => 'ReservationSpecialFeature', 'locationName' => 'specialFeature', ], 'VideoQuality' => [ 'shape' => 'ReservationVideoQuality', 'locationName' => 'videoQuality', ], ], ], 'ReservationResourceType' => [ 'type' => 'string', 'enum' => [ 'INPUT', 'OUTPUT', 'CHANNEL', ], ], 'ReservationSpecialFeature' => [ 'type' => 'string', 'enum' => [ 'ADVANCED_AUDIO', 'AUDIO_NORMALIZATION', ], ], 'ReservationState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'EXPIRED', 'CANCELED', 'DELETED', ], ], 'ReservationVideoQuality' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'ENHANCED', 'PREMIUM', ], ], 'ResourceConflict' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'RtmpCacheFullBehavior' => [ 'type' => 'string', 'enum' => [ 'DISCONNECT_IMMEDIATELY', 'WAIT_FOR_SERVER', ], ], 'RtmpCaptionData' => [ 'type' => 'string', 'enum' => [ 'ALL', 'FIELD1_608', 'FIELD1_AND_FIELD2_608', ], ], 'RtmpCaptionInfoDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'RtmpGroupSettings' => [ 'type' => 'structure', 'members' => [ 'AuthenticationScheme' => [ 'shape' => 'AuthenticationScheme', 'locationName' => 'authenticationScheme', ], 'CacheFullBehavior' => [ 'shape' => 'RtmpCacheFullBehavior', 'locationName' => 'cacheFullBehavior', ], 'CacheLength' => [ 'shape' => '__integerMin30', 'locationName' => 'cacheLength', ], 'CaptionData' => [ 'shape' => 'RtmpCaptionData', 'locationName' => 'captionData', ], 'InputLossAction' => [ 'shape' => 'InputLossActionForRtmpOut', 'locationName' => 'inputLossAction', ], 'RestartDelay' => [ 'shape' => '__integerMin0', 'locationName' => 'restartDelay', ], ], ], 'RtmpOutputCertificateMode' => [ 'type' => 'string', 'enum' => [ 'SELF_SIGNED', 'VERIFY_AUTHENTICITY', ], ], 'RtmpOutputSettings' => [ 'type' => 'structure', 'members' => [ 'CertificateMode' => [ 'shape' => 'RtmpOutputCertificateMode', 'locationName' => 'certificateMode', ], 'ConnectionRetryInterval' => [ 'shape' => '__integerMin1', 'locationName' => 'connectionRetryInterval', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], ], 'required' => [ 'Destination', ], ], 'ScheduleAction' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => '__string', 'locationName' => 'actionName', ], 'ScheduleActionSettings' => [ 'shape' => 'ScheduleActionSettings', 'locationName' => 'scheduleActionSettings', ], 'ScheduleActionStartSettings' => [ 'shape' => 'ScheduleActionStartSettings', 'locationName' => 'scheduleActionStartSettings', ], ], 'required' => [ 'ActionName', 'ScheduleActionStartSettings', 'ScheduleActionSettings', ], ], 'ScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'HlsTimedMetadataSettings' => [ 'shape' => 'HlsTimedMetadataScheduleActionSettings', 'locationName' => 'hlsTimedMetadataSettings', ], 'InputSwitchSettings' => [ 'shape' => 'InputSwitchScheduleActionSettings', 'locationName' => 'inputSwitchSettings', ], 'PauseStateSettings' => [ 'shape' => 'PauseStateScheduleActionSettings', 'locationName' => 'pauseStateSettings', ], 'Scte35ReturnToNetworkSettings' => [ 'shape' => 'Scte35ReturnToNetworkScheduleActionSettings', 'locationName' => 'scte35ReturnToNetworkSettings', ], 'Scte35SpliceInsertSettings' => [ 'shape' => 'Scte35SpliceInsertScheduleActionSettings', 'locationName' => 'scte35SpliceInsertSettings', ], 'Scte35TimeSignalSettings' => [ 'shape' => 'Scte35TimeSignalScheduleActionSettings', 'locationName' => 'scte35TimeSignalSettings', ], 'StaticImageActivateSettings' => [ 'shape' => 'StaticImageActivateScheduleActionSettings', 'locationName' => 'staticImageActivateSettings', ], 'StaticImageDeactivateSettings' => [ 'shape' => 'StaticImageDeactivateScheduleActionSettings', 'locationName' => 'staticImageDeactivateSettings', ], ], ], 'ScheduleActionStartSettings' => [ 'type' => 'structure', 'members' => [ 'FixedModeScheduleActionStartSettings' => [ 'shape' => 'FixedModeScheduleActionStartSettings', 'locationName' => 'fixedModeScheduleActionStartSettings', ], 'FollowModeScheduleActionStartSettings' => [ 'shape' => 'FollowModeScheduleActionStartSettings', 'locationName' => 'followModeScheduleActionStartSettings', ], ], ], 'ScheduleDescribeResultModel' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'Scte20Convert608To708' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'UPCONVERT', ], ], 'Scte20PlusEmbeddedDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'Scte20SourceSettings' => [ 'type' => 'structure', 'members' => [ 'Convert608To708' => [ 'shape' => 'Scte20Convert608To708', 'locationName' => 'convert608To708', ], 'Source608ChannelNumber' => [ 'shape' => '__integerMin1Max4', 'locationName' => 'source608ChannelNumber', ], ], ], 'Scte27DestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'Scte27SourceSettings' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin1', 'locationName' => 'pid', ], ], ], 'Scte35AposNoRegionalBlackoutBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35AposWebDeliveryAllowedBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35ArchiveAllowedFlag' => [ 'type' => 'string', 'enum' => [ 'ARCHIVE_NOT_ALLOWED', 'ARCHIVE_ALLOWED', ], ], 'Scte35DeliveryRestrictions' => [ 'type' => 'structure', 'members' => [ 'ArchiveAllowedFlag' => [ 'shape' => 'Scte35ArchiveAllowedFlag', 'locationName' => 'archiveAllowedFlag', ], 'DeviceRestrictions' => [ 'shape' => 'Scte35DeviceRestrictions', 'locationName' => 'deviceRestrictions', ], 'NoRegionalBlackoutFlag' => [ 'shape' => 'Scte35NoRegionalBlackoutFlag', 'locationName' => 'noRegionalBlackoutFlag', ], 'WebDeliveryAllowedFlag' => [ 'shape' => 'Scte35WebDeliveryAllowedFlag', 'locationName' => 'webDeliveryAllowedFlag', ], ], 'required' => [ 'DeviceRestrictions', 'ArchiveAllowedFlag', 'WebDeliveryAllowedFlag', 'NoRegionalBlackoutFlag', ], ], 'Scte35Descriptor' => [ 'type' => 'structure', 'members' => [ 'Scte35DescriptorSettings' => [ 'shape' => 'Scte35DescriptorSettings', 'locationName' => 'scte35DescriptorSettings', ], ], 'required' => [ 'Scte35DescriptorSettings', ], ], 'Scte35DescriptorSettings' => [ 'type' => 'structure', 'members' => [ 'SegmentationDescriptorScte35DescriptorSettings' => [ 'shape' => 'Scte35SegmentationDescriptor', 'locationName' => 'segmentationDescriptorScte35DescriptorSettings', ], ], 'required' => [ 'SegmentationDescriptorScte35DescriptorSettings', ], ], 'Scte35DeviceRestrictions' => [ 'type' => 'string', 'enum' => [ 'NONE', 'RESTRICT_GROUP0', 'RESTRICT_GROUP1', 'RESTRICT_GROUP2', ], ], 'Scte35NoRegionalBlackoutFlag' => [ 'type' => 'string', 'enum' => [ 'REGIONAL_BLACKOUT', 'NO_REGIONAL_BLACKOUT', ], ], 'Scte35ReturnToNetworkScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'SpliceEventId' => [ 'shape' => '__integerMin0Max4294967295', 'locationName' => 'spliceEventId', ], ], 'required' => [ 'SpliceEventId', ], ], 'Scte35SegmentationCancelIndicator' => [ 'type' => 'string', 'enum' => [ 'SEGMENTATION_EVENT_NOT_CANCELED', 'SEGMENTATION_EVENT_CANCELED', ], ], 'Scte35SegmentationDescriptor' => [ 'type' => 'structure', 'members' => [ 'DeliveryRestrictions' => [ 'shape' => 'Scte35DeliveryRestrictions', 'locationName' => 'deliveryRestrictions', ], 'SegmentNum' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentNum', ], 'SegmentationCancelIndicator' => [ 'shape' => 'Scte35SegmentationCancelIndicator', 'locationName' => 'segmentationCancelIndicator', ], 'SegmentationDuration' => [ 'shape' => '__integerMin0Max1099511627775', 'locationName' => 'segmentationDuration', ], 'SegmentationEventId' => [ 'shape' => '__integerMin0Max4294967295', 'locationName' => 'segmentationEventId', ], 'SegmentationTypeId' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentationTypeId', ], 'SegmentationUpid' => [ 'shape' => '__string', 'locationName' => 'segmentationUpid', ], 'SegmentationUpidType' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentationUpidType', ], 'SegmentsExpected' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentsExpected', ], 'SubSegmentNum' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'subSegmentNum', ], 'SubSegmentsExpected' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'subSegmentsExpected', ], ], 'required' => [ 'SegmentationEventId', 'SegmentationCancelIndicator', ], ], 'Scte35SpliceInsert' => [ 'type' => 'structure', 'members' => [ 'AdAvailOffset' => [ 'shape' => '__integerMinNegative1000Max1000', 'locationName' => 'adAvailOffset', ], 'NoRegionalBlackoutFlag' => [ 'shape' => 'Scte35SpliceInsertNoRegionalBlackoutBehavior', 'locationName' => 'noRegionalBlackoutFlag', ], 'WebDeliveryAllowedFlag' => [ 'shape' => 'Scte35SpliceInsertWebDeliveryAllowedBehavior', 'locationName' => 'webDeliveryAllowedFlag', ], ], ], 'Scte35SpliceInsertNoRegionalBlackoutBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35SpliceInsertScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Duration' => [ 'shape' => '__integerMin0Max8589934591', 'locationName' => 'duration', ], 'SpliceEventId' => [ 'shape' => '__integerMin0Max4294967295', 'locationName' => 'spliceEventId', ], ], 'required' => [ 'SpliceEventId', ], ], 'Scte35SpliceInsertWebDeliveryAllowedBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35TimeSignalApos' => [ 'type' => 'structure', 'members' => [ 'AdAvailOffset' => [ 'shape' => '__integerMinNegative1000Max1000', 'locationName' => 'adAvailOffset', ], 'NoRegionalBlackoutFlag' => [ 'shape' => 'Scte35AposNoRegionalBlackoutBehavior', 'locationName' => 'noRegionalBlackoutFlag', ], 'WebDeliveryAllowedFlag' => [ 'shape' => 'Scte35AposWebDeliveryAllowedBehavior', 'locationName' => 'webDeliveryAllowedFlag', ], ], ], 'Scte35TimeSignalScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Scte35Descriptors' => [ 'shape' => '__listOfScte35Descriptor', 'locationName' => 'scte35Descriptors', ], ], 'required' => [ 'Scte35Descriptors', ], ], 'Scte35WebDeliveryAllowedFlag' => [ 'type' => 'string', 'enum' => [ 'WEB_DELIVERY_NOT_ALLOWED', 'WEB_DELIVERY_ALLOWED', ], ], 'SmoothGroupAudioOnlyTimecodeControl' => [ 'type' => 'string', 'enum' => [ 'PASSTHROUGH', 'USE_CONFIGURED_CLOCK', ], ], 'SmoothGroupCertificateMode' => [ 'type' => 'string', 'enum' => [ 'SELF_SIGNED', 'VERIFY_AUTHENTICITY', ], ], 'SmoothGroupEventIdMode' => [ 'type' => 'string', 'enum' => [ 'NO_EVENT_ID', 'USE_CONFIGURED', 'USE_TIMESTAMP', ], ], 'SmoothGroupEventStopBehavior' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SEND_EOS', ], ], 'SmoothGroupSegmentationMode' => [ 'type' => 'string', 'enum' => [ 'USE_INPUT_SEGMENTATION', 'USE_SEGMENT_DURATION', ], ], 'SmoothGroupSparseTrackType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SCTE_35', ], ], 'SmoothGroupStreamManifestBehavior' => [ 'type' => 'string', 'enum' => [ 'DO_NOT_SEND', 'SEND', ], ], 'SmoothGroupTimestampOffsetMode' => [ 'type' => 'string', 'enum' => [ 'USE_CONFIGURED_OFFSET', 'USE_EVENT_START_DATE', ], ], 'SmpteTtDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'StandardHlsSettings' => [ 'type' => 'structure', 'members' => [ 'AudioRenditionSets' => [ 'shape' => '__string', 'locationName' => 'audioRenditionSets', ], 'M3u8Settings' => [ 'shape' => 'M3u8Settings', 'locationName' => 'm3u8Settings', ], ], 'required' => [ 'M3u8Settings', ], ], 'StartChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'StartChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'StaticImageActivateScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Duration' => [ 'shape' => '__integerMin0', 'locationName' => 'duration', ], 'FadeIn' => [ 'shape' => '__integerMin0', 'locationName' => 'fadeIn', ], 'FadeOut' => [ 'shape' => '__integerMin0', 'locationName' => 'fadeOut', ], 'Height' => [ 'shape' => '__integerMin1', 'locationName' => 'height', ], 'Image' => [ 'shape' => 'InputLocation', 'locationName' => 'image', ], 'ImageX' => [ 'shape' => '__integerMin0', 'locationName' => 'imageX', ], 'ImageY' => [ 'shape' => '__integerMin0', 'locationName' => 'imageY', ], 'Layer' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'layer', ], 'Opacity' => [ 'shape' => '__integerMin0Max100', 'locationName' => 'opacity', ], 'Width' => [ 'shape' => '__integerMin1', 'locationName' => 'width', ], ], 'required' => [ 'Image', ], ], 'StaticImageDeactivateScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'FadeOut' => [ 'shape' => '__integerMin0', 'locationName' => 'fadeOut', ], 'Layer' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'layer', ], ], ], 'StaticKeySettings' => [ 'type' => 'structure', 'members' => [ 'KeyProviderServer' => [ 'shape' => 'InputLocation', 'locationName' => 'keyProviderServer', ], 'StaticKeyValue' => [ 'shape' => '__stringMin32Max32', 'locationName' => 'staticKeyValue', ], ], 'required' => [ 'StaticKeyValue', ], ], 'StopChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'StopChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'Tags' => [ 'type' => 'map', 'key' => [ 'shape' => '__string', ], 'value' => [ 'shape' => '__string', ], ], 'TagsModel' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'TeletextDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'TeletextSourceSettings' => [ 'type' => 'structure', 'members' => [ 'PageNumber' => [ 'shape' => '__string', 'locationName' => 'pageNumber', ], ], ], 'TimecodeConfig' => [ 'type' => 'structure', 'members' => [ 'Source' => [ 'shape' => 'TimecodeConfigSource', 'locationName' => 'source', ], 'SyncThreshold' => [ 'shape' => '__integerMin1Max1000000', 'locationName' => 'syncThreshold', ], ], 'required' => [ 'Source', ], ], 'TimecodeConfigSource' => [ 'type' => 'string', 'enum' => [ 'EMBEDDED', 'SYSTEMCLOCK', 'ZEROBASED', ], ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 429, ], ], 'TtmlDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'StyleControl' => [ 'shape' => 'TtmlDestinationStyleControl', 'locationName' => 'styleControl', ], ], ], 'TtmlDestinationStyleControl' => [ 'type' => 'string', 'enum' => [ 'PASSTHROUGH', 'USE_CONFIGURED', ], ], 'UdpContainerSettings' => [ 'type' => 'structure', 'members' => [ 'M2tsSettings' => [ 'shape' => 'M2tsSettings', 'locationName' => 'm2tsSettings', ], ], ], 'UdpGroupSettings' => [ 'type' => 'structure', 'members' => [ 'InputLossAction' => [ 'shape' => 'InputLossActionForUdpOut', 'locationName' => 'inputLossAction', ], 'TimedMetadataId3Frame' => [ 'shape' => 'UdpTimedMetadataId3Frame', 'locationName' => 'timedMetadataId3Frame', ], 'TimedMetadataId3Period' => [ 'shape' => '__integerMin0', 'locationName' => 'timedMetadataId3Period', ], ], ], 'UdpOutputSettings' => [ 'type' => 'structure', 'members' => [ 'BufferMsec' => [ 'shape' => '__integerMin0Max10000', 'locationName' => 'bufferMsec', ], 'ContainerSettings' => [ 'shape' => 'UdpContainerSettings', 'locationName' => 'containerSettings', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'FecOutputSettings' => [ 'shape' => 'FecOutputSettings', 'locationName' => 'fecOutputSettings', ], ], 'required' => [ 'Destination', 'ContainerSettings', ], ], 'UdpTimedMetadataId3Frame' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PRIV', 'TDRL', ], ], 'UnprocessableEntityException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], 'ValidationErrors' => [ 'shape' => '__listOfValidationError', 'locationName' => 'validationErrors', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 422, ], ], 'UpdateChannel' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], ], ], 'UpdateChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], ], 'required' => [ 'ChannelId', ], ], 'UpdateChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'UpdateChannelResultModel' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'UpdateInput' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], ], ], 'UpdateInputRequest' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputId', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], ], 'required' => [ 'InputId', ], ], 'UpdateInputResponse' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'UpdateInputResultModel' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'UpdateInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputSecurityGroupId', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRuleCidr', 'locationName' => 'whitelistRules', ], ], 'required' => [ 'InputSecurityGroupId', ], ], 'UpdateInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'UpdateInputSecurityGroupResultModel' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'ValidationError' => [ 'type' => 'structure', 'members' => [ 'ElementPath' => [ 'shape' => '__string', 'locationName' => 'elementPath', ], 'ErrorMessage' => [ 'shape' => '__string', 'locationName' => 'errorMessage', ], ], ], 'VideoCodecSettings' => [ 'type' => 'structure', 'members' => [ 'FrameCaptureSettings' => [ 'shape' => 'FrameCaptureSettings', 'locationName' => 'frameCaptureSettings', ], 'H264Settings' => [ 'shape' => 'H264Settings', 'locationName' => 'h264Settings', ], ], ], 'VideoDescription' => [ 'type' => 'structure', 'members' => [ 'CodecSettings' => [ 'shape' => 'VideoCodecSettings', 'locationName' => 'codecSettings', ], 'Height' => [ 'shape' => '__integer', 'locationName' => 'height', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RespondToAfd' => [ 'shape' => 'VideoDescriptionRespondToAfd', 'locationName' => 'respondToAfd', ], 'ScalingBehavior' => [ 'shape' => 'VideoDescriptionScalingBehavior', 'locationName' => 'scalingBehavior', ], 'Sharpness' => [ 'shape' => '__integerMin0Max100', 'locationName' => 'sharpness', ], 'Width' => [ 'shape' => '__integer', 'locationName' => 'width', ], ], 'required' => [ 'Name', ], ], 'VideoDescriptionRespondToAfd' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', 'RESPOND', ], ], 'VideoDescriptionScalingBehavior' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'STRETCH_TO_OUTPUT', ], ], 'VideoSelector' => [ 'type' => 'structure', 'members' => [ 'ColorSpace' => [ 'shape' => 'VideoSelectorColorSpace', 'locationName' => 'colorSpace', ], 'ColorSpaceUsage' => [ 'shape' => 'VideoSelectorColorSpaceUsage', 'locationName' => 'colorSpaceUsage', ], 'SelectorSettings' => [ 'shape' => 'VideoSelectorSettings', 'locationName' => 'selectorSettings', ], ], ], 'VideoSelectorColorSpace' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'REC_601', 'REC_709', ], ], 'VideoSelectorColorSpaceUsage' => [ 'type' => 'string', 'enum' => [ 'FALLBACK', 'FORCE', ], ], 'VideoSelectorPid' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin0Max8191', 'locationName' => 'pid', ], ], ], 'VideoSelectorProgramId' => [ 'type' => 'structure', 'members' => [ 'ProgramId' => [ 'shape' => '__integerMin0Max65536', 'locationName' => 'programId', ], ], ], 'VideoSelectorSettings' => [ 'type' => 'structure', 'members' => [ 'VideoSelectorPid' => [ 'shape' => 'VideoSelectorPid', 'locationName' => 'videoSelectorPid', ], 'VideoSelectorProgramId' => [ 'shape' => 'VideoSelectorProgramId', 'locationName' => 'videoSelectorProgramId', ], ], ], 'WebvttDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], '__boolean' => [ 'type' => 'boolean', ], '__double' => [ 'type' => 'double', ], '__doubleMin0' => [ 'type' => 'double', ], '__doubleMin1' => [ 'type' => 'double', ], '__doubleMinNegative59Max0' => [ 'type' => 'double', ], '__integer' => [ 'type' => 'integer', ], '__integerMin0' => [ 'type' => 'integer', 'min' => 0, ], '__integerMin0Max10' => [ 'type' => 'integer', 'min' => 0, 'max' => 10, ], '__integerMin0Max100' => [ 'type' => 'integer', 'min' => 0, 'max' => 100, ], '__integerMin0Max1000' => [ 'type' => 'integer', 'min' => 0, 'max' => 1000, ], '__integerMin0Max10000' => [ 'type' => 'integer', 'min' => 0, 'max' => 10000, ], '__integerMin0Max1000000' => [ 'type' => 'integer', 'min' => 0, 'max' => 1000000, ], '__integerMin0Max1099511627775' => [ 'type' => 'long', 'min' => 0, 'max' => 1099511627775, ], '__integerMin0Max128' => [ 'type' => 'integer', 'min' => 0, 'max' => 128, ], '__integerMin0Max15' => [ 'type' => 'integer', 'min' => 0, 'max' => 15, ], '__integerMin0Max255' => [ 'type' => 'integer', 'min' => 0, 'max' => 255, ], '__integerMin0Max30' => [ 'type' => 'integer', 'min' => 0, 'max' => 30, ], '__integerMin0Max3600' => [ 'type' => 'integer', 'min' => 0, 'max' => 3600, ], '__integerMin0Max4294967295' => [ 'type' => 'long', 'min' => 0, 'max' => 4294967295, ], '__integerMin0Max500' => [ 'type' => 'integer', 'min' => 0, 'max' => 500, ], '__integerMin0Max600' => [ 'type' => 'integer', 'min' => 0, 'max' => 600, ], '__integerMin0Max65535' => [ 'type' => 'integer', 'min' => 0, 'max' => 65535, ], '__integerMin0Max65536' => [ 'type' => 'integer', 'min' => 0, 'max' => 65536, ], '__integerMin0Max7' => [ 'type' => 'integer', 'min' => 0, 'max' => 7, ], '__integerMin0Max8191' => [ 'type' => 'integer', 'min' => 0, 'max' => 8191, ], '__integerMin0Max8589934591' => [ 'type' => 'long', 'min' => 0, 'max' => 8589934591, ], '__integerMin1' => [ 'type' => 'integer', 'min' => 1, ], '__integerMin1000' => [ 'type' => 'integer', 'min' => 1000, ], '__integerMin1000Max30000' => [ 'type' => 'integer', 'min' => 1000, 'max' => 30000, ], '__integerMin1Max10' => [ 'type' => 'integer', 'min' => 1, 'max' => 10, ], '__integerMin1Max1000000' => [ 'type' => 'integer', 'min' => 1, 'max' => 1000000, ], '__integerMin1Max16' => [ 'type' => 'integer', 'min' => 1, 'max' => 16, ], '__integerMin1Max20' => [ 'type' => 'integer', 'min' => 1, 'max' => 20, ], '__integerMin1Max31' => [ 'type' => 'integer', 'min' => 1, 'max' => 31, ], '__integerMin1Max32' => [ 'type' => 'integer', 'min' => 1, 'max' => 32, ], '__integerMin1Max3600' => [ 'type' => 'integer', 'min' => 1, 'max' => 3600, ], '__integerMin1Max4' => [ 'type' => 'integer', 'min' => 1, 'max' => 4, ], '__integerMin1Max5' => [ 'type' => 'integer', 'min' => 1, 'max' => 5, ], '__integerMin1Max6' => [ 'type' => 'integer', 'min' => 1, 'max' => 6, ], '__integerMin1Max8' => [ 'type' => 'integer', 'min' => 1, 'max' => 8, ], '__integerMin25Max10000' => [ 'type' => 'integer', 'min' => 25, 'max' => 10000, ], '__integerMin25Max2000' => [ 'type' => 'integer', 'min' => 25, 'max' => 2000, ], '__integerMin3' => [ 'type' => 'integer', 'min' => 3, ], '__integerMin30' => [ 'type' => 'integer', 'min' => 30, ], '__integerMin4Max20' => [ 'type' => 'integer', 'min' => 4, 'max' => 20, ], '__integerMin96Max600' => [ 'type' => 'integer', 'min' => 96, 'max' => 600, ], '__integerMinNegative1000Max1000' => [ 'type' => 'integer', 'min' => -1000, 'max' => 1000, ], '__integerMinNegative60Max6' => [ 'type' => 'integer', 'min' => -60, 'max' => 6, ], '__integerMinNegative60Max60' => [ 'type' => 'integer', 'min' => -60, 'max' => 60, ], '__listOfAudioChannelMapping' => [ 'type' => 'list', 'member' => [ 'shape' => 'AudioChannelMapping', ], ], '__listOfAudioDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'AudioDescription', ], ], '__listOfAudioSelector' => [ 'type' => 'list', 'member' => [ 'shape' => 'AudioSelector', ], ], '__listOfCaptionDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptionDescription', ], ], '__listOfCaptionLanguageMapping' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptionLanguageMapping', ], ], '__listOfCaptionSelector' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptionSelector', ], ], '__listOfChannelEgressEndpoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelEgressEndpoint', ], ], '__listOfChannelSummary' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSummary', ], ], '__listOfHlsAdMarkers' => [ 'type' => 'list', 'member' => [ 'shape' => 'HlsAdMarkers', ], ], '__listOfInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'Input', ], ], '__listOfInputAttachment' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputAttachment', ], ], '__listOfInputChannelLevel' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputChannelLevel', ], ], '__listOfInputDestination' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputDestination', ], ], '__listOfInputDestinationRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputDestinationRequest', ], ], '__listOfInputSecurityGroup' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputSecurityGroup', ], ], '__listOfInputSource' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputSource', ], ], '__listOfInputSourceRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputSourceRequest', ], ], '__listOfInputWhitelistRule' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputWhitelistRule', ], ], '__listOfInputWhitelistRuleCidr' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputWhitelistRuleCidr', ], ], '__listOfMediaConnectFlow' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaConnectFlow', ], ], '__listOfMediaConnectFlowRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaConnectFlowRequest', ], ], '__listOfOffering' => [ 'type' => 'list', 'member' => [ 'shape' => 'Offering', ], ], '__listOfOutput' => [ 'type' => 'list', 'member' => [ 'shape' => 'Output', ], ], '__listOfOutputDestination' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputDestination', ], ], '__listOfOutputDestinationSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputDestinationSettings', ], ], '__listOfOutputGroup' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputGroup', ], ], '__listOfPipelinePauseStateSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelinePauseStateSettings', ], ], '__listOfReservation' => [ 'type' => 'list', 'member' => [ 'shape' => 'Reservation', ], ], '__listOfScheduleAction' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScheduleAction', ], ], '__listOfScte35Descriptor' => [ 'type' => 'list', 'member' => [ 'shape' => 'Scte35Descriptor', ], ], '__listOfValidationError' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationError', ], ], '__listOfVideoDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'VideoDescription', ], ], '__listOf__string' => [ 'type' => 'list', 'member' => [ 'shape' => '__string', ], ], '__long' => [ 'type' => 'long', ], '__string' => [ 'type' => 'string', ], '__stringMax32' => [ 'type' => 'string', 'max' => 32, ], '__stringMin1' => [ 'type' => 'string', 'min' => 1, ], '__stringMin1Max255' => [ 'type' => 'string', 'min' => 1, 'max' => 255, ], '__stringMin1Max256' => [ 'type' => 'string', 'min' => 1, 'max' => 256, ], '__stringMin32Max32' => [ 'type' => 'string', 'min' => 32, 'max' => 32, ], '__stringMin34Max34' => [ 'type' => 'string', 'min' => 34, 'max' => 34, ], '__stringMin3Max3' => [ 'type' => 'string', 'min' => 3, 'max' => 3, ], '__stringMin6Max6' => [ 'type' => 'string', 'min' => 6, 'max' => 6, ], '__timestampIso8601' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], '__timestampUnix' => [ 'type' => 'timestamp', 'timestampFormat' => 'unixTimestamp', ], ],]; +return [ 'metadata' => [ 'apiVersion' => '2017-10-14', 'endpointPrefix' => 'medialive', 'signingName' => 'medialive', 'serviceFullName' => 'AWS Elemental MediaLive', 'serviceId' => 'MediaLive', 'protocol' => 'rest-json', 'jsonVersion' => '1.1', 'uid' => 'medialive-2017-10-14', 'signatureVersion' => 'v4', 'serviceAbbreviation' => 'MediaLive', ], 'operations' => [ 'BatchUpdateSchedule' => [ 'name' => 'BatchUpdateSchedule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/channels/{channelId}/schedule', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchUpdateScheduleRequest', ], 'output' => [ 'shape' => 'BatchUpdateScheduleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'CreateChannel' => [ 'name' => 'CreateChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/channels', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateChannelRequest', ], 'output' => [ 'shape' => 'CreateChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateInput' => [ 'name' => 'CreateInput', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/inputs', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateInputRequest', ], 'output' => [ 'shape' => 'CreateInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'CreateInputSecurityGroup' => [ 'name' => 'CreateInputSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/inputSecurityGroups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'CreateInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'CreateTags' => [ 'name' => 'CreateTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/tags/{resource-arn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'CreateTagsRequest', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'DeleteChannel' => [ 'name' => 'DeleteChannel', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/channels/{channelId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteChannelRequest', ], 'output' => [ 'shape' => 'DeleteChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteInput' => [ 'name' => 'DeleteInput', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/inputs/{inputId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteInputRequest', ], 'output' => [ 'shape' => 'DeleteInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteInputSecurityGroup' => [ 'name' => 'DeleteInputSecurityGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/inputSecurityGroups/{inputSecurityGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'DeleteInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DeleteReservation' => [ 'name' => 'DeleteReservation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/reservations/{reservationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteReservationRequest', ], 'output' => [ 'shape' => 'DeleteReservationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prod/tags/{resource-arn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteTagsRequest', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'DescribeChannel' => [ 'name' => 'DescribeChannel', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/channels/{channelId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeChannelRequest', ], 'output' => [ 'shape' => 'DescribeChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeInput' => [ 'name' => 'DescribeInput', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputs/{inputId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeInputRequest', ], 'output' => [ 'shape' => 'DescribeInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeInputSecurityGroup' => [ 'name' => 'DescribeInputSecurityGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputSecurityGroups/{inputSecurityGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'DescribeInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeOffering' => [ 'name' => 'DescribeOffering', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/offerings/{offeringId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeOfferingRequest', ], 'output' => [ 'shape' => 'DescribeOfferingResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeReservation' => [ 'name' => 'DescribeReservation', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/reservations/{reservationId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeReservationRequest', ], 'output' => [ 'shape' => 'DescribeReservationResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeSchedule' => [ 'name' => 'DescribeSchedule', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/channels/{channelId}/schedule', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DescribeScheduleRequest', ], 'output' => [ 'shape' => 'DescribeScheduleResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListChannels' => [ 'name' => 'ListChannels', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/channels', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListChannelsRequest', ], 'output' => [ 'shape' => 'ListChannelsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListInputSecurityGroups' => [ 'name' => 'ListInputSecurityGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputSecurityGroups', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListInputSecurityGroupsRequest', ], 'output' => [ 'shape' => 'ListInputSecurityGroupsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListInputs' => [ 'name' => 'ListInputs', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/inputs', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListInputsRequest', ], 'output' => [ 'shape' => 'ListInputsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListOfferings' => [ 'name' => 'ListOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/offerings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListOfferingsRequest', ], 'output' => [ 'shape' => 'ListOfferingsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListReservations' => [ 'name' => 'ListReservations', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/reservations', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListReservationsRequest', ], 'output' => [ 'shape' => 'ListReservationsResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/prod/tags/{resource-arn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'NotFoundException', ], [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], ], ], 'PurchaseOffering' => [ 'name' => 'PurchaseOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/offerings/{offeringId}/purchase', 'responseCode' => 201, ], 'input' => [ 'shape' => 'PurchaseOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseOfferingResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'StartChannel' => [ 'name' => 'StartChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/channels/{channelId}/start', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StartChannelRequest', ], 'output' => [ 'shape' => 'StartChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'StopChannel' => [ 'name' => 'StopChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/prod/channels/{channelId}/stop', 'responseCode' => 200, ], 'input' => [ 'shape' => 'StopChannelRequest', ], 'output' => [ 'shape' => 'StopChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateChannel' => [ 'name' => 'UpdateChannel', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/channels/{channelId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateChannelRequest', ], 'output' => [ 'shape' => 'UpdateChannelResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'UnprocessableEntityException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateInput' => [ 'name' => 'UpdateInput', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/inputs/{inputId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateInputRequest', ], 'output' => [ 'shape' => 'UpdateInputResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateInputSecurityGroup' => [ 'name' => 'UpdateInputSecurityGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prod/inputSecurityGroups/{inputSecurityGroupId}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateInputSecurityGroupRequest', ], 'output' => [ 'shape' => 'UpdateInputSecurityGroupResponse', ], 'errors' => [ [ 'shape' => 'BadRequestException', ], [ 'shape' => 'InternalServerErrorException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'BadGatewayException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'GatewayTimeoutException', ], [ 'shape' => 'ConflictException', ], ], ], ], 'shapes' => [ 'AacCodingMode' => [ 'type' => 'string', 'enum' => [ 'AD_RECEIVER_MIX', 'CODING_MODE_1_0', 'CODING_MODE_1_1', 'CODING_MODE_2_0', 'CODING_MODE_5_1', ], ], 'AacInputType' => [ 'type' => 'string', 'enum' => [ 'BROADCASTER_MIXED_AD', 'NORMAL', ], ], 'AacProfile' => [ 'type' => 'string', 'enum' => [ 'HEV1', 'HEV2', 'LC', ], ], 'AacRateControlMode' => [ 'type' => 'string', 'enum' => [ 'CBR', 'VBR', ], ], 'AacRawFormat' => [ 'type' => 'string', 'enum' => [ 'LATM_LOAS', 'NONE', ], ], 'AacSettings' => [ 'type' => 'structure', 'members' => [ 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'CodingMode' => [ 'shape' => 'AacCodingMode', 'locationName' => 'codingMode', ], 'InputType' => [ 'shape' => 'AacInputType', 'locationName' => 'inputType', ], 'Profile' => [ 'shape' => 'AacProfile', 'locationName' => 'profile', ], 'RateControlMode' => [ 'shape' => 'AacRateControlMode', 'locationName' => 'rateControlMode', ], 'RawFormat' => [ 'shape' => 'AacRawFormat', 'locationName' => 'rawFormat', ], 'SampleRate' => [ 'shape' => '__double', 'locationName' => 'sampleRate', ], 'Spec' => [ 'shape' => 'AacSpec', 'locationName' => 'spec', ], 'VbrQuality' => [ 'shape' => 'AacVbrQuality', 'locationName' => 'vbrQuality', ], ], ], 'AacSpec' => [ 'type' => 'string', 'enum' => [ 'MPEG2', 'MPEG4', ], ], 'AacVbrQuality' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'LOW', 'MEDIUM_HIGH', 'MEDIUM_LOW', ], ], 'Ac3BitstreamMode' => [ 'type' => 'string', 'enum' => [ 'COMMENTARY', 'COMPLETE_MAIN', 'DIALOGUE', 'EMERGENCY', 'HEARING_IMPAIRED', 'MUSIC_AND_EFFECTS', 'VISUALLY_IMPAIRED', 'VOICE_OVER', ], ], 'Ac3CodingMode' => [ 'type' => 'string', 'enum' => [ 'CODING_MODE_1_0', 'CODING_MODE_1_1', 'CODING_MODE_2_0', 'CODING_MODE_3_2_LFE', ], ], 'Ac3DrcProfile' => [ 'type' => 'string', 'enum' => [ 'FILM_STANDARD', 'NONE', ], ], 'Ac3LfeFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'Ac3MetadataControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'Ac3Settings' => [ 'type' => 'structure', 'members' => [ 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'BitstreamMode' => [ 'shape' => 'Ac3BitstreamMode', 'locationName' => 'bitstreamMode', ], 'CodingMode' => [ 'shape' => 'Ac3CodingMode', 'locationName' => 'codingMode', ], 'Dialnorm' => [ 'shape' => '__integerMin1Max31', 'locationName' => 'dialnorm', ], 'DrcProfile' => [ 'shape' => 'Ac3DrcProfile', 'locationName' => 'drcProfile', ], 'LfeFilter' => [ 'shape' => 'Ac3LfeFilter', 'locationName' => 'lfeFilter', ], 'MetadataControl' => [ 'shape' => 'Ac3MetadataControl', 'locationName' => 'metadataControl', ], ], ], 'AccessDenied' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'AfdSignaling' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'FIXED', 'NONE', ], ], 'ArchiveContainerSettings' => [ 'type' => 'structure', 'members' => [ 'M2tsSettings' => [ 'shape' => 'M2tsSettings', 'locationName' => 'm2tsSettings', ], ], ], 'ArchiveGroupSettings' => [ 'type' => 'structure', 'members' => [ 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'RolloverInterval' => [ 'shape' => '__integerMin1', 'locationName' => 'rolloverInterval', ], ], 'required' => [ 'Destination', ], ], 'ArchiveOutputSettings' => [ 'type' => 'structure', 'members' => [ 'ContainerSettings' => [ 'shape' => 'ArchiveContainerSettings', 'locationName' => 'containerSettings', ], 'Extension' => [ 'shape' => '__string', 'locationName' => 'extension', ], 'NameModifier' => [ 'shape' => '__string', 'locationName' => 'nameModifier', ], ], 'required' => [ 'ContainerSettings', ], ], 'AribDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'AribSourceSettings' => [ 'type' => 'structure', 'members' => [], ], 'AudioChannelMapping' => [ 'type' => 'structure', 'members' => [ 'InputChannelLevels' => [ 'shape' => '__listOfInputChannelLevel', 'locationName' => 'inputChannelLevels', ], 'OutputChannel' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'outputChannel', ], ], 'required' => [ 'OutputChannel', 'InputChannelLevels', ], ], 'AudioCodecSettings' => [ 'type' => 'structure', 'members' => [ 'AacSettings' => [ 'shape' => 'AacSettings', 'locationName' => 'aacSettings', ], 'Ac3Settings' => [ 'shape' => 'Ac3Settings', 'locationName' => 'ac3Settings', ], 'Eac3Settings' => [ 'shape' => 'Eac3Settings', 'locationName' => 'eac3Settings', ], 'Mp2Settings' => [ 'shape' => 'Mp2Settings', 'locationName' => 'mp2Settings', ], 'PassThroughSettings' => [ 'shape' => 'PassThroughSettings', 'locationName' => 'passThroughSettings', ], ], ], 'AudioDescription' => [ 'type' => 'structure', 'members' => [ 'AudioNormalizationSettings' => [ 'shape' => 'AudioNormalizationSettings', 'locationName' => 'audioNormalizationSettings', ], 'AudioSelectorName' => [ 'shape' => '__string', 'locationName' => 'audioSelectorName', ], 'AudioType' => [ 'shape' => 'AudioType', 'locationName' => 'audioType', ], 'AudioTypeControl' => [ 'shape' => 'AudioDescriptionAudioTypeControl', 'locationName' => 'audioTypeControl', ], 'CodecSettings' => [ 'shape' => 'AudioCodecSettings', 'locationName' => 'codecSettings', ], 'LanguageCode' => [ 'shape' => '__stringMin3Max3', 'locationName' => 'languageCode', ], 'LanguageCodeControl' => [ 'shape' => 'AudioDescriptionLanguageCodeControl', 'locationName' => 'languageCodeControl', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RemixSettings' => [ 'shape' => 'RemixSettings', 'locationName' => 'remixSettings', ], 'StreamName' => [ 'shape' => '__string', 'locationName' => 'streamName', ], ], 'required' => [ 'AudioSelectorName', 'Name', ], ], 'AudioDescriptionAudioTypeControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'AudioDescriptionLanguageCodeControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'AudioLanguageSelection' => [ 'type' => 'structure', 'members' => [ 'LanguageCode' => [ 'shape' => '__string', 'locationName' => 'languageCode', ], 'LanguageSelectionPolicy' => [ 'shape' => 'AudioLanguageSelectionPolicy', 'locationName' => 'languageSelectionPolicy', ], ], 'required' => [ 'LanguageCode', ], ], 'AudioLanguageSelectionPolicy' => [ 'type' => 'string', 'enum' => [ 'LOOSE', 'STRICT', ], ], 'AudioNormalizationAlgorithm' => [ 'type' => 'string', 'enum' => [ 'ITU_1770_1', 'ITU_1770_2', ], ], 'AudioNormalizationAlgorithmControl' => [ 'type' => 'string', 'enum' => [ 'CORRECT_AUDIO', ], ], 'AudioNormalizationSettings' => [ 'type' => 'structure', 'members' => [ 'Algorithm' => [ 'shape' => 'AudioNormalizationAlgorithm', 'locationName' => 'algorithm', ], 'AlgorithmControl' => [ 'shape' => 'AudioNormalizationAlgorithmControl', 'locationName' => 'algorithmControl', ], 'TargetLkfs' => [ 'shape' => '__doubleMinNegative59Max0', 'locationName' => 'targetLkfs', ], ], ], 'AudioOnlyHlsSettings' => [ 'type' => 'structure', 'members' => [ 'AudioGroupId' => [ 'shape' => '__string', 'locationName' => 'audioGroupId', ], 'AudioOnlyImage' => [ 'shape' => 'InputLocation', 'locationName' => 'audioOnlyImage', ], 'AudioTrackType' => [ 'shape' => 'AudioOnlyHlsTrackType', 'locationName' => 'audioTrackType', ], ], ], 'AudioOnlyHlsTrackType' => [ 'type' => 'string', 'enum' => [ 'ALTERNATE_AUDIO_AUTO_SELECT', 'ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT', 'ALTERNATE_AUDIO_NOT_AUTO_SELECT', 'AUDIO_ONLY_VARIANT_STREAM', ], ], 'AudioPidSelection' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin0Max8191', 'locationName' => 'pid', ], ], 'required' => [ 'Pid', ], ], 'AudioSelector' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__stringMin1', 'locationName' => 'name', ], 'SelectorSettings' => [ 'shape' => 'AudioSelectorSettings', 'locationName' => 'selectorSettings', ], ], 'required' => [ 'Name', ], ], 'AudioSelectorSettings' => [ 'type' => 'structure', 'members' => [ 'AudioLanguageSelection' => [ 'shape' => 'AudioLanguageSelection', 'locationName' => 'audioLanguageSelection', ], 'AudioPidSelection' => [ 'shape' => 'AudioPidSelection', 'locationName' => 'audioPidSelection', ], ], ], 'AudioType' => [ 'type' => 'string', 'enum' => [ 'CLEAN_EFFECTS', 'HEARING_IMPAIRED', 'UNDEFINED', 'VISUAL_IMPAIRED_COMMENTARY', ], ], 'AuthenticationScheme' => [ 'type' => 'string', 'enum' => [ 'AKAMAI', 'COMMON', ], ], 'AvailBlanking' => [ 'type' => 'structure', 'members' => [ 'AvailBlankingImage' => [ 'shape' => 'InputLocation', 'locationName' => 'availBlankingImage', ], 'State' => [ 'shape' => 'AvailBlankingState', 'locationName' => 'state', ], ], ], 'AvailBlankingState' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'AvailConfiguration' => [ 'type' => 'structure', 'members' => [ 'AvailSettings' => [ 'shape' => 'AvailSettings', 'locationName' => 'availSettings', ], ], ], 'AvailSettings' => [ 'type' => 'structure', 'members' => [ 'Scte35SpliceInsert' => [ 'shape' => 'Scte35SpliceInsert', 'locationName' => 'scte35SpliceInsert', ], 'Scte35TimeSignalApos' => [ 'shape' => 'Scte35TimeSignalApos', 'locationName' => 'scte35TimeSignalApos', ], ], ], 'BadGatewayException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 502, ], ], 'BadRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 400, ], ], 'BatchScheduleActionCreateRequest' => [ 'type' => 'structure', 'members' => [ 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'BatchScheduleActionCreateResult' => [ 'type' => 'structure', 'members' => [ 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'BatchScheduleActionDeleteRequest' => [ 'type' => 'structure', 'members' => [ 'ActionNames' => [ 'shape' => '__listOf__string', 'locationName' => 'actionNames', ], ], 'required' => [ 'ActionNames', ], ], 'BatchScheduleActionDeleteResult' => [ 'type' => 'structure', 'members' => [ 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'BatchUpdateScheduleRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], 'Creates' => [ 'shape' => 'BatchScheduleActionCreateRequest', 'locationName' => 'creates', ], 'Deletes' => [ 'shape' => 'BatchScheduleActionDeleteRequest', 'locationName' => 'deletes', ], ], 'required' => [ 'ChannelId', ], ], 'BatchUpdateScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'Creates' => [ 'shape' => 'BatchScheduleActionCreateResult', 'locationName' => 'creates', ], 'Deletes' => [ 'shape' => 'BatchScheduleActionDeleteResult', 'locationName' => 'deletes', ], ], ], 'BatchUpdateScheduleResult' => [ 'type' => 'structure', 'members' => [ 'Creates' => [ 'shape' => 'BatchScheduleActionCreateResult', 'locationName' => 'creates', ], 'Deletes' => [ 'shape' => 'BatchScheduleActionDeleteResult', 'locationName' => 'deletes', ], ], ], 'BlackoutSlate' => [ 'type' => 'structure', 'members' => [ 'BlackoutSlateImage' => [ 'shape' => 'InputLocation', 'locationName' => 'blackoutSlateImage', ], 'NetworkEndBlackout' => [ 'shape' => 'BlackoutSlateNetworkEndBlackout', 'locationName' => 'networkEndBlackout', ], 'NetworkEndBlackoutImage' => [ 'shape' => 'InputLocation', 'locationName' => 'networkEndBlackoutImage', ], 'NetworkId' => [ 'shape' => '__stringMin34Max34', 'locationName' => 'networkId', ], 'State' => [ 'shape' => 'BlackoutSlateState', 'locationName' => 'state', ], ], ], 'BlackoutSlateNetworkEndBlackout' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'BlackoutSlateState' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'BurnInAlignment' => [ 'type' => 'string', 'enum' => [ 'CENTERED', 'LEFT', 'SMART', ], ], 'BurnInBackgroundColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'BurnInDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'Alignment' => [ 'shape' => 'BurnInAlignment', 'locationName' => 'alignment', ], 'BackgroundColor' => [ 'shape' => 'BurnInBackgroundColor', 'locationName' => 'backgroundColor', ], 'BackgroundOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'backgroundOpacity', ], 'Font' => [ 'shape' => 'InputLocation', 'locationName' => 'font', ], 'FontColor' => [ 'shape' => 'BurnInFontColor', 'locationName' => 'fontColor', ], 'FontOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'fontOpacity', ], 'FontResolution' => [ 'shape' => '__integerMin96Max600', 'locationName' => 'fontResolution', ], 'FontSize' => [ 'shape' => '__string', 'locationName' => 'fontSize', ], 'OutlineColor' => [ 'shape' => 'BurnInOutlineColor', 'locationName' => 'outlineColor', ], 'OutlineSize' => [ 'shape' => '__integerMin0Max10', 'locationName' => 'outlineSize', ], 'ShadowColor' => [ 'shape' => 'BurnInShadowColor', 'locationName' => 'shadowColor', ], 'ShadowOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'shadowOpacity', ], 'ShadowXOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowXOffset', ], 'ShadowYOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowYOffset', ], 'TeletextGridControl' => [ 'shape' => 'BurnInTeletextGridControl', 'locationName' => 'teletextGridControl', ], 'XPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'xPosition', ], 'YPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'yPosition', ], ], ], 'BurnInFontColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'BurnInOutlineColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'BurnInShadowColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'BurnInTeletextGridControl' => [ 'type' => 'string', 'enum' => [ 'FIXED', 'SCALED', ], ], 'CaptionDescription' => [ 'type' => 'structure', 'members' => [ 'CaptionSelectorName' => [ 'shape' => '__string', 'locationName' => 'captionSelectorName', ], 'DestinationSettings' => [ 'shape' => 'CaptionDestinationSettings', 'locationName' => 'destinationSettings', ], 'LanguageCode' => [ 'shape' => '__string', 'locationName' => 'languageCode', ], 'LanguageDescription' => [ 'shape' => '__string', 'locationName' => 'languageDescription', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], ], 'required' => [ 'CaptionSelectorName', 'Name', ], ], 'CaptionDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'AribDestinationSettings' => [ 'shape' => 'AribDestinationSettings', 'locationName' => 'aribDestinationSettings', ], 'BurnInDestinationSettings' => [ 'shape' => 'BurnInDestinationSettings', 'locationName' => 'burnInDestinationSettings', ], 'DvbSubDestinationSettings' => [ 'shape' => 'DvbSubDestinationSettings', 'locationName' => 'dvbSubDestinationSettings', ], 'EmbeddedDestinationSettings' => [ 'shape' => 'EmbeddedDestinationSettings', 'locationName' => 'embeddedDestinationSettings', ], 'EmbeddedPlusScte20DestinationSettings' => [ 'shape' => 'EmbeddedPlusScte20DestinationSettings', 'locationName' => 'embeddedPlusScte20DestinationSettings', ], 'RtmpCaptionInfoDestinationSettings' => [ 'shape' => 'RtmpCaptionInfoDestinationSettings', 'locationName' => 'rtmpCaptionInfoDestinationSettings', ], 'Scte20PlusEmbeddedDestinationSettings' => [ 'shape' => 'Scte20PlusEmbeddedDestinationSettings', 'locationName' => 'scte20PlusEmbeddedDestinationSettings', ], 'Scte27DestinationSettings' => [ 'shape' => 'Scte27DestinationSettings', 'locationName' => 'scte27DestinationSettings', ], 'SmpteTtDestinationSettings' => [ 'shape' => 'SmpteTtDestinationSettings', 'locationName' => 'smpteTtDestinationSettings', ], 'TeletextDestinationSettings' => [ 'shape' => 'TeletextDestinationSettings', 'locationName' => 'teletextDestinationSettings', ], 'TtmlDestinationSettings' => [ 'shape' => 'TtmlDestinationSettings', 'locationName' => 'ttmlDestinationSettings', ], 'WebvttDestinationSettings' => [ 'shape' => 'WebvttDestinationSettings', 'locationName' => 'webvttDestinationSettings', ], ], ], 'CaptionLanguageMapping' => [ 'type' => 'structure', 'members' => [ 'CaptionChannel' => [ 'shape' => '__integerMin1Max4', 'locationName' => 'captionChannel', ], 'LanguageCode' => [ 'shape' => '__stringMin3Max3', 'locationName' => 'languageCode', ], 'LanguageDescription' => [ 'shape' => '__stringMin1', 'locationName' => 'languageDescription', ], ], 'required' => [ 'LanguageCode', 'LanguageDescription', 'CaptionChannel', ], ], 'CaptionSelector' => [ 'type' => 'structure', 'members' => [ 'LanguageCode' => [ 'shape' => '__string', 'locationName' => 'languageCode', ], 'Name' => [ 'shape' => '__stringMin1', 'locationName' => 'name', ], 'SelectorSettings' => [ 'shape' => 'CaptionSelectorSettings', 'locationName' => 'selectorSettings', ], ], 'required' => [ 'Name', ], ], 'CaptionSelectorSettings' => [ 'type' => 'structure', 'members' => [ 'AribSourceSettings' => [ 'shape' => 'AribSourceSettings', 'locationName' => 'aribSourceSettings', ], 'DvbSubSourceSettings' => [ 'shape' => 'DvbSubSourceSettings', 'locationName' => 'dvbSubSourceSettings', ], 'EmbeddedSourceSettings' => [ 'shape' => 'EmbeddedSourceSettings', 'locationName' => 'embeddedSourceSettings', ], 'Scte20SourceSettings' => [ 'shape' => 'Scte20SourceSettings', 'locationName' => 'scte20SourceSettings', ], 'Scte27SourceSettings' => [ 'shape' => 'Scte27SourceSettings', 'locationName' => 'scte27SourceSettings', ], 'TeletextSourceSettings' => [ 'shape' => 'TeletextSourceSettings', 'locationName' => 'teletextSourceSettings', ], ], ], 'Channel' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'ChannelConfigurationValidationError' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], 'ValidationErrors' => [ 'shape' => '__listOfValidationError', 'locationName' => 'validationErrors', ], ], ], 'ChannelEgressEndpoint' => [ 'type' => 'structure', 'members' => [ 'SourceIp' => [ 'shape' => '__string', 'locationName' => 'sourceIp', ], ], ], 'ChannelState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATE_FAILED', 'IDLE', 'STARTING', 'RUNNING', 'RECOVERING', 'STOPPING', 'DELETING', 'DELETED', ], ], 'ChannelSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 409, ], ], 'CreateChannel' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Reserved' => [ 'shape' => '__string', 'locationName' => 'reserved', 'deprecated' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'CreateChannelRequest' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Reserved' => [ 'shape' => '__string', 'locationName' => 'reserved', 'deprecated' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'CreateChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'CreateChannelResultModel' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'CreateInput' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], 'Vpc' => [ 'shape' => 'InputVpcRequest', 'locationName' => 'vpc', ], ], ], 'CreateInputRequest' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], 'Vpc' => [ 'shape' => 'InputVpcRequest', 'locationName' => 'vpc', ], ], ], 'CreateInputResponse' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'CreateInputResultModel' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'CreateInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRuleCidr', 'locationName' => 'whitelistRules', ], ], ], 'CreateInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'CreateInputSecurityGroupResultModel' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'CreateTagsRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'resource-arn', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], 'required' => [ 'ResourceArn', ], ], 'DeleteChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'DeleteChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'DeleteInputRequest' => [ 'type' => 'structure', 'members' => [ 'InputId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputId', ], ], 'required' => [ 'InputId', ], ], 'DeleteInputResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputSecurityGroupId', ], ], 'required' => [ 'InputSecurityGroupId', ], ], 'DeleteInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteReservationRequest' => [ 'type' => 'structure', 'members' => [ 'ReservationId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'reservationId', ], ], 'required' => [ 'ReservationId', ], ], 'DeleteReservationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Count' => [ 'shape' => '__integer', 'locationName' => 'count', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'End' => [ 'shape' => '__string', 'locationName' => 'end', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ReservationId' => [ 'shape' => '__string', 'locationName' => 'reservationId', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], 'State' => [ 'shape' => 'ReservationState', 'locationName' => 'state', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'DeleteTagsRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'resource-arn', ], 'TagKeys' => [ 'shape' => '__listOf__string', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], 'required' => [ 'TagKeys', 'ResourceArn', ], ], 'DescribeChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'DescribeChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'DescribeInputRequest' => [ 'type' => 'structure', 'members' => [ 'InputId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputId', ], ], 'required' => [ 'InputId', ], ], 'DescribeInputResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'AttachedChannels' => [ 'shape' => '__listOf__string', 'locationName' => 'attachedChannels', ], 'Destinations' => [ 'shape' => '__listOfInputDestination', 'locationName' => 'destinations', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlow', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'SecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'securityGroups', ], 'Sources' => [ 'shape' => '__listOfInputSource', 'locationName' => 'sources', ], 'State' => [ 'shape' => 'InputState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], ], ], 'DescribeInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputSecurityGroupId', ], ], 'required' => [ 'InputSecurityGroupId', ], ], 'DescribeInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'Inputs' => [ 'shape' => '__listOf__string', 'locationName' => 'inputs', ], 'State' => [ 'shape' => 'InputSecurityGroupState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRule', 'locationName' => 'whitelistRules', ], ], ], 'DescribeOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'OfferingId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'offeringId', ], ], 'required' => [ 'OfferingId', ], ], 'DescribeOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'DescribeReservationRequest' => [ 'type' => 'structure', 'members' => [ 'ReservationId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'reservationId', ], ], 'required' => [ 'ReservationId', ], ], 'DescribeReservationResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Count' => [ 'shape' => '__integer', 'locationName' => 'count', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'End' => [ 'shape' => '__string', 'locationName' => 'end', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ReservationId' => [ 'shape' => '__string', 'locationName' => 'reservationId', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], 'State' => [ 'shape' => 'ReservationState', 'locationName' => 'state', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'DescribeScheduleRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], 'required' => [ 'ChannelId', ], ], 'DescribeScheduleResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], ], 'DvbNitSettings' => [ 'type' => 'structure', 'members' => [ 'NetworkId' => [ 'shape' => '__integerMin0Max65536', 'locationName' => 'networkId', ], 'NetworkName' => [ 'shape' => '__stringMin1Max256', 'locationName' => 'networkName', ], 'RepInterval' => [ 'shape' => '__integerMin25Max10000', 'locationName' => 'repInterval', ], ], 'required' => [ 'NetworkName', 'NetworkId', ], ], 'DvbSdtOutputSdt' => [ 'type' => 'string', 'enum' => [ 'SDT_FOLLOW', 'SDT_FOLLOW_IF_PRESENT', 'SDT_MANUAL', 'SDT_NONE', ], ], 'DvbSdtSettings' => [ 'type' => 'structure', 'members' => [ 'OutputSdt' => [ 'shape' => 'DvbSdtOutputSdt', 'locationName' => 'outputSdt', ], 'RepInterval' => [ 'shape' => '__integerMin25Max2000', 'locationName' => 'repInterval', ], 'ServiceName' => [ 'shape' => '__stringMin1Max256', 'locationName' => 'serviceName', ], 'ServiceProviderName' => [ 'shape' => '__stringMin1Max256', 'locationName' => 'serviceProviderName', ], ], ], 'DvbSubDestinationAlignment' => [ 'type' => 'string', 'enum' => [ 'CENTERED', 'LEFT', 'SMART', ], ], 'DvbSubDestinationBackgroundColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'DvbSubDestinationFontColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'DvbSubDestinationOutlineColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'BLUE', 'GREEN', 'RED', 'WHITE', 'YELLOW', ], ], 'DvbSubDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'Alignment' => [ 'shape' => 'DvbSubDestinationAlignment', 'locationName' => 'alignment', ], 'BackgroundColor' => [ 'shape' => 'DvbSubDestinationBackgroundColor', 'locationName' => 'backgroundColor', ], 'BackgroundOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'backgroundOpacity', ], 'Font' => [ 'shape' => 'InputLocation', 'locationName' => 'font', ], 'FontColor' => [ 'shape' => 'DvbSubDestinationFontColor', 'locationName' => 'fontColor', ], 'FontOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'fontOpacity', ], 'FontResolution' => [ 'shape' => '__integerMin96Max600', 'locationName' => 'fontResolution', ], 'FontSize' => [ 'shape' => '__string', 'locationName' => 'fontSize', ], 'OutlineColor' => [ 'shape' => 'DvbSubDestinationOutlineColor', 'locationName' => 'outlineColor', ], 'OutlineSize' => [ 'shape' => '__integerMin0Max10', 'locationName' => 'outlineSize', ], 'ShadowColor' => [ 'shape' => 'DvbSubDestinationShadowColor', 'locationName' => 'shadowColor', ], 'ShadowOpacity' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'shadowOpacity', ], 'ShadowXOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowXOffset', ], 'ShadowYOffset' => [ 'shape' => '__integer', 'locationName' => 'shadowYOffset', ], 'TeletextGridControl' => [ 'shape' => 'DvbSubDestinationTeletextGridControl', 'locationName' => 'teletextGridControl', ], 'XPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'xPosition', ], 'YPosition' => [ 'shape' => '__integerMin0', 'locationName' => 'yPosition', ], ], ], 'DvbSubDestinationShadowColor' => [ 'type' => 'string', 'enum' => [ 'BLACK', 'NONE', 'WHITE', ], ], 'DvbSubDestinationTeletextGridControl' => [ 'type' => 'string', 'enum' => [ 'FIXED', 'SCALED', ], ], 'DvbSubSourceSettings' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin1', 'locationName' => 'pid', ], ], ], 'DvbTdtSettings' => [ 'type' => 'structure', 'members' => [ 'RepInterval' => [ 'shape' => '__integerMin1000Max30000', 'locationName' => 'repInterval', ], ], ], 'Eac3AttenuationControl' => [ 'type' => 'string', 'enum' => [ 'ATTENUATE_3_DB', 'NONE', ], ], 'Eac3BitstreamMode' => [ 'type' => 'string', 'enum' => [ 'COMMENTARY', 'COMPLETE_MAIN', 'EMERGENCY', 'HEARING_IMPAIRED', 'VISUALLY_IMPAIRED', ], ], 'Eac3CodingMode' => [ 'type' => 'string', 'enum' => [ 'CODING_MODE_1_0', 'CODING_MODE_2_0', 'CODING_MODE_3_2', ], ], 'Eac3DcFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'Eac3DrcLine' => [ 'type' => 'string', 'enum' => [ 'FILM_LIGHT', 'FILM_STANDARD', 'MUSIC_LIGHT', 'MUSIC_STANDARD', 'NONE', 'SPEECH', ], ], 'Eac3DrcRf' => [ 'type' => 'string', 'enum' => [ 'FILM_LIGHT', 'FILM_STANDARD', 'MUSIC_LIGHT', 'MUSIC_STANDARD', 'NONE', 'SPEECH', ], ], 'Eac3LfeControl' => [ 'type' => 'string', 'enum' => [ 'LFE', 'NO_LFE', ], ], 'Eac3LfeFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'Eac3MetadataControl' => [ 'type' => 'string', 'enum' => [ 'FOLLOW_INPUT', 'USE_CONFIGURED', ], ], 'Eac3PassthroughControl' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'WHEN_POSSIBLE', ], ], 'Eac3PhaseControl' => [ 'type' => 'string', 'enum' => [ 'NO_SHIFT', 'SHIFT_90_DEGREES', ], ], 'Eac3Settings' => [ 'type' => 'structure', 'members' => [ 'AttenuationControl' => [ 'shape' => 'Eac3AttenuationControl', 'locationName' => 'attenuationControl', ], 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'BitstreamMode' => [ 'shape' => 'Eac3BitstreamMode', 'locationName' => 'bitstreamMode', ], 'CodingMode' => [ 'shape' => 'Eac3CodingMode', 'locationName' => 'codingMode', ], 'DcFilter' => [ 'shape' => 'Eac3DcFilter', 'locationName' => 'dcFilter', ], 'Dialnorm' => [ 'shape' => '__integerMin1Max31', 'locationName' => 'dialnorm', ], 'DrcLine' => [ 'shape' => 'Eac3DrcLine', 'locationName' => 'drcLine', ], 'DrcRf' => [ 'shape' => 'Eac3DrcRf', 'locationName' => 'drcRf', ], 'LfeControl' => [ 'shape' => 'Eac3LfeControl', 'locationName' => 'lfeControl', ], 'LfeFilter' => [ 'shape' => 'Eac3LfeFilter', 'locationName' => 'lfeFilter', ], 'LoRoCenterMixLevel' => [ 'shape' => '__double', 'locationName' => 'loRoCenterMixLevel', ], 'LoRoSurroundMixLevel' => [ 'shape' => '__double', 'locationName' => 'loRoSurroundMixLevel', ], 'LtRtCenterMixLevel' => [ 'shape' => '__double', 'locationName' => 'ltRtCenterMixLevel', ], 'LtRtSurroundMixLevel' => [ 'shape' => '__double', 'locationName' => 'ltRtSurroundMixLevel', ], 'MetadataControl' => [ 'shape' => 'Eac3MetadataControl', 'locationName' => 'metadataControl', ], 'PassthroughControl' => [ 'shape' => 'Eac3PassthroughControl', 'locationName' => 'passthroughControl', ], 'PhaseControl' => [ 'shape' => 'Eac3PhaseControl', 'locationName' => 'phaseControl', ], 'StereoDownmix' => [ 'shape' => 'Eac3StereoDownmix', 'locationName' => 'stereoDownmix', ], 'SurroundExMode' => [ 'shape' => 'Eac3SurroundExMode', 'locationName' => 'surroundExMode', ], 'SurroundMode' => [ 'shape' => 'Eac3SurroundMode', 'locationName' => 'surroundMode', ], ], ], 'Eac3StereoDownmix' => [ 'type' => 'string', 'enum' => [ 'DPL2', 'LO_RO', 'LT_RT', 'NOT_INDICATED', ], ], 'Eac3SurroundExMode' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', 'NOT_INDICATED', ], ], 'Eac3SurroundMode' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', 'NOT_INDICATED', ], ], 'EmbeddedConvert608To708' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'UPCONVERT', ], ], 'EmbeddedDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'EmbeddedPlusScte20DestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'EmbeddedScte20Detection' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'OFF', ], ], 'EmbeddedSourceSettings' => [ 'type' => 'structure', 'members' => [ 'Convert608To708' => [ 'shape' => 'EmbeddedConvert608To708', 'locationName' => 'convert608To708', ], 'Scte20Detection' => [ 'shape' => 'EmbeddedScte20Detection', 'locationName' => 'scte20Detection', ], 'Source608ChannelNumber' => [ 'shape' => '__integerMin1Max4', 'locationName' => 'source608ChannelNumber', ], 'Source608TrackNumber' => [ 'shape' => '__integerMin1Max5', 'locationName' => 'source608TrackNumber', ], ], ], 'Empty' => [ 'type' => 'structure', 'members' => [], ], 'EncoderSettings' => [ 'type' => 'structure', 'members' => [ 'AudioDescriptions' => [ 'shape' => '__listOfAudioDescription', 'locationName' => 'audioDescriptions', ], 'AvailBlanking' => [ 'shape' => 'AvailBlanking', 'locationName' => 'availBlanking', ], 'AvailConfiguration' => [ 'shape' => 'AvailConfiguration', 'locationName' => 'availConfiguration', ], 'BlackoutSlate' => [ 'shape' => 'BlackoutSlate', 'locationName' => 'blackoutSlate', ], 'CaptionDescriptions' => [ 'shape' => '__listOfCaptionDescription', 'locationName' => 'captionDescriptions', ], 'GlobalConfiguration' => [ 'shape' => 'GlobalConfiguration', 'locationName' => 'globalConfiguration', ], 'OutputGroups' => [ 'shape' => '__listOfOutputGroup', 'locationName' => 'outputGroups', ], 'TimecodeConfig' => [ 'shape' => 'TimecodeConfig', 'locationName' => 'timecodeConfig', ], 'VideoDescriptions' => [ 'shape' => '__listOfVideoDescription', 'locationName' => 'videoDescriptions', ], ], 'required' => [ 'VideoDescriptions', 'AudioDescriptions', 'OutputGroups', 'TimecodeConfig', ], ], 'FecOutputIncludeFec' => [ 'type' => 'string', 'enum' => [ 'COLUMN', 'COLUMN_AND_ROW', ], ], 'FecOutputSettings' => [ 'type' => 'structure', 'members' => [ 'ColumnDepth' => [ 'shape' => '__integerMin4Max20', 'locationName' => 'columnDepth', ], 'IncludeFec' => [ 'shape' => 'FecOutputIncludeFec', 'locationName' => 'includeFec', ], 'RowLength' => [ 'shape' => '__integerMin1Max20', 'locationName' => 'rowLength', ], ], ], 'FixedAfd' => [ 'type' => 'string', 'enum' => [ 'AFD_0000', 'AFD_0010', 'AFD_0011', 'AFD_0100', 'AFD_1000', 'AFD_1001', 'AFD_1010', 'AFD_1011', 'AFD_1101', 'AFD_1110', 'AFD_1111', ], ], 'FixedModeScheduleActionStartSettings' => [ 'type' => 'structure', 'members' => [ 'Time' => [ 'shape' => '__string', 'locationName' => 'time', ], ], 'required' => [ 'Time', ], ], 'FollowModeScheduleActionStartSettings' => [ 'type' => 'structure', 'members' => [ 'FollowPoint' => [ 'shape' => 'FollowPoint', 'locationName' => 'followPoint', ], 'ReferenceActionName' => [ 'shape' => '__string', 'locationName' => 'referenceActionName', ], ], 'required' => [ 'ReferenceActionName', 'FollowPoint', ], ], 'FollowPoint' => [ 'type' => 'string', 'enum' => [ 'END', 'START', ], ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 403, ], ], 'FrameCaptureGroupSettings' => [ 'type' => 'structure', 'members' => [ 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], ], 'required' => [ 'Destination', ], ], 'FrameCaptureOutputSettings' => [ 'type' => 'structure', 'members' => [ 'NameModifier' => [ 'shape' => '__string', 'locationName' => 'nameModifier', ], ], ], 'FrameCaptureSettings' => [ 'type' => 'structure', 'members' => [ 'CaptureInterval' => [ 'shape' => '__integerMin1Max3600', 'locationName' => 'captureInterval', ], ], 'required' => [ 'CaptureInterval', ], ], 'GatewayTimeoutException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 504, ], ], 'GlobalConfiguration' => [ 'type' => 'structure', 'members' => [ 'InitialAudioGain' => [ 'shape' => '__integerMinNegative60Max60', 'locationName' => 'initialAudioGain', ], 'InputEndAction' => [ 'shape' => 'GlobalConfigurationInputEndAction', 'locationName' => 'inputEndAction', ], 'InputLossBehavior' => [ 'shape' => 'InputLossBehavior', 'locationName' => 'inputLossBehavior', ], 'OutputTimingSource' => [ 'shape' => 'GlobalConfigurationOutputTimingSource', 'locationName' => 'outputTimingSource', ], 'SupportLowFramerateInputs' => [ 'shape' => 'GlobalConfigurationLowFramerateInputs', 'locationName' => 'supportLowFramerateInputs', ], ], ], 'GlobalConfigurationInputEndAction' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SWITCH_AND_LOOP_INPUTS', ], ], 'GlobalConfigurationLowFramerateInputs' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'GlobalConfigurationOutputTimingSource' => [ 'type' => 'string', 'enum' => [ 'INPUT_CLOCK', 'SYSTEM_CLOCK', ], ], 'H264AdaptiveQuantization' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'HIGHER', 'LOW', 'MAX', 'MEDIUM', 'OFF', ], ], 'H264ColorMetadata' => [ 'type' => 'string', 'enum' => [ 'IGNORE', 'INSERT', ], ], 'H264EntropyEncoding' => [ 'type' => 'string', 'enum' => [ 'CABAC', 'CAVLC', ], ], 'H264FlickerAq' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264FramerateControl' => [ 'type' => 'string', 'enum' => [ 'INITIALIZE_FROM_SOURCE', 'SPECIFIED', ], ], 'H264GopBReference' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264GopSizeUnits' => [ 'type' => 'string', 'enum' => [ 'FRAMES', 'SECONDS', ], ], 'H264Level' => [ 'type' => 'string', 'enum' => [ 'H264_LEVEL_1', 'H264_LEVEL_1_1', 'H264_LEVEL_1_2', 'H264_LEVEL_1_3', 'H264_LEVEL_2', 'H264_LEVEL_2_1', 'H264_LEVEL_2_2', 'H264_LEVEL_3', 'H264_LEVEL_3_1', 'H264_LEVEL_3_2', 'H264_LEVEL_4', 'H264_LEVEL_4_1', 'H264_LEVEL_4_2', 'H264_LEVEL_5', 'H264_LEVEL_5_1', 'H264_LEVEL_5_2', 'H264_LEVEL_AUTO', ], ], 'H264LookAheadRateControl' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'LOW', 'MEDIUM', ], ], 'H264ParControl' => [ 'type' => 'string', 'enum' => [ 'INITIALIZE_FROM_SOURCE', 'SPECIFIED', ], ], 'H264Profile' => [ 'type' => 'string', 'enum' => [ 'BASELINE', 'HIGH', 'HIGH_10BIT', 'HIGH_422', 'HIGH_422_10BIT', 'MAIN', ], ], 'H264RateControlMode' => [ 'type' => 'string', 'enum' => [ 'CBR', 'QVBR', 'VBR', ], ], 'H264ScanType' => [ 'type' => 'string', 'enum' => [ 'INTERLACED', 'PROGRESSIVE', ], ], 'H264SceneChangeDetect' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264Settings' => [ 'type' => 'structure', 'members' => [ 'AdaptiveQuantization' => [ 'shape' => 'H264AdaptiveQuantization', 'locationName' => 'adaptiveQuantization', ], 'AfdSignaling' => [ 'shape' => 'AfdSignaling', 'locationName' => 'afdSignaling', ], 'Bitrate' => [ 'shape' => '__integerMin1000', 'locationName' => 'bitrate', ], 'BufFillPct' => [ 'shape' => '__integerMin0Max100', 'locationName' => 'bufFillPct', ], 'BufSize' => [ 'shape' => '__integerMin0', 'locationName' => 'bufSize', ], 'ColorMetadata' => [ 'shape' => 'H264ColorMetadata', 'locationName' => 'colorMetadata', ], 'EntropyEncoding' => [ 'shape' => 'H264EntropyEncoding', 'locationName' => 'entropyEncoding', ], 'FixedAfd' => [ 'shape' => 'FixedAfd', 'locationName' => 'fixedAfd', ], 'FlickerAq' => [ 'shape' => 'H264FlickerAq', 'locationName' => 'flickerAq', ], 'FramerateControl' => [ 'shape' => 'H264FramerateControl', 'locationName' => 'framerateControl', ], 'FramerateDenominator' => [ 'shape' => '__integerMin1', 'locationName' => 'framerateDenominator', ], 'FramerateNumerator' => [ 'shape' => '__integerMin1', 'locationName' => 'framerateNumerator', ], 'GopBReference' => [ 'shape' => 'H264GopBReference', 'locationName' => 'gopBReference', ], 'GopClosedCadence' => [ 'shape' => '__integerMin0', 'locationName' => 'gopClosedCadence', ], 'GopNumBFrames' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'gopNumBFrames', ], 'GopSize' => [ 'shape' => '__doubleMin1', 'locationName' => 'gopSize', ], 'GopSizeUnits' => [ 'shape' => 'H264GopSizeUnits', 'locationName' => 'gopSizeUnits', ], 'Level' => [ 'shape' => 'H264Level', 'locationName' => 'level', ], 'LookAheadRateControl' => [ 'shape' => 'H264LookAheadRateControl', 'locationName' => 'lookAheadRateControl', ], 'MaxBitrate' => [ 'shape' => '__integerMin1000', 'locationName' => 'maxBitrate', ], 'MinIInterval' => [ 'shape' => '__integerMin0Max30', 'locationName' => 'minIInterval', ], 'NumRefFrames' => [ 'shape' => '__integerMin1Max6', 'locationName' => 'numRefFrames', ], 'ParControl' => [ 'shape' => 'H264ParControl', 'locationName' => 'parControl', ], 'ParDenominator' => [ 'shape' => '__integerMin1', 'locationName' => 'parDenominator', ], 'ParNumerator' => [ 'shape' => '__integer', 'locationName' => 'parNumerator', ], 'Profile' => [ 'shape' => 'H264Profile', 'locationName' => 'profile', ], 'QvbrQualityLevel' => [ 'shape' => '__integerMin1Max10', 'locationName' => 'qvbrQualityLevel', ], 'RateControlMode' => [ 'shape' => 'H264RateControlMode', 'locationName' => 'rateControlMode', ], 'ScanType' => [ 'shape' => 'H264ScanType', 'locationName' => 'scanType', ], 'SceneChangeDetect' => [ 'shape' => 'H264SceneChangeDetect', 'locationName' => 'sceneChangeDetect', ], 'Slices' => [ 'shape' => '__integerMin1Max32', 'locationName' => 'slices', ], 'Softness' => [ 'shape' => '__integerMin0Max128', 'locationName' => 'softness', ], 'SpatialAq' => [ 'shape' => 'H264SpatialAq', 'locationName' => 'spatialAq', ], 'SubgopLength' => [ 'shape' => 'H264SubGopLength', 'locationName' => 'subgopLength', ], 'Syntax' => [ 'shape' => 'H264Syntax', 'locationName' => 'syntax', ], 'TemporalAq' => [ 'shape' => 'H264TemporalAq', 'locationName' => 'temporalAq', ], 'TimecodeInsertion' => [ 'shape' => 'H264TimecodeInsertionBehavior', 'locationName' => 'timecodeInsertion', ], ], ], 'H264SpatialAq' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264SubGopLength' => [ 'type' => 'string', 'enum' => [ 'DYNAMIC', 'FIXED', ], ], 'H264Syntax' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'RP2027', ], ], 'H264TemporalAq' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'H264TimecodeInsertionBehavior' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'PIC_TIMING_SEI', ], ], 'HlsAdMarkers' => [ 'type' => 'string', 'enum' => [ 'ADOBE', 'ELEMENTAL', 'ELEMENTAL_SCTE35', ], ], 'HlsAkamaiHttpTransferMode' => [ 'type' => 'string', 'enum' => [ 'CHUNKED', 'NON_CHUNKED', ], ], 'HlsAkamaiSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'HttpTransferMode' => [ 'shape' => 'HlsAkamaiHttpTransferMode', 'locationName' => 'httpTransferMode', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], 'Salt' => [ 'shape' => '__string', 'locationName' => 'salt', ], 'Token' => [ 'shape' => '__string', 'locationName' => 'token', ], ], ], 'HlsBasicPutSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], ], ], 'HlsCaptionLanguageSetting' => [ 'type' => 'string', 'enum' => [ 'INSERT', 'NONE', 'OMIT', ], ], 'HlsCdnSettings' => [ 'type' => 'structure', 'members' => [ 'HlsAkamaiSettings' => [ 'shape' => 'HlsAkamaiSettings', 'locationName' => 'hlsAkamaiSettings', ], 'HlsBasicPutSettings' => [ 'shape' => 'HlsBasicPutSettings', 'locationName' => 'hlsBasicPutSettings', ], 'HlsMediaStoreSettings' => [ 'shape' => 'HlsMediaStoreSettings', 'locationName' => 'hlsMediaStoreSettings', ], 'HlsWebdavSettings' => [ 'shape' => 'HlsWebdavSettings', 'locationName' => 'hlsWebdavSettings', ], ], ], 'HlsClientCache' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'HlsCodecSpecification' => [ 'type' => 'string', 'enum' => [ 'RFC_4281', 'RFC_6381', ], ], 'HlsDirectoryStructure' => [ 'type' => 'string', 'enum' => [ 'SINGLE_DIRECTORY', 'SUBDIRECTORY_PER_STREAM', ], ], 'HlsEncryptionType' => [ 'type' => 'string', 'enum' => [ 'AES128', 'SAMPLE_AES', ], ], 'HlsGroupSettings' => [ 'type' => 'structure', 'members' => [ 'AdMarkers' => [ 'shape' => '__listOfHlsAdMarkers', 'locationName' => 'adMarkers', ], 'BaseUrlContent' => [ 'shape' => '__string', 'locationName' => 'baseUrlContent', ], 'BaseUrlManifest' => [ 'shape' => '__string', 'locationName' => 'baseUrlManifest', ], 'CaptionLanguageMappings' => [ 'shape' => '__listOfCaptionLanguageMapping', 'locationName' => 'captionLanguageMappings', ], 'CaptionLanguageSetting' => [ 'shape' => 'HlsCaptionLanguageSetting', 'locationName' => 'captionLanguageSetting', ], 'ClientCache' => [ 'shape' => 'HlsClientCache', 'locationName' => 'clientCache', ], 'CodecSpecification' => [ 'shape' => 'HlsCodecSpecification', 'locationName' => 'codecSpecification', ], 'ConstantIv' => [ 'shape' => '__stringMin32Max32', 'locationName' => 'constantIv', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'DirectoryStructure' => [ 'shape' => 'HlsDirectoryStructure', 'locationName' => 'directoryStructure', ], 'EncryptionType' => [ 'shape' => 'HlsEncryptionType', 'locationName' => 'encryptionType', ], 'HlsCdnSettings' => [ 'shape' => 'HlsCdnSettings', 'locationName' => 'hlsCdnSettings', ], 'IFrameOnlyPlaylists' => [ 'shape' => 'IFrameOnlyPlaylistType', 'locationName' => 'iFrameOnlyPlaylists', ], 'IndexNSegments' => [ 'shape' => '__integerMin3', 'locationName' => 'indexNSegments', ], 'InputLossAction' => [ 'shape' => 'InputLossActionForHlsOut', 'locationName' => 'inputLossAction', ], 'IvInManifest' => [ 'shape' => 'HlsIvInManifest', 'locationName' => 'ivInManifest', ], 'IvSource' => [ 'shape' => 'HlsIvSource', 'locationName' => 'ivSource', ], 'KeepSegments' => [ 'shape' => '__integerMin1', 'locationName' => 'keepSegments', ], 'KeyFormat' => [ 'shape' => '__string', 'locationName' => 'keyFormat', ], 'KeyFormatVersions' => [ 'shape' => '__string', 'locationName' => 'keyFormatVersions', ], 'KeyProviderSettings' => [ 'shape' => 'KeyProviderSettings', 'locationName' => 'keyProviderSettings', ], 'ManifestCompression' => [ 'shape' => 'HlsManifestCompression', 'locationName' => 'manifestCompression', ], 'ManifestDurationFormat' => [ 'shape' => 'HlsManifestDurationFormat', 'locationName' => 'manifestDurationFormat', ], 'MinSegmentLength' => [ 'shape' => '__integerMin0', 'locationName' => 'minSegmentLength', ], 'Mode' => [ 'shape' => 'HlsMode', 'locationName' => 'mode', ], 'OutputSelection' => [ 'shape' => 'HlsOutputSelection', 'locationName' => 'outputSelection', ], 'ProgramDateTime' => [ 'shape' => 'HlsProgramDateTime', 'locationName' => 'programDateTime', ], 'ProgramDateTimePeriod' => [ 'shape' => '__integerMin0Max3600', 'locationName' => 'programDateTimePeriod', ], 'RedundantManifest' => [ 'shape' => 'HlsRedundantManifest', 'locationName' => 'redundantManifest', ], 'SegmentLength' => [ 'shape' => '__integerMin1', 'locationName' => 'segmentLength', ], 'SegmentationMode' => [ 'shape' => 'HlsSegmentationMode', 'locationName' => 'segmentationMode', ], 'SegmentsPerSubdirectory' => [ 'shape' => '__integerMin1', 'locationName' => 'segmentsPerSubdirectory', ], 'StreamInfResolution' => [ 'shape' => 'HlsStreamInfResolution', 'locationName' => 'streamInfResolution', ], 'TimedMetadataId3Frame' => [ 'shape' => 'HlsTimedMetadataId3Frame', 'locationName' => 'timedMetadataId3Frame', ], 'TimedMetadataId3Period' => [ 'shape' => '__integerMin0', 'locationName' => 'timedMetadataId3Period', ], 'TimestampDeltaMilliseconds' => [ 'shape' => '__integerMin0', 'locationName' => 'timestampDeltaMilliseconds', ], 'TsFileMode' => [ 'shape' => 'HlsTsFileMode', 'locationName' => 'tsFileMode', ], ], 'required' => [ 'Destination', ], ], 'HlsInputSettings' => [ 'type' => 'structure', 'members' => [ 'Bandwidth' => [ 'shape' => '__integerMin0', 'locationName' => 'bandwidth', ], 'BufferSegments' => [ 'shape' => '__integerMin0', 'locationName' => 'bufferSegments', ], 'Retries' => [ 'shape' => '__integerMin0', 'locationName' => 'retries', ], 'RetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'retryInterval', ], ], ], 'HlsIvInManifest' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'HlsIvSource' => [ 'type' => 'string', 'enum' => [ 'EXPLICIT', 'FOLLOWS_SEGMENT_NUMBER', ], ], 'HlsManifestCompression' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'HlsManifestDurationFormat' => [ 'type' => 'string', 'enum' => [ 'FLOATING_POINT', 'INTEGER', ], ], 'HlsMediaStoreSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'MediaStoreStorageClass' => [ 'shape' => 'HlsMediaStoreStorageClass', 'locationName' => 'mediaStoreStorageClass', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], ], ], 'HlsMediaStoreStorageClass' => [ 'type' => 'string', 'enum' => [ 'TEMPORAL', ], ], 'HlsMode' => [ 'type' => 'string', 'enum' => [ 'LIVE', 'VOD', ], ], 'HlsOutputSelection' => [ 'type' => 'string', 'enum' => [ 'MANIFESTS_AND_SEGMENTS', 'SEGMENTS_ONLY', ], ], 'HlsOutputSettings' => [ 'type' => 'structure', 'members' => [ 'HlsSettings' => [ 'shape' => 'HlsSettings', 'locationName' => 'hlsSettings', ], 'NameModifier' => [ 'shape' => '__stringMin1', 'locationName' => 'nameModifier', ], 'SegmentModifier' => [ 'shape' => '__string', 'locationName' => 'segmentModifier', ], ], 'required' => [ 'HlsSettings', ], ], 'HlsProgramDateTime' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'HlsRedundantManifest' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'HlsSegmentationMode' => [ 'type' => 'string', 'enum' => [ 'USE_INPUT_SEGMENTATION', 'USE_SEGMENT_DURATION', ], ], 'HlsSettings' => [ 'type' => 'structure', 'members' => [ 'AudioOnlyHlsSettings' => [ 'shape' => 'AudioOnlyHlsSettings', 'locationName' => 'audioOnlyHlsSettings', ], 'StandardHlsSettings' => [ 'shape' => 'StandardHlsSettings', 'locationName' => 'standardHlsSettings', ], ], ], 'HlsStreamInfResolution' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'HlsTimedMetadataId3Frame' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PRIV', 'TDRL', ], ], 'HlsTimedMetadataScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Id3' => [ 'shape' => '__string', 'locationName' => 'id3', ], ], 'required' => [ 'Id3', ], ], 'HlsTsFileMode' => [ 'type' => 'string', 'enum' => [ 'SEGMENTED_FILES', 'SINGLE_FILE', ], ], 'HlsWebdavHttpTransferMode' => [ 'type' => 'string', 'enum' => [ 'CHUNKED', 'NON_CHUNKED', ], ], 'HlsWebdavSettings' => [ 'type' => 'structure', 'members' => [ 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0Max600', 'locationName' => 'filecacheDuration', ], 'HttpTransferMode' => [ 'shape' => 'HlsWebdavHttpTransferMode', 'locationName' => 'httpTransferMode', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'restartDelay', ], ], ], 'IFrameOnlyPlaylistType' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'STANDARD', ], ], 'Input' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'AttachedChannels' => [ 'shape' => '__listOf__string', 'locationName' => 'attachedChannels', ], 'Destinations' => [ 'shape' => '__listOfInputDestination', 'locationName' => 'destinations', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlow', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'SecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'securityGroups', ], 'Sources' => [ 'shape' => '__listOfInputSource', 'locationName' => 'sources', ], 'State' => [ 'shape' => 'InputState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'Type' => [ 'shape' => 'InputType', 'locationName' => 'type', ], ], ], 'InputAttachment' => [ 'type' => 'structure', 'members' => [ 'InputAttachmentName' => [ 'shape' => '__string', 'locationName' => 'inputAttachmentName', ], 'InputId' => [ 'shape' => '__string', 'locationName' => 'inputId', ], 'InputSettings' => [ 'shape' => 'InputSettings', 'locationName' => 'inputSettings', ], ], ], 'InputChannelLevel' => [ 'type' => 'structure', 'members' => [ 'Gain' => [ 'shape' => '__integerMinNegative60Max6', 'locationName' => 'gain', ], 'InputChannel' => [ 'shape' => '__integerMin0Max15', 'locationName' => 'inputChannel', ], ], 'required' => [ 'InputChannel', 'Gain', ], ], 'InputCodec' => [ 'type' => 'string', 'enum' => [ 'MPEG2', 'AVC', 'HEVC', ], ], 'InputDeblockFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'InputDenoiseFilter' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'InputDestination' => [ 'type' => 'structure', 'members' => [ 'Ip' => [ 'shape' => '__string', 'locationName' => 'ip', ], 'Port' => [ 'shape' => '__string', 'locationName' => 'port', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Vpc' => [ 'shape' => 'InputDestinationVpc', 'locationName' => 'vpc', ], ], ], 'InputDestinationRequest' => [ 'type' => 'structure', 'members' => [ 'StreamName' => [ 'shape' => '__string', 'locationName' => 'streamName', ], ], ], 'InputDestinationVpc' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZone' => [ 'shape' => '__string', 'locationName' => 'availabilityZone', ], 'NetworkInterfaceId' => [ 'shape' => '__string', 'locationName' => 'networkInterfaceId', ], ], ], 'InputFilter' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'DISABLED', 'FORCED', ], ], 'InputLocation' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'Uri' => [ 'shape' => '__string', 'locationName' => 'uri', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], 'required' => [ 'Uri', ], ], 'InputLossActionForHlsOut' => [ 'type' => 'string', 'enum' => [ 'EMIT_OUTPUT', 'PAUSE_OUTPUT', ], ], 'InputLossActionForMsSmoothOut' => [ 'type' => 'string', 'enum' => [ 'EMIT_OUTPUT', 'PAUSE_OUTPUT', ], ], 'InputLossActionForRtmpOut' => [ 'type' => 'string', 'enum' => [ 'EMIT_OUTPUT', 'PAUSE_OUTPUT', ], ], 'InputLossActionForUdpOut' => [ 'type' => 'string', 'enum' => [ 'DROP_PROGRAM', 'DROP_TS', 'EMIT_PROGRAM', ], ], 'InputLossBehavior' => [ 'type' => 'structure', 'members' => [ 'BlackFrameMsec' => [ 'shape' => '__integerMin0Max1000000', 'locationName' => 'blackFrameMsec', ], 'InputLossImageColor' => [ 'shape' => '__stringMin6Max6', 'locationName' => 'inputLossImageColor', ], 'InputLossImageSlate' => [ 'shape' => 'InputLocation', 'locationName' => 'inputLossImageSlate', ], 'InputLossImageType' => [ 'shape' => 'InputLossImageType', 'locationName' => 'inputLossImageType', ], 'RepeatFrameMsec' => [ 'shape' => '__integerMin0Max1000000', 'locationName' => 'repeatFrameMsec', ], ], ], 'InputLossImageType' => [ 'type' => 'string', 'enum' => [ 'COLOR', 'SLATE', ], ], 'InputMaximumBitrate' => [ 'type' => 'string', 'enum' => [ 'MAX_10_MBPS', 'MAX_20_MBPS', 'MAX_50_MBPS', ], ], 'InputResolution' => [ 'type' => 'string', 'enum' => [ 'SD', 'HD', 'UHD', ], ], 'InputSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'Inputs' => [ 'shape' => '__listOf__string', 'locationName' => 'inputs', ], 'State' => [ 'shape' => 'InputSecurityGroupState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRule', 'locationName' => 'whitelistRules', ], ], ], 'InputSecurityGroupState' => [ 'type' => 'string', 'enum' => [ 'IDLE', 'IN_USE', 'UPDATING', 'DELETED', ], ], 'InputSecurityGroupWhitelistRequest' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRuleCidr', 'locationName' => 'whitelistRules', ], ], ], 'InputSettings' => [ 'type' => 'structure', 'members' => [ 'AudioSelectors' => [ 'shape' => '__listOfAudioSelector', 'locationName' => 'audioSelectors', ], 'CaptionSelectors' => [ 'shape' => '__listOfCaptionSelector', 'locationName' => 'captionSelectors', ], 'DeblockFilter' => [ 'shape' => 'InputDeblockFilter', 'locationName' => 'deblockFilter', ], 'DenoiseFilter' => [ 'shape' => 'InputDenoiseFilter', 'locationName' => 'denoiseFilter', ], 'FilterStrength' => [ 'shape' => '__integerMin1Max5', 'locationName' => 'filterStrength', ], 'InputFilter' => [ 'shape' => 'InputFilter', 'locationName' => 'inputFilter', ], 'NetworkInputSettings' => [ 'shape' => 'NetworkInputSettings', 'locationName' => 'networkInputSettings', ], 'SourceEndBehavior' => [ 'shape' => 'InputSourceEndBehavior', 'locationName' => 'sourceEndBehavior', ], 'VideoSelector' => [ 'shape' => 'VideoSelector', 'locationName' => 'videoSelector', ], ], ], 'InputSource' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], ], 'InputSourceEndBehavior' => [ 'type' => 'string', 'enum' => [ 'CONTINUE', 'LOOP', ], ], 'InputSourceRequest' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], ], 'InputSpecification' => [ 'type' => 'structure', 'members' => [ 'Codec' => [ 'shape' => 'InputCodec', 'locationName' => 'codec', ], 'MaximumBitrate' => [ 'shape' => 'InputMaximumBitrate', 'locationName' => 'maximumBitrate', ], 'Resolution' => [ 'shape' => 'InputResolution', 'locationName' => 'resolution', ], ], ], 'InputState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'DETACHED', 'ATTACHED', 'DELETING', 'DELETED', ], ], 'InputSwitchScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'InputAttachmentNameReference' => [ 'shape' => '__string', 'locationName' => 'inputAttachmentNameReference', ], ], 'required' => [ 'InputAttachmentNameReference', ], ], 'InputType' => [ 'type' => 'string', 'enum' => [ 'UDP_PUSH', 'RTP_PUSH', 'RTMP_PUSH', 'RTMP_PULL', 'URL_PULL', 'MP4_FILE', 'MEDIACONNECT', ], ], 'InputVpcRequest' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => '__listOf__string', 'locationName' => 'securityGroupIds', ], 'SubnetIds' => [ 'shape' => '__listOf__string', 'locationName' => 'subnetIds', ], ], 'required' => [ 'SubnetIds', ], ], 'InputWhitelistRule' => [ 'type' => 'structure', 'members' => [ 'Cidr' => [ 'shape' => '__string', 'locationName' => 'cidr', ], ], ], 'InputWhitelistRuleCidr' => [ 'type' => 'structure', 'members' => [ 'Cidr' => [ 'shape' => '__string', 'locationName' => 'cidr', ], ], ], 'InternalServerErrorException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 500, ], ], 'InternalServiceError' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'InvalidRequest' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'KeyProviderSettings' => [ 'type' => 'structure', 'members' => [ 'StaticKeySettings' => [ 'shape' => 'StaticKeySettings', 'locationName' => 'staticKeySettings', ], ], ], 'LimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'ListChannelsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListChannelsResponse' => [ 'type' => 'structure', 'members' => [ 'Channels' => [ 'shape' => '__listOfChannelSummary', 'locationName' => 'channels', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListChannelsResultModel' => [ 'type' => 'structure', 'members' => [ 'Channels' => [ 'shape' => '__listOfChannelSummary', 'locationName' => 'channels', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputSecurityGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListInputSecurityGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroups' => [ 'shape' => '__listOfInputSecurityGroup', 'locationName' => 'inputSecurityGroups', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputSecurityGroupsResultModel' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroups' => [ 'shape' => '__listOfInputSecurityGroup', 'locationName' => 'inputSecurityGroups', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListInputsResponse' => [ 'type' => 'structure', 'members' => [ 'Inputs' => [ 'shape' => '__listOfInput', 'locationName' => 'inputs', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListInputsResultModel' => [ 'type' => 'structure', 'members' => [ 'Inputs' => [ 'shape' => '__listOfInput', 'locationName' => 'inputs', ], 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], ], ], 'ListOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelConfiguration' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'channelConfiguration', ], 'Codec' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'codec', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'MaximumBitrate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumBitrate', ], 'MaximumFramerate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumFramerate', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'Resolution' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resolution', ], 'ResourceType' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'SpecialFeature' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'specialFeature', ], 'VideoQuality' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'videoQuality', ], ], ], 'ListOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Offerings' => [ 'shape' => '__listOfOffering', 'locationName' => 'offerings', ], ], ], 'ListOfferingsResultModel' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Offerings' => [ 'shape' => '__listOfOffering', 'locationName' => 'offerings', ], ], ], 'ListReservationsRequest' => [ 'type' => 'structure', 'members' => [ 'Codec' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'codec', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'MaximumBitrate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumBitrate', ], 'MaximumFramerate' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'maximumFramerate', ], 'NextToken' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'Resolution' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resolution', ], 'ResourceType' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'SpecialFeature' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'specialFeature', ], 'VideoQuality' => [ 'shape' => '__string', 'location' => 'querystring', 'locationName' => 'videoQuality', ], ], ], 'ListReservationsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Reservations' => [ 'shape' => '__listOfReservation', 'locationName' => 'reservations', ], ], ], 'ListReservationsResultModel' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'Reservations' => [ 'shape' => '__listOfReservation', 'locationName' => 'reservations', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'resource-arn', ], ], 'required' => [ 'ResourceArn', ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'DISABLED', ], ], 'M2tsAbsentInputAudioBehavior' => [ 'type' => 'string', 'enum' => [ 'DROP', 'ENCODE_SILENCE', ], ], 'M2tsArib' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'M2tsAribCaptionsPidControl' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'USE_CONFIGURED', ], ], 'M2tsAudioBufferModel' => [ 'type' => 'string', 'enum' => [ 'ATSC', 'DVB', ], ], 'M2tsAudioInterval' => [ 'type' => 'string', 'enum' => [ 'VIDEO_AND_FIXED_INTERVALS', 'VIDEO_INTERVAL', ], ], 'M2tsAudioStreamType' => [ 'type' => 'string', 'enum' => [ 'ATSC', 'DVB', ], ], 'M2tsBufferModel' => [ 'type' => 'string', 'enum' => [ 'MULTIPLEX', 'NONE', ], ], 'M2tsCcDescriptor' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'ENABLED', ], ], 'M2tsEbifControl' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', ], ], 'M2tsEbpPlacement' => [ 'type' => 'string', 'enum' => [ 'VIDEO_AND_AUDIO_PIDS', 'VIDEO_PID', ], ], 'M2tsEsRateInPes' => [ 'type' => 'string', 'enum' => [ 'EXCLUDE', 'INCLUDE', ], ], 'M2tsKlv' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', ], ], 'M2tsPcrControl' => [ 'type' => 'string', 'enum' => [ 'CONFIGURED_PCR_PERIOD', 'PCR_EVERY_PES_PACKET', ], ], 'M2tsRateMode' => [ 'type' => 'string', 'enum' => [ 'CBR', 'VBR', ], ], 'M2tsScte35Control' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', ], ], 'M2tsSegmentationMarkers' => [ 'type' => 'string', 'enum' => [ 'EBP', 'EBP_LEGACY', 'NONE', 'PSI_SEGSTART', 'RAI_ADAPT', 'RAI_SEGSTART', ], ], 'M2tsSegmentationStyle' => [ 'type' => 'string', 'enum' => [ 'MAINTAIN_CADENCE', 'RESET_CADENCE', ], ], 'M2tsSettings' => [ 'type' => 'structure', 'members' => [ 'AbsentInputAudioBehavior' => [ 'shape' => 'M2tsAbsentInputAudioBehavior', 'locationName' => 'absentInputAudioBehavior', ], 'Arib' => [ 'shape' => 'M2tsArib', 'locationName' => 'arib', ], 'AribCaptionsPid' => [ 'shape' => '__string', 'locationName' => 'aribCaptionsPid', ], 'AribCaptionsPidControl' => [ 'shape' => 'M2tsAribCaptionsPidControl', 'locationName' => 'aribCaptionsPidControl', ], 'AudioBufferModel' => [ 'shape' => 'M2tsAudioBufferModel', 'locationName' => 'audioBufferModel', ], 'AudioFramesPerPes' => [ 'shape' => '__integerMin0', 'locationName' => 'audioFramesPerPes', ], 'AudioPids' => [ 'shape' => '__string', 'locationName' => 'audioPids', ], 'AudioStreamType' => [ 'shape' => 'M2tsAudioStreamType', 'locationName' => 'audioStreamType', ], 'Bitrate' => [ 'shape' => '__integerMin0', 'locationName' => 'bitrate', ], 'BufferModel' => [ 'shape' => 'M2tsBufferModel', 'locationName' => 'bufferModel', ], 'CcDescriptor' => [ 'shape' => 'M2tsCcDescriptor', 'locationName' => 'ccDescriptor', ], 'DvbNitSettings' => [ 'shape' => 'DvbNitSettings', 'locationName' => 'dvbNitSettings', ], 'DvbSdtSettings' => [ 'shape' => 'DvbSdtSettings', 'locationName' => 'dvbSdtSettings', ], 'DvbSubPids' => [ 'shape' => '__string', 'locationName' => 'dvbSubPids', ], 'DvbTdtSettings' => [ 'shape' => 'DvbTdtSettings', 'locationName' => 'dvbTdtSettings', ], 'DvbTeletextPid' => [ 'shape' => '__string', 'locationName' => 'dvbTeletextPid', ], 'Ebif' => [ 'shape' => 'M2tsEbifControl', 'locationName' => 'ebif', ], 'EbpAudioInterval' => [ 'shape' => 'M2tsAudioInterval', 'locationName' => 'ebpAudioInterval', ], 'EbpLookaheadMs' => [ 'shape' => '__integerMin0Max10000', 'locationName' => 'ebpLookaheadMs', ], 'EbpPlacement' => [ 'shape' => 'M2tsEbpPlacement', 'locationName' => 'ebpPlacement', ], 'EcmPid' => [ 'shape' => '__string', 'locationName' => 'ecmPid', ], 'EsRateInPes' => [ 'shape' => 'M2tsEsRateInPes', 'locationName' => 'esRateInPes', ], 'EtvPlatformPid' => [ 'shape' => '__string', 'locationName' => 'etvPlatformPid', ], 'EtvSignalPid' => [ 'shape' => '__string', 'locationName' => 'etvSignalPid', ], 'FragmentTime' => [ 'shape' => '__doubleMin0', 'locationName' => 'fragmentTime', ], 'Klv' => [ 'shape' => 'M2tsKlv', 'locationName' => 'klv', ], 'KlvDataPids' => [ 'shape' => '__string', 'locationName' => 'klvDataPids', ], 'NullPacketBitrate' => [ 'shape' => '__doubleMin0', 'locationName' => 'nullPacketBitrate', ], 'PatInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'patInterval', ], 'PcrControl' => [ 'shape' => 'M2tsPcrControl', 'locationName' => 'pcrControl', ], 'PcrPeriod' => [ 'shape' => '__integerMin0Max500', 'locationName' => 'pcrPeriod', ], 'PcrPid' => [ 'shape' => '__string', 'locationName' => 'pcrPid', ], 'PmtInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'pmtInterval', ], 'PmtPid' => [ 'shape' => '__string', 'locationName' => 'pmtPid', ], 'ProgramNum' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'programNum', ], 'RateMode' => [ 'shape' => 'M2tsRateMode', 'locationName' => 'rateMode', ], 'Scte27Pids' => [ 'shape' => '__string', 'locationName' => 'scte27Pids', ], 'Scte35Control' => [ 'shape' => 'M2tsScte35Control', 'locationName' => 'scte35Control', ], 'Scte35Pid' => [ 'shape' => '__string', 'locationName' => 'scte35Pid', ], 'SegmentationMarkers' => [ 'shape' => 'M2tsSegmentationMarkers', 'locationName' => 'segmentationMarkers', ], 'SegmentationStyle' => [ 'shape' => 'M2tsSegmentationStyle', 'locationName' => 'segmentationStyle', ], 'SegmentationTime' => [ 'shape' => '__doubleMin1', 'locationName' => 'segmentationTime', ], 'TimedMetadataBehavior' => [ 'shape' => 'M2tsTimedMetadataBehavior', 'locationName' => 'timedMetadataBehavior', ], 'TimedMetadataPid' => [ 'shape' => '__string', 'locationName' => 'timedMetadataPid', ], 'TransportStreamId' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'transportStreamId', ], 'VideoPid' => [ 'shape' => '__string', 'locationName' => 'videoPid', ], ], ], 'M2tsTimedMetadataBehavior' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'PASSTHROUGH', ], ], 'M3u8PcrControl' => [ 'type' => 'string', 'enum' => [ 'CONFIGURED_PCR_PERIOD', 'PCR_EVERY_PES_PACKET', ], ], 'M3u8Scte35Behavior' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'PASSTHROUGH', ], ], 'M3u8Settings' => [ 'type' => 'structure', 'members' => [ 'AudioFramesPerPes' => [ 'shape' => '__integerMin0', 'locationName' => 'audioFramesPerPes', ], 'AudioPids' => [ 'shape' => '__string', 'locationName' => 'audioPids', ], 'EcmPid' => [ 'shape' => '__string', 'locationName' => 'ecmPid', ], 'PatInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'patInterval', ], 'PcrControl' => [ 'shape' => 'M3u8PcrControl', 'locationName' => 'pcrControl', ], 'PcrPeriod' => [ 'shape' => '__integerMin0Max500', 'locationName' => 'pcrPeriod', ], 'PcrPid' => [ 'shape' => '__string', 'locationName' => 'pcrPid', ], 'PmtInterval' => [ 'shape' => '__integerMin0Max1000', 'locationName' => 'pmtInterval', ], 'PmtPid' => [ 'shape' => '__string', 'locationName' => 'pmtPid', ], 'ProgramNum' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'programNum', ], 'Scte35Behavior' => [ 'shape' => 'M3u8Scte35Behavior', 'locationName' => 'scte35Behavior', ], 'Scte35Pid' => [ 'shape' => '__string', 'locationName' => 'scte35Pid', ], 'TimedMetadataBehavior' => [ 'shape' => 'M3u8TimedMetadataBehavior', 'locationName' => 'timedMetadataBehavior', ], 'TimedMetadataPid' => [ 'shape' => '__string', 'locationName' => 'timedMetadataPid', ], 'TransportStreamId' => [ 'shape' => '__integerMin0Max65535', 'locationName' => 'transportStreamId', ], 'VideoPid' => [ 'shape' => '__string', 'locationName' => 'videoPid', ], ], ], 'M3u8TimedMetadataBehavior' => [ 'type' => 'string', 'enum' => [ 'NO_PASSTHROUGH', 'PASSTHROUGH', ], ], 'MaxResults' => [ 'type' => 'integer', 'min' => 1, 'max' => 1000, ], 'MediaConnectFlow' => [ 'type' => 'structure', 'members' => [ 'FlowArn' => [ 'shape' => '__string', 'locationName' => 'flowArn', ], ], ], 'MediaConnectFlowRequest' => [ 'type' => 'structure', 'members' => [ 'FlowArn' => [ 'shape' => '__string', 'locationName' => 'flowArn', ], ], ], 'MediaPackageGroupSettings' => [ 'type' => 'structure', 'members' => [ 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], ], 'required' => [ 'Destination', ], ], 'MediaPackageOutputDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__stringMin1', 'locationName' => 'channelId', ], ], ], 'MediaPackageOutputSettings' => [ 'type' => 'structure', 'members' => [], ], 'Mp2CodingMode' => [ 'type' => 'string', 'enum' => [ 'CODING_MODE_1_0', 'CODING_MODE_2_0', ], ], 'Mp2Settings' => [ 'type' => 'structure', 'members' => [ 'Bitrate' => [ 'shape' => '__double', 'locationName' => 'bitrate', ], 'CodingMode' => [ 'shape' => 'Mp2CodingMode', 'locationName' => 'codingMode', ], 'SampleRate' => [ 'shape' => '__double', 'locationName' => 'sampleRate', ], ], ], 'MsSmoothGroupSettings' => [ 'type' => 'structure', 'members' => [ 'AcquisitionPointId' => [ 'shape' => '__string', 'locationName' => 'acquisitionPointId', ], 'AudioOnlyTimecodeControl' => [ 'shape' => 'SmoothGroupAudioOnlyTimecodeControl', 'locationName' => 'audioOnlyTimecodeControl', ], 'CertificateMode' => [ 'shape' => 'SmoothGroupCertificateMode', 'locationName' => 'certificateMode', ], 'ConnectionRetryInterval' => [ 'shape' => '__integerMin0', 'locationName' => 'connectionRetryInterval', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'EventId' => [ 'shape' => '__string', 'locationName' => 'eventId', ], 'EventIdMode' => [ 'shape' => 'SmoothGroupEventIdMode', 'locationName' => 'eventIdMode', ], 'EventStopBehavior' => [ 'shape' => 'SmoothGroupEventStopBehavior', 'locationName' => 'eventStopBehavior', ], 'FilecacheDuration' => [ 'shape' => '__integerMin0', 'locationName' => 'filecacheDuration', ], 'FragmentLength' => [ 'shape' => '__integerMin1', 'locationName' => 'fragmentLength', ], 'InputLossAction' => [ 'shape' => 'InputLossActionForMsSmoothOut', 'locationName' => 'inputLossAction', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], 'RestartDelay' => [ 'shape' => '__integerMin0', 'locationName' => 'restartDelay', ], 'SegmentationMode' => [ 'shape' => 'SmoothGroupSegmentationMode', 'locationName' => 'segmentationMode', ], 'SendDelayMs' => [ 'shape' => '__integerMin0Max10000', 'locationName' => 'sendDelayMs', ], 'SparseTrackType' => [ 'shape' => 'SmoothGroupSparseTrackType', 'locationName' => 'sparseTrackType', ], 'StreamManifestBehavior' => [ 'shape' => 'SmoothGroupStreamManifestBehavior', 'locationName' => 'streamManifestBehavior', ], 'TimestampOffset' => [ 'shape' => '__string', 'locationName' => 'timestampOffset', ], 'TimestampOffsetMode' => [ 'shape' => 'SmoothGroupTimestampOffsetMode', 'locationName' => 'timestampOffsetMode', ], ], 'required' => [ 'Destination', ], ], 'MsSmoothOutputSettings' => [ 'type' => 'structure', 'members' => [ 'NameModifier' => [ 'shape' => '__string', 'locationName' => 'nameModifier', ], ], ], 'NetworkInputServerValidation' => [ 'type' => 'string', 'enum' => [ 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME', 'CHECK_CRYPTOGRAPHY_ONLY', ], ], 'NetworkInputSettings' => [ 'type' => 'structure', 'members' => [ 'HlsInputSettings' => [ 'shape' => 'HlsInputSettings', 'locationName' => 'hlsInputSettings', ], 'ServerValidation' => [ 'shape' => 'NetworkInputServerValidation', 'locationName' => 'serverValidation', ], ], ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 404, ], ], 'Offering' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'OfferingDurationUnits' => [ 'type' => 'string', 'enum' => [ 'MONTHS', ], ], 'OfferingType' => [ 'type' => 'string', 'enum' => [ 'NO_UPFRONT', ], ], 'Output' => [ 'type' => 'structure', 'members' => [ 'AudioDescriptionNames' => [ 'shape' => '__listOf__string', 'locationName' => 'audioDescriptionNames', ], 'CaptionDescriptionNames' => [ 'shape' => '__listOf__string', 'locationName' => 'captionDescriptionNames', ], 'OutputName' => [ 'shape' => '__stringMin1Max255', 'locationName' => 'outputName', ], 'OutputSettings' => [ 'shape' => 'OutputSettings', 'locationName' => 'outputSettings', ], 'VideoDescriptionName' => [ 'shape' => '__string', 'locationName' => 'videoDescriptionName', ], ], 'required' => [ 'OutputSettings', ], ], 'OutputDestination' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'MediaPackageSettings' => [ 'shape' => '__listOfMediaPackageOutputDestinationSettings', 'locationName' => 'mediaPackageSettings', ], 'Settings' => [ 'shape' => '__listOfOutputDestinationSettings', 'locationName' => 'settings', ], ], ], 'OutputDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'PasswordParam' => [ 'shape' => '__string', 'locationName' => 'passwordParam', ], 'StreamName' => [ 'shape' => '__string', 'locationName' => 'streamName', ], 'Url' => [ 'shape' => '__string', 'locationName' => 'url', ], 'Username' => [ 'shape' => '__string', 'locationName' => 'username', ], ], ], 'OutputGroup' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => '__stringMax32', 'locationName' => 'name', ], 'OutputGroupSettings' => [ 'shape' => 'OutputGroupSettings', 'locationName' => 'outputGroupSettings', ], 'Outputs' => [ 'shape' => '__listOfOutput', 'locationName' => 'outputs', ], ], 'required' => [ 'Outputs', 'OutputGroupSettings', ], ], 'OutputGroupSettings' => [ 'type' => 'structure', 'members' => [ 'ArchiveGroupSettings' => [ 'shape' => 'ArchiveGroupSettings', 'locationName' => 'archiveGroupSettings', ], 'FrameCaptureGroupSettings' => [ 'shape' => 'FrameCaptureGroupSettings', 'locationName' => 'frameCaptureGroupSettings', ], 'HlsGroupSettings' => [ 'shape' => 'HlsGroupSettings', 'locationName' => 'hlsGroupSettings', ], 'MediaPackageGroupSettings' => [ 'shape' => 'MediaPackageGroupSettings', 'locationName' => 'mediaPackageGroupSettings', ], 'MsSmoothGroupSettings' => [ 'shape' => 'MsSmoothGroupSettings', 'locationName' => 'msSmoothGroupSettings', ], 'RtmpGroupSettings' => [ 'shape' => 'RtmpGroupSettings', 'locationName' => 'rtmpGroupSettings', ], 'UdpGroupSettings' => [ 'shape' => 'UdpGroupSettings', 'locationName' => 'udpGroupSettings', ], ], ], 'OutputLocationRef' => [ 'type' => 'structure', 'members' => [ 'DestinationRefId' => [ 'shape' => '__string', 'locationName' => 'destinationRefId', ], ], ], 'OutputSettings' => [ 'type' => 'structure', 'members' => [ 'ArchiveOutputSettings' => [ 'shape' => 'ArchiveOutputSettings', 'locationName' => 'archiveOutputSettings', ], 'FrameCaptureOutputSettings' => [ 'shape' => 'FrameCaptureOutputSettings', 'locationName' => 'frameCaptureOutputSettings', ], 'HlsOutputSettings' => [ 'shape' => 'HlsOutputSettings', 'locationName' => 'hlsOutputSettings', ], 'MediaPackageOutputSettings' => [ 'shape' => 'MediaPackageOutputSettings', 'locationName' => 'mediaPackageOutputSettings', ], 'MsSmoothOutputSettings' => [ 'shape' => 'MsSmoothOutputSettings', 'locationName' => 'msSmoothOutputSettings', ], 'RtmpOutputSettings' => [ 'shape' => 'RtmpOutputSettings', 'locationName' => 'rtmpOutputSettings', ], 'UdpOutputSettings' => [ 'shape' => 'UdpOutputSettings', 'locationName' => 'udpOutputSettings', ], ], ], 'PassThroughSettings' => [ 'type' => 'structure', 'members' => [], ], 'PauseStateScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Pipelines' => [ 'shape' => '__listOfPipelinePauseStateSettings', 'locationName' => 'pipelines', ], ], ], 'PipelineId' => [ 'type' => 'string', 'enum' => [ 'PIPELINE_0', 'PIPELINE_1', ], ], 'PipelinePauseStateSettings' => [ 'type' => 'structure', 'members' => [ 'PipelineId' => [ 'shape' => 'PipelineId', 'locationName' => 'pipelineId', ], ], 'required' => [ 'PipelineId', ], ], 'PurchaseOffering' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => '__integerMin1', 'locationName' => 'count', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], ], 'required' => [ 'Count', ], ], 'PurchaseOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => '__integerMin1', 'locationName' => 'count', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'offeringId', ], 'RequestId' => [ 'shape' => '__string', 'locationName' => 'requestId', 'idempotencyToken' => true, ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], ], 'required' => [ 'OfferingId', 'Count', ], ], 'PurchaseOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'Reservation' => [ 'shape' => 'Reservation', 'locationName' => 'reservation', ], ], ], 'PurchaseOfferingResultModel' => [ 'type' => 'structure', 'members' => [ 'Reservation' => [ 'shape' => 'Reservation', 'locationName' => 'reservation', ], ], ], 'RemixSettings' => [ 'type' => 'structure', 'members' => [ 'ChannelMappings' => [ 'shape' => '__listOfAudioChannelMapping', 'locationName' => 'channelMappings', ], 'ChannelsIn' => [ 'shape' => '__integerMin1Max16', 'locationName' => 'channelsIn', ], 'ChannelsOut' => [ 'shape' => '__integerMin1Max8', 'locationName' => 'channelsOut', ], ], 'required' => [ 'ChannelMappings', ], ], 'Reservation' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Count' => [ 'shape' => '__integer', 'locationName' => 'count', ], 'CurrencyCode' => [ 'shape' => '__string', 'locationName' => 'currencyCode', ], 'Duration' => [ 'shape' => '__integer', 'locationName' => 'duration', ], 'DurationUnits' => [ 'shape' => 'OfferingDurationUnits', 'locationName' => 'durationUnits', ], 'End' => [ 'shape' => '__string', 'locationName' => 'end', ], 'FixedPrice' => [ 'shape' => '__double', 'locationName' => 'fixedPrice', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'OfferingDescription' => [ 'shape' => '__string', 'locationName' => 'offeringDescription', ], 'OfferingId' => [ 'shape' => '__string', 'locationName' => 'offeringId', ], 'OfferingType' => [ 'shape' => 'OfferingType', 'locationName' => 'offeringType', ], 'Region' => [ 'shape' => '__string', 'locationName' => 'region', ], 'ReservationId' => [ 'shape' => '__string', 'locationName' => 'reservationId', ], 'ResourceSpecification' => [ 'shape' => 'ReservationResourceSpecification', 'locationName' => 'resourceSpecification', ], 'Start' => [ 'shape' => '__string', 'locationName' => 'start', ], 'State' => [ 'shape' => 'ReservationState', 'locationName' => 'state', ], 'UsagePrice' => [ 'shape' => '__double', 'locationName' => 'usagePrice', ], ], ], 'ReservationCodec' => [ 'type' => 'string', 'enum' => [ 'MPEG2', 'AVC', 'HEVC', 'AUDIO', ], ], 'ReservationMaximumBitrate' => [ 'type' => 'string', 'enum' => [ 'MAX_10_MBPS', 'MAX_20_MBPS', 'MAX_50_MBPS', ], ], 'ReservationMaximumFramerate' => [ 'type' => 'string', 'enum' => [ 'MAX_30_FPS', 'MAX_60_FPS', ], ], 'ReservationResolution' => [ 'type' => 'string', 'enum' => [ 'SD', 'HD', 'UHD', ], ], 'ReservationResourceSpecification' => [ 'type' => 'structure', 'members' => [ 'Codec' => [ 'shape' => 'ReservationCodec', 'locationName' => 'codec', ], 'MaximumBitrate' => [ 'shape' => 'ReservationMaximumBitrate', 'locationName' => 'maximumBitrate', ], 'MaximumFramerate' => [ 'shape' => 'ReservationMaximumFramerate', 'locationName' => 'maximumFramerate', ], 'Resolution' => [ 'shape' => 'ReservationResolution', 'locationName' => 'resolution', ], 'ResourceType' => [ 'shape' => 'ReservationResourceType', 'locationName' => 'resourceType', ], 'SpecialFeature' => [ 'shape' => 'ReservationSpecialFeature', 'locationName' => 'specialFeature', ], 'VideoQuality' => [ 'shape' => 'ReservationVideoQuality', 'locationName' => 'videoQuality', ], ], ], 'ReservationResourceType' => [ 'type' => 'string', 'enum' => [ 'INPUT', 'OUTPUT', 'CHANNEL', ], ], 'ReservationSpecialFeature' => [ 'type' => 'string', 'enum' => [ 'ADVANCED_AUDIO', 'AUDIO_NORMALIZATION', ], ], 'ReservationState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'EXPIRED', 'CANCELED', 'DELETED', ], ], 'ReservationVideoQuality' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'ENHANCED', 'PREMIUM', ], ], 'ResourceConflict' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], ], 'RtmpCacheFullBehavior' => [ 'type' => 'string', 'enum' => [ 'DISCONNECT_IMMEDIATELY', 'WAIT_FOR_SERVER', ], ], 'RtmpCaptionData' => [ 'type' => 'string', 'enum' => [ 'ALL', 'FIELD1_608', 'FIELD1_AND_FIELD2_608', ], ], 'RtmpCaptionInfoDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'RtmpGroupSettings' => [ 'type' => 'structure', 'members' => [ 'AuthenticationScheme' => [ 'shape' => 'AuthenticationScheme', 'locationName' => 'authenticationScheme', ], 'CacheFullBehavior' => [ 'shape' => 'RtmpCacheFullBehavior', 'locationName' => 'cacheFullBehavior', ], 'CacheLength' => [ 'shape' => '__integerMin30', 'locationName' => 'cacheLength', ], 'CaptionData' => [ 'shape' => 'RtmpCaptionData', 'locationName' => 'captionData', ], 'InputLossAction' => [ 'shape' => 'InputLossActionForRtmpOut', 'locationName' => 'inputLossAction', ], 'RestartDelay' => [ 'shape' => '__integerMin0', 'locationName' => 'restartDelay', ], ], ], 'RtmpOutputCertificateMode' => [ 'type' => 'string', 'enum' => [ 'SELF_SIGNED', 'VERIFY_AUTHENTICITY', ], ], 'RtmpOutputSettings' => [ 'type' => 'structure', 'members' => [ 'CertificateMode' => [ 'shape' => 'RtmpOutputCertificateMode', 'locationName' => 'certificateMode', ], 'ConnectionRetryInterval' => [ 'shape' => '__integerMin1', 'locationName' => 'connectionRetryInterval', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'NumRetries' => [ 'shape' => '__integerMin0', 'locationName' => 'numRetries', ], ], 'required' => [ 'Destination', ], ], 'ScheduleAction' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => '__string', 'locationName' => 'actionName', ], 'ScheduleActionSettings' => [ 'shape' => 'ScheduleActionSettings', 'locationName' => 'scheduleActionSettings', ], 'ScheduleActionStartSettings' => [ 'shape' => 'ScheduleActionStartSettings', 'locationName' => 'scheduleActionStartSettings', ], ], 'required' => [ 'ActionName', 'ScheduleActionStartSettings', 'ScheduleActionSettings', ], ], 'ScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'HlsTimedMetadataSettings' => [ 'shape' => 'HlsTimedMetadataScheduleActionSettings', 'locationName' => 'hlsTimedMetadataSettings', ], 'InputSwitchSettings' => [ 'shape' => 'InputSwitchScheduleActionSettings', 'locationName' => 'inputSwitchSettings', ], 'PauseStateSettings' => [ 'shape' => 'PauseStateScheduleActionSettings', 'locationName' => 'pauseStateSettings', ], 'Scte35ReturnToNetworkSettings' => [ 'shape' => 'Scte35ReturnToNetworkScheduleActionSettings', 'locationName' => 'scte35ReturnToNetworkSettings', ], 'Scte35SpliceInsertSettings' => [ 'shape' => 'Scte35SpliceInsertScheduleActionSettings', 'locationName' => 'scte35SpliceInsertSettings', ], 'Scte35TimeSignalSettings' => [ 'shape' => 'Scte35TimeSignalScheduleActionSettings', 'locationName' => 'scte35TimeSignalSettings', ], 'StaticImageActivateSettings' => [ 'shape' => 'StaticImageActivateScheduleActionSettings', 'locationName' => 'staticImageActivateSettings', ], 'StaticImageDeactivateSettings' => [ 'shape' => 'StaticImageDeactivateScheduleActionSettings', 'locationName' => 'staticImageDeactivateSettings', ], ], ], 'ScheduleActionStartSettings' => [ 'type' => 'structure', 'members' => [ 'FixedModeScheduleActionStartSettings' => [ 'shape' => 'FixedModeScheduleActionStartSettings', 'locationName' => 'fixedModeScheduleActionStartSettings', ], 'FollowModeScheduleActionStartSettings' => [ 'shape' => 'FollowModeScheduleActionStartSettings', 'locationName' => 'followModeScheduleActionStartSettings', ], ], ], 'ScheduleDescribeResultModel' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => '__string', 'locationName' => 'nextToken', ], 'ScheduleActions' => [ 'shape' => '__listOfScheduleAction', 'locationName' => 'scheduleActions', ], ], 'required' => [ 'ScheduleActions', ], ], 'Scte20Convert608To708' => [ 'type' => 'string', 'enum' => [ 'DISABLED', 'UPCONVERT', ], ], 'Scte20PlusEmbeddedDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'Scte20SourceSettings' => [ 'type' => 'structure', 'members' => [ 'Convert608To708' => [ 'shape' => 'Scte20Convert608To708', 'locationName' => 'convert608To708', ], 'Source608ChannelNumber' => [ 'shape' => '__integerMin1Max4', 'locationName' => 'source608ChannelNumber', ], ], ], 'Scte27DestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'Scte27SourceSettings' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin1', 'locationName' => 'pid', ], ], ], 'Scte35AposNoRegionalBlackoutBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35AposWebDeliveryAllowedBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35ArchiveAllowedFlag' => [ 'type' => 'string', 'enum' => [ 'ARCHIVE_NOT_ALLOWED', 'ARCHIVE_ALLOWED', ], ], 'Scte35DeliveryRestrictions' => [ 'type' => 'structure', 'members' => [ 'ArchiveAllowedFlag' => [ 'shape' => 'Scte35ArchiveAllowedFlag', 'locationName' => 'archiveAllowedFlag', ], 'DeviceRestrictions' => [ 'shape' => 'Scte35DeviceRestrictions', 'locationName' => 'deviceRestrictions', ], 'NoRegionalBlackoutFlag' => [ 'shape' => 'Scte35NoRegionalBlackoutFlag', 'locationName' => 'noRegionalBlackoutFlag', ], 'WebDeliveryAllowedFlag' => [ 'shape' => 'Scte35WebDeliveryAllowedFlag', 'locationName' => 'webDeliveryAllowedFlag', ], ], 'required' => [ 'DeviceRestrictions', 'ArchiveAllowedFlag', 'WebDeliveryAllowedFlag', 'NoRegionalBlackoutFlag', ], ], 'Scte35Descriptor' => [ 'type' => 'structure', 'members' => [ 'Scte35DescriptorSettings' => [ 'shape' => 'Scte35DescriptorSettings', 'locationName' => 'scte35DescriptorSettings', ], ], 'required' => [ 'Scte35DescriptorSettings', ], ], 'Scte35DescriptorSettings' => [ 'type' => 'structure', 'members' => [ 'SegmentationDescriptorScte35DescriptorSettings' => [ 'shape' => 'Scte35SegmentationDescriptor', 'locationName' => 'segmentationDescriptorScte35DescriptorSettings', ], ], 'required' => [ 'SegmentationDescriptorScte35DescriptorSettings', ], ], 'Scte35DeviceRestrictions' => [ 'type' => 'string', 'enum' => [ 'NONE', 'RESTRICT_GROUP0', 'RESTRICT_GROUP1', 'RESTRICT_GROUP2', ], ], 'Scte35NoRegionalBlackoutFlag' => [ 'type' => 'string', 'enum' => [ 'REGIONAL_BLACKOUT', 'NO_REGIONAL_BLACKOUT', ], ], 'Scte35ReturnToNetworkScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'SpliceEventId' => [ 'shape' => '__integerMin0Max4294967295', 'locationName' => 'spliceEventId', ], ], 'required' => [ 'SpliceEventId', ], ], 'Scte35SegmentationCancelIndicator' => [ 'type' => 'string', 'enum' => [ 'SEGMENTATION_EVENT_NOT_CANCELED', 'SEGMENTATION_EVENT_CANCELED', ], ], 'Scte35SegmentationDescriptor' => [ 'type' => 'structure', 'members' => [ 'DeliveryRestrictions' => [ 'shape' => 'Scte35DeliveryRestrictions', 'locationName' => 'deliveryRestrictions', ], 'SegmentNum' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentNum', ], 'SegmentationCancelIndicator' => [ 'shape' => 'Scte35SegmentationCancelIndicator', 'locationName' => 'segmentationCancelIndicator', ], 'SegmentationDuration' => [ 'shape' => '__integerMin0Max1099511627775', 'locationName' => 'segmentationDuration', ], 'SegmentationEventId' => [ 'shape' => '__integerMin0Max4294967295', 'locationName' => 'segmentationEventId', ], 'SegmentationTypeId' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentationTypeId', ], 'SegmentationUpid' => [ 'shape' => '__string', 'locationName' => 'segmentationUpid', ], 'SegmentationUpidType' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentationUpidType', ], 'SegmentsExpected' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'segmentsExpected', ], 'SubSegmentNum' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'subSegmentNum', ], 'SubSegmentsExpected' => [ 'shape' => '__integerMin0Max255', 'locationName' => 'subSegmentsExpected', ], ], 'required' => [ 'SegmentationEventId', 'SegmentationCancelIndicator', ], ], 'Scte35SpliceInsert' => [ 'type' => 'structure', 'members' => [ 'AdAvailOffset' => [ 'shape' => '__integerMinNegative1000Max1000', 'locationName' => 'adAvailOffset', ], 'NoRegionalBlackoutFlag' => [ 'shape' => 'Scte35SpliceInsertNoRegionalBlackoutBehavior', 'locationName' => 'noRegionalBlackoutFlag', ], 'WebDeliveryAllowedFlag' => [ 'shape' => 'Scte35SpliceInsertWebDeliveryAllowedBehavior', 'locationName' => 'webDeliveryAllowedFlag', ], ], ], 'Scte35SpliceInsertNoRegionalBlackoutBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35SpliceInsertScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Duration' => [ 'shape' => '__integerMin0Max8589934591', 'locationName' => 'duration', ], 'SpliceEventId' => [ 'shape' => '__integerMin0Max4294967295', 'locationName' => 'spliceEventId', ], ], 'required' => [ 'SpliceEventId', ], ], 'Scte35SpliceInsertWebDeliveryAllowedBehavior' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'IGNORE', ], ], 'Scte35TimeSignalApos' => [ 'type' => 'structure', 'members' => [ 'AdAvailOffset' => [ 'shape' => '__integerMinNegative1000Max1000', 'locationName' => 'adAvailOffset', ], 'NoRegionalBlackoutFlag' => [ 'shape' => 'Scte35AposNoRegionalBlackoutBehavior', 'locationName' => 'noRegionalBlackoutFlag', ], 'WebDeliveryAllowedFlag' => [ 'shape' => 'Scte35AposWebDeliveryAllowedBehavior', 'locationName' => 'webDeliveryAllowedFlag', ], ], ], 'Scte35TimeSignalScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Scte35Descriptors' => [ 'shape' => '__listOfScte35Descriptor', 'locationName' => 'scte35Descriptors', ], ], 'required' => [ 'Scte35Descriptors', ], ], 'Scte35WebDeliveryAllowedFlag' => [ 'type' => 'string', 'enum' => [ 'WEB_DELIVERY_NOT_ALLOWED', 'WEB_DELIVERY_ALLOWED', ], ], 'SmoothGroupAudioOnlyTimecodeControl' => [ 'type' => 'string', 'enum' => [ 'PASSTHROUGH', 'USE_CONFIGURED_CLOCK', ], ], 'SmoothGroupCertificateMode' => [ 'type' => 'string', 'enum' => [ 'SELF_SIGNED', 'VERIFY_AUTHENTICITY', ], ], 'SmoothGroupEventIdMode' => [ 'type' => 'string', 'enum' => [ 'NO_EVENT_ID', 'USE_CONFIGURED', 'USE_TIMESTAMP', ], ], 'SmoothGroupEventStopBehavior' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SEND_EOS', ], ], 'SmoothGroupSegmentationMode' => [ 'type' => 'string', 'enum' => [ 'USE_INPUT_SEGMENTATION', 'USE_SEGMENT_DURATION', ], ], 'SmoothGroupSparseTrackType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SCTE_35', ], ], 'SmoothGroupStreamManifestBehavior' => [ 'type' => 'string', 'enum' => [ 'DO_NOT_SEND', 'SEND', ], ], 'SmoothGroupTimestampOffsetMode' => [ 'type' => 'string', 'enum' => [ 'USE_CONFIGURED_OFFSET', 'USE_EVENT_START_DATE', ], ], 'SmpteTtDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'StandardHlsSettings' => [ 'type' => 'structure', 'members' => [ 'AudioRenditionSets' => [ 'shape' => '__string', 'locationName' => 'audioRenditionSets', ], 'M3u8Settings' => [ 'shape' => 'M3u8Settings', 'locationName' => 'm3u8Settings', ], ], 'required' => [ 'M3u8Settings', ], ], 'StartChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'StartChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'StaticImageActivateScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'Duration' => [ 'shape' => '__integerMin0', 'locationName' => 'duration', ], 'FadeIn' => [ 'shape' => '__integerMin0', 'locationName' => 'fadeIn', ], 'FadeOut' => [ 'shape' => '__integerMin0', 'locationName' => 'fadeOut', ], 'Height' => [ 'shape' => '__integerMin1', 'locationName' => 'height', ], 'Image' => [ 'shape' => 'InputLocation', 'locationName' => 'image', ], 'ImageX' => [ 'shape' => '__integerMin0', 'locationName' => 'imageX', ], 'ImageY' => [ 'shape' => '__integerMin0', 'locationName' => 'imageY', ], 'Layer' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'layer', ], 'Opacity' => [ 'shape' => '__integerMin0Max100', 'locationName' => 'opacity', ], 'Width' => [ 'shape' => '__integerMin1', 'locationName' => 'width', ], ], 'required' => [ 'Image', ], ], 'StaticImageDeactivateScheduleActionSettings' => [ 'type' => 'structure', 'members' => [ 'FadeOut' => [ 'shape' => '__integerMin0', 'locationName' => 'fadeOut', ], 'Layer' => [ 'shape' => '__integerMin0Max7', 'locationName' => 'layer', ], ], ], 'StaticKeySettings' => [ 'type' => 'structure', 'members' => [ 'KeyProviderServer' => [ 'shape' => 'InputLocation', 'locationName' => 'keyProviderServer', ], 'StaticKeyValue' => [ 'shape' => '__stringMin32Max32', 'locationName' => 'staticKeyValue', ], ], 'required' => [ 'StaticKeyValue', ], ], 'StopChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], ], 'required' => [ 'ChannelId', ], ], 'StopChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => '__string', 'locationName' => 'arn', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EgressEndpoints' => [ 'shape' => '__listOfChannelEgressEndpoint', 'locationName' => 'egressEndpoints', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'Id' => [ 'shape' => '__string', 'locationName' => 'id', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'PipelinesRunningCount' => [ 'shape' => '__integer', 'locationName' => 'pipelinesRunningCount', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'State' => [ 'shape' => 'ChannelState', 'locationName' => 'state', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'Tags' => [ 'type' => 'map', 'key' => [ 'shape' => '__string', ], 'value' => [ 'shape' => '__string', ], ], 'TagsModel' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], ], ], 'TeletextDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], 'TeletextSourceSettings' => [ 'type' => 'structure', 'members' => [ 'PageNumber' => [ 'shape' => '__string', 'locationName' => 'pageNumber', ], ], ], 'TimecodeConfig' => [ 'type' => 'structure', 'members' => [ 'Source' => [ 'shape' => 'TimecodeConfigSource', 'locationName' => 'source', ], 'SyncThreshold' => [ 'shape' => '__integerMin1Max1000000', 'locationName' => 'syncThreshold', ], ], 'required' => [ 'Source', ], ], 'TimecodeConfigSource' => [ 'type' => 'string', 'enum' => [ 'EMBEDDED', 'SYSTEMCLOCK', 'ZEROBASED', ], ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 429, ], ], 'TtmlDestinationSettings' => [ 'type' => 'structure', 'members' => [ 'StyleControl' => [ 'shape' => 'TtmlDestinationStyleControl', 'locationName' => 'styleControl', ], ], ], 'TtmlDestinationStyleControl' => [ 'type' => 'string', 'enum' => [ 'PASSTHROUGH', 'USE_CONFIGURED', ], ], 'UdpContainerSettings' => [ 'type' => 'structure', 'members' => [ 'M2tsSettings' => [ 'shape' => 'M2tsSettings', 'locationName' => 'm2tsSettings', ], ], ], 'UdpGroupSettings' => [ 'type' => 'structure', 'members' => [ 'InputLossAction' => [ 'shape' => 'InputLossActionForUdpOut', 'locationName' => 'inputLossAction', ], 'TimedMetadataId3Frame' => [ 'shape' => 'UdpTimedMetadataId3Frame', 'locationName' => 'timedMetadataId3Frame', ], 'TimedMetadataId3Period' => [ 'shape' => '__integerMin0', 'locationName' => 'timedMetadataId3Period', ], ], ], 'UdpOutputSettings' => [ 'type' => 'structure', 'members' => [ 'BufferMsec' => [ 'shape' => '__integerMin0Max10000', 'locationName' => 'bufferMsec', ], 'ContainerSettings' => [ 'shape' => 'UdpContainerSettings', 'locationName' => 'containerSettings', ], 'Destination' => [ 'shape' => 'OutputLocationRef', 'locationName' => 'destination', ], 'FecOutputSettings' => [ 'shape' => 'FecOutputSettings', 'locationName' => 'fecOutputSettings', ], ], 'required' => [ 'Destination', 'ContainerSettings', ], ], 'UdpTimedMetadataId3Frame' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PRIV', 'TDRL', ], ], 'UnprocessableEntityException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => '__string', 'locationName' => 'message', ], 'ValidationErrors' => [ 'shape' => '__listOfValidationError', 'locationName' => 'validationErrors', ], ], 'exception' => true, 'error' => [ 'httpStatusCode' => 422, ], ], 'UpdateChannel' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], ], ], 'UpdateChannelRequest' => [ 'type' => 'structure', 'members' => [ 'ChannelId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'channelId', ], 'Destinations' => [ 'shape' => '__listOfOutputDestination', 'locationName' => 'destinations', ], 'EncoderSettings' => [ 'shape' => 'EncoderSettings', 'locationName' => 'encoderSettings', ], 'InputAttachments' => [ 'shape' => '__listOfInputAttachment', 'locationName' => 'inputAttachments', ], 'InputSpecification' => [ 'shape' => 'InputSpecification', 'locationName' => 'inputSpecification', ], 'LogLevel' => [ 'shape' => 'LogLevel', 'locationName' => 'logLevel', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], ], 'required' => [ 'ChannelId', ], ], 'UpdateChannelResponse' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'UpdateChannelResultModel' => [ 'type' => 'structure', 'members' => [ 'Channel' => [ 'shape' => 'Channel', 'locationName' => 'channel', ], ], ], 'UpdateInput' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], ], ], 'UpdateInputRequest' => [ 'type' => 'structure', 'members' => [ 'Destinations' => [ 'shape' => '__listOfInputDestinationRequest', 'locationName' => 'destinations', ], 'InputId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputId', ], 'InputSecurityGroups' => [ 'shape' => '__listOf__string', 'locationName' => 'inputSecurityGroups', ], 'MediaConnectFlows' => [ 'shape' => '__listOfMediaConnectFlowRequest', 'locationName' => 'mediaConnectFlows', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RoleArn' => [ 'shape' => '__string', 'locationName' => 'roleArn', ], 'Sources' => [ 'shape' => '__listOfInputSourceRequest', 'locationName' => 'sources', ], ], 'required' => [ 'InputId', ], ], 'UpdateInputResponse' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'UpdateInputResultModel' => [ 'type' => 'structure', 'members' => [ 'Input' => [ 'shape' => 'Input', 'locationName' => 'input', ], ], ], 'UpdateInputSecurityGroupRequest' => [ 'type' => 'structure', 'members' => [ 'InputSecurityGroupId' => [ 'shape' => '__string', 'location' => 'uri', 'locationName' => 'inputSecurityGroupId', ], 'Tags' => [ 'shape' => 'Tags', 'locationName' => 'tags', ], 'WhitelistRules' => [ 'shape' => '__listOfInputWhitelistRuleCidr', 'locationName' => 'whitelistRules', ], ], 'required' => [ 'InputSecurityGroupId', ], ], 'UpdateInputSecurityGroupResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'UpdateInputSecurityGroupResultModel' => [ 'type' => 'structure', 'members' => [ 'SecurityGroup' => [ 'shape' => 'InputSecurityGroup', 'locationName' => 'securityGroup', ], ], ], 'ValidationError' => [ 'type' => 'structure', 'members' => [ 'ElementPath' => [ 'shape' => '__string', 'locationName' => 'elementPath', ], 'ErrorMessage' => [ 'shape' => '__string', 'locationName' => 'errorMessage', ], ], ], 'VideoCodecSettings' => [ 'type' => 'structure', 'members' => [ 'FrameCaptureSettings' => [ 'shape' => 'FrameCaptureSettings', 'locationName' => 'frameCaptureSettings', ], 'H264Settings' => [ 'shape' => 'H264Settings', 'locationName' => 'h264Settings', ], ], ], 'VideoDescription' => [ 'type' => 'structure', 'members' => [ 'CodecSettings' => [ 'shape' => 'VideoCodecSettings', 'locationName' => 'codecSettings', ], 'Height' => [ 'shape' => '__integer', 'locationName' => 'height', ], 'Name' => [ 'shape' => '__string', 'locationName' => 'name', ], 'RespondToAfd' => [ 'shape' => 'VideoDescriptionRespondToAfd', 'locationName' => 'respondToAfd', ], 'ScalingBehavior' => [ 'shape' => 'VideoDescriptionScalingBehavior', 'locationName' => 'scalingBehavior', ], 'Sharpness' => [ 'shape' => '__integerMin0Max100', 'locationName' => 'sharpness', ], 'Width' => [ 'shape' => '__integer', 'locationName' => 'width', ], ], 'required' => [ 'Name', ], ], 'VideoDescriptionRespondToAfd' => [ 'type' => 'string', 'enum' => [ 'NONE', 'PASSTHROUGH', 'RESPOND', ], ], 'VideoDescriptionScalingBehavior' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'STRETCH_TO_OUTPUT', ], ], 'VideoSelector' => [ 'type' => 'structure', 'members' => [ 'ColorSpace' => [ 'shape' => 'VideoSelectorColorSpace', 'locationName' => 'colorSpace', ], 'ColorSpaceUsage' => [ 'shape' => 'VideoSelectorColorSpaceUsage', 'locationName' => 'colorSpaceUsage', ], 'SelectorSettings' => [ 'shape' => 'VideoSelectorSettings', 'locationName' => 'selectorSettings', ], ], ], 'VideoSelectorColorSpace' => [ 'type' => 'string', 'enum' => [ 'FOLLOW', 'REC_601', 'REC_709', ], ], 'VideoSelectorColorSpaceUsage' => [ 'type' => 'string', 'enum' => [ 'FALLBACK', 'FORCE', ], ], 'VideoSelectorPid' => [ 'type' => 'structure', 'members' => [ 'Pid' => [ 'shape' => '__integerMin0Max8191', 'locationName' => 'pid', ], ], ], 'VideoSelectorProgramId' => [ 'type' => 'structure', 'members' => [ 'ProgramId' => [ 'shape' => '__integerMin0Max65536', 'locationName' => 'programId', ], ], ], 'VideoSelectorSettings' => [ 'type' => 'structure', 'members' => [ 'VideoSelectorPid' => [ 'shape' => 'VideoSelectorPid', 'locationName' => 'videoSelectorPid', ], 'VideoSelectorProgramId' => [ 'shape' => 'VideoSelectorProgramId', 'locationName' => 'videoSelectorProgramId', ], ], ], 'WebvttDestinationSettings' => [ 'type' => 'structure', 'members' => [], ], '__boolean' => [ 'type' => 'boolean', ], '__double' => [ 'type' => 'double', ], '__doubleMin0' => [ 'type' => 'double', ], '__doubleMin1' => [ 'type' => 'double', ], '__doubleMinNegative59Max0' => [ 'type' => 'double', ], '__integer' => [ 'type' => 'integer', ], '__integerMin0' => [ 'type' => 'integer', 'min' => 0, ], '__integerMin0Max10' => [ 'type' => 'integer', 'min' => 0, 'max' => 10, ], '__integerMin0Max100' => [ 'type' => 'integer', 'min' => 0, 'max' => 100, ], '__integerMin0Max1000' => [ 'type' => 'integer', 'min' => 0, 'max' => 1000, ], '__integerMin0Max10000' => [ 'type' => 'integer', 'min' => 0, 'max' => 10000, ], '__integerMin0Max1000000' => [ 'type' => 'integer', 'min' => 0, 'max' => 1000000, ], '__integerMin0Max1099511627775' => [ 'type' => 'long', 'min' => 0, 'max' => 1099511627775, ], '__integerMin0Max128' => [ 'type' => 'integer', 'min' => 0, 'max' => 128, ], '__integerMin0Max15' => [ 'type' => 'integer', 'min' => 0, 'max' => 15, ], '__integerMin0Max255' => [ 'type' => 'integer', 'min' => 0, 'max' => 255, ], '__integerMin0Max30' => [ 'type' => 'integer', 'min' => 0, 'max' => 30, ], '__integerMin0Max3600' => [ 'type' => 'integer', 'min' => 0, 'max' => 3600, ], '__integerMin0Max4294967295' => [ 'type' => 'long', 'min' => 0, 'max' => 4294967295, ], '__integerMin0Max500' => [ 'type' => 'integer', 'min' => 0, 'max' => 500, ], '__integerMin0Max600' => [ 'type' => 'integer', 'min' => 0, 'max' => 600, ], '__integerMin0Max65535' => [ 'type' => 'integer', 'min' => 0, 'max' => 65535, ], '__integerMin0Max65536' => [ 'type' => 'integer', 'min' => 0, 'max' => 65536, ], '__integerMin0Max7' => [ 'type' => 'integer', 'min' => 0, 'max' => 7, ], '__integerMin0Max8191' => [ 'type' => 'integer', 'min' => 0, 'max' => 8191, ], '__integerMin0Max8589934591' => [ 'type' => 'long', 'min' => 0, 'max' => 8589934591, ], '__integerMin1' => [ 'type' => 'integer', 'min' => 1, ], '__integerMin1000' => [ 'type' => 'integer', 'min' => 1000, ], '__integerMin1000Max30000' => [ 'type' => 'integer', 'min' => 1000, 'max' => 30000, ], '__integerMin1Max10' => [ 'type' => 'integer', 'min' => 1, 'max' => 10, ], '__integerMin1Max1000000' => [ 'type' => 'integer', 'min' => 1, 'max' => 1000000, ], '__integerMin1Max16' => [ 'type' => 'integer', 'min' => 1, 'max' => 16, ], '__integerMin1Max20' => [ 'type' => 'integer', 'min' => 1, 'max' => 20, ], '__integerMin1Max31' => [ 'type' => 'integer', 'min' => 1, 'max' => 31, ], '__integerMin1Max32' => [ 'type' => 'integer', 'min' => 1, 'max' => 32, ], '__integerMin1Max3600' => [ 'type' => 'integer', 'min' => 1, 'max' => 3600, ], '__integerMin1Max4' => [ 'type' => 'integer', 'min' => 1, 'max' => 4, ], '__integerMin1Max5' => [ 'type' => 'integer', 'min' => 1, 'max' => 5, ], '__integerMin1Max6' => [ 'type' => 'integer', 'min' => 1, 'max' => 6, ], '__integerMin1Max8' => [ 'type' => 'integer', 'min' => 1, 'max' => 8, ], '__integerMin25Max10000' => [ 'type' => 'integer', 'min' => 25, 'max' => 10000, ], '__integerMin25Max2000' => [ 'type' => 'integer', 'min' => 25, 'max' => 2000, ], '__integerMin3' => [ 'type' => 'integer', 'min' => 3, ], '__integerMin30' => [ 'type' => 'integer', 'min' => 30, ], '__integerMin4Max20' => [ 'type' => 'integer', 'min' => 4, 'max' => 20, ], '__integerMin96Max600' => [ 'type' => 'integer', 'min' => 96, 'max' => 600, ], '__integerMinNegative1000Max1000' => [ 'type' => 'integer', 'min' => -1000, 'max' => 1000, ], '__integerMinNegative60Max6' => [ 'type' => 'integer', 'min' => -60, 'max' => 6, ], '__integerMinNegative60Max60' => [ 'type' => 'integer', 'min' => -60, 'max' => 60, ], '__listOfAudioChannelMapping' => [ 'type' => 'list', 'member' => [ 'shape' => 'AudioChannelMapping', ], ], '__listOfAudioDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'AudioDescription', ], ], '__listOfAudioSelector' => [ 'type' => 'list', 'member' => [ 'shape' => 'AudioSelector', ], ], '__listOfCaptionDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptionDescription', ], ], '__listOfCaptionLanguageMapping' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptionLanguageMapping', ], ], '__listOfCaptionSelector' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptionSelector', ], ], '__listOfChannelEgressEndpoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelEgressEndpoint', ], ], '__listOfChannelSummary' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSummary', ], ], '__listOfHlsAdMarkers' => [ 'type' => 'list', 'member' => [ 'shape' => 'HlsAdMarkers', ], ], '__listOfInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'Input', ], ], '__listOfInputAttachment' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputAttachment', ], ], '__listOfInputChannelLevel' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputChannelLevel', ], ], '__listOfInputDestination' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputDestination', ], ], '__listOfInputDestinationRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputDestinationRequest', ], ], '__listOfInputSecurityGroup' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputSecurityGroup', ], ], '__listOfInputSource' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputSource', ], ], '__listOfInputSourceRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputSourceRequest', ], ], '__listOfInputWhitelistRule' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputWhitelistRule', ], ], '__listOfInputWhitelistRuleCidr' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputWhitelistRuleCidr', ], ], '__listOfMediaConnectFlow' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaConnectFlow', ], ], '__listOfMediaConnectFlowRequest' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaConnectFlowRequest', ], ], '__listOfMediaPackageOutputDestinationSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaPackageOutputDestinationSettings', ], ], '__listOfOffering' => [ 'type' => 'list', 'member' => [ 'shape' => 'Offering', ], ], '__listOfOutput' => [ 'type' => 'list', 'member' => [ 'shape' => 'Output', ], ], '__listOfOutputDestination' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputDestination', ], ], '__listOfOutputDestinationSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputDestinationSettings', ], ], '__listOfOutputGroup' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputGroup', ], ], '__listOfPipelinePauseStateSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelinePauseStateSettings', ], ], '__listOfReservation' => [ 'type' => 'list', 'member' => [ 'shape' => 'Reservation', ], ], '__listOfScheduleAction' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScheduleAction', ], ], '__listOfScte35Descriptor' => [ 'type' => 'list', 'member' => [ 'shape' => 'Scte35Descriptor', ], ], '__listOfValidationError' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationError', ], ], '__listOfVideoDescription' => [ 'type' => 'list', 'member' => [ 'shape' => 'VideoDescription', ], ], '__listOf__string' => [ 'type' => 'list', 'member' => [ 'shape' => '__string', ], ], '__long' => [ 'type' => 'long', ], '__string' => [ 'type' => 'string', ], '__stringMax32' => [ 'type' => 'string', 'max' => 32, ], '__stringMin1' => [ 'type' => 'string', 'min' => 1, ], '__stringMin1Max255' => [ 'type' => 'string', 'min' => 1, 'max' => 255, ], '__stringMin1Max256' => [ 'type' => 'string', 'min' => 1, 'max' => 256, ], '__stringMin32Max32' => [ 'type' => 'string', 'min' => 32, 'max' => 32, ], '__stringMin34Max34' => [ 'type' => 'string', 'min' => 34, 'max' => 34, ], '__stringMin3Max3' => [ 'type' => 'string', 'min' => 3, 'max' => 3, ], '__stringMin6Max6' => [ 'type' => 'string', 'min' => 6, 'max' => 6, ], '__timestampIso8601' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], '__timestampUnix' => [ 'type' => 'timestamp', 'timestampFormat' => 'unixTimestamp', ], ],]; diff --git a/src/data/medialive/2017-10-14/docs-2.json b/src/data/medialive/2017-10-14/docs-2.json index c31e8df3a4..a9d724a754 100644 --- a/src/data/medialive/2017-10-14/docs-2.json +++ b/src/data/medialive/2017-10-14/docs-2.json @@ -1026,7 +1026,7 @@ "HlsRedundantManifest": { "base": null, "refs": { - "HlsGroupSettings$RedundantManifest": "When set to \"enabled\", includes the media playlists from both pipelines in the master manifest (.m3u8) file." + "HlsGroupSettings$RedundantManifest": "ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.\n\nDISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.\n\nFor an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant." } }, "HlsSegmentationMode": { @@ -1502,6 +1502,24 @@ "__listOfMediaConnectFlowRequest$member": null } }, + "MediaPackageGroupSettings": { + "base": "Media Package Group Settings", + "refs": { + "OutputGroupSettings$MediaPackageGroupSettings": null + } + }, + "MediaPackageOutputDestinationSettings": { + "base": "Media Package Output Destination Settings", + "refs": { + "__listOfMediaPackageOutputDestinationSettings$member": null + } + }, + "MediaPackageOutputSettings": { + "base": "Media Package Output Settings", + "refs": { + "OutputSettings$MediaPackageOutputSettings": null + } + }, "Mp2CodingMode": { "base": null, "refs": { @@ -1599,6 +1617,7 @@ "ArchiveGroupSettings$Destination": "A directory and base filename where archive files should be written.", "FrameCaptureGroupSettings$Destination": "The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, \"curling_\") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg", "HlsGroupSettings$Destination": "A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).", + "MediaPackageGroupSettings$Destination": "MediaPackage channel destination.", "MsSmoothGroupSettings$Destination": "Smooth Streaming publish point on an IIS server. Elemental Live acts as a \"Push\" encoder to IIS.", "RtmpOutputSettings$Destination": "The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.", "UdpOutputSettings$Destination": "Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002)." @@ -2723,6 +2742,12 @@ "UpdateInput$MediaConnectFlows": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.\n" } }, + "__listOfMediaPackageOutputDestinationSettings": { + "base": null, + "refs": { + "OutputDestination$MediaPackageSettings": "Destination settings for a MediaPackage output; one destination for both encoders." + } + }, "__listOfOffering": { "base": null, "refs": { @@ -2747,7 +2772,7 @@ "__listOfOutputDestinationSettings": { "base": null, "refs": { - "OutputDestination$Settings": "Destination settings for output; one for each redundant encoder." + "OutputDestination$Settings": "Destination settings for a standard output; one destination for each redundant encoder." } }, "__listOfOutputGroup": { @@ -2973,7 +2998,8 @@ "AudioSelector$Name": "The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.", "CaptionLanguageMapping$LanguageDescription": "Textual description of language", "CaptionSelector$Name": "Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.", - "HlsOutputSettings$NameModifier": "String concatenated to the end of the destination filename. Accepts \\\"Format Identifiers\\\":#formatIdentifierParameters." + "HlsOutputSettings$NameModifier": "String concatenated to the end of the destination filename. Accepts \\\"Format Identifiers\\\":#formatIdentifierParameters.", + "MediaPackageOutputDestinationSettings$ChannelId": "ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region." } }, "__stringMin1Max255": { diff --git a/src/data/medialive/2017-10-14/docs-2.json.php b/src/data/medialive/2017-10-14/docs-2.json.php index 28b18298d4..1be3044797 100644 --- a/src/data/medialive/2017-10-14/docs-2.json.php +++ b/src/data/medialive/2017-10-14/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'API for AWS Elemental MediaLive', 'operations' => [ 'BatchUpdateSchedule' => 'Update a channel schedule', 'CreateChannel' => 'Creates a new channel', 'CreateInput' => 'Create an input', 'CreateInputSecurityGroup' => 'Creates a Input Security Group', 'CreateTags' => 'Create tags for a resource', 'DeleteChannel' => 'Starts deletion of channel. The associated outputs are also deleted.', 'DeleteInput' => 'Deletes the input end point', 'DeleteInputSecurityGroup' => 'Deletes an Input Security Group', 'DeleteReservation' => 'Delete an expired reservation.', 'DeleteTags' => 'Removes tags for a resource', 'DescribeChannel' => 'Gets details about a channel', 'DescribeInput' => 'Produces details about an input', 'DescribeInputSecurityGroup' => 'Produces a summary of an Input Security Group', 'DescribeOffering' => 'Get details for an offering.', 'DescribeReservation' => 'Get details for a reservation.', 'DescribeSchedule' => 'Get a channel schedule', 'ListChannels' => 'Produces list of channels that have been created', 'ListInputSecurityGroups' => 'Produces a list of Input Security Groups for an account', 'ListInputs' => 'Produces list of inputs that have been created', 'ListOfferings' => 'List offerings available for purchase.', 'ListReservations' => 'List purchased reservations.', 'ListTagsForResource' => 'Produces list of tags that have been created for a resource', 'PurchaseOffering' => 'Purchase an offering and create a reservation.', 'StartChannel' => 'Starts an existing channel', 'StopChannel' => 'Stops a running channel', 'UpdateChannel' => 'Updates a channel.', 'UpdateInput' => 'Updates an input.', 'UpdateInputSecurityGroup' => 'Update an Input Security Group\'s Whilelists.', ], 'shapes' => [ 'AacCodingMode' => [ 'base' => NULL, 'refs' => [ 'AacSettings$CodingMode' => 'Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.', ], ], 'AacInputType' => [ 'base' => NULL, 'refs' => [ 'AacSettings$InputType' => 'Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.Leave set to "normal" when input does not contain pre-mixed audio + AD.', ], ], 'AacProfile' => [ 'base' => NULL, 'refs' => [ 'AacSettings$Profile' => 'AAC Profile.', ], ], 'AacRateControlMode' => [ 'base' => NULL, 'refs' => [ 'AacSettings$RateControlMode' => 'Rate Control Mode.', ], ], 'AacRawFormat' => [ 'base' => NULL, 'refs' => [ 'AacSettings$RawFormat' => 'Sets LATM / LOAS AAC output for raw containers.', ], ], 'AacSettings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$AacSettings' => NULL, ], ], 'AacSpec' => [ 'base' => NULL, 'refs' => [ 'AacSettings$Spec' => 'Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.', ], ], 'AacVbrQuality' => [ 'base' => NULL, 'refs' => [ 'AacSettings$VbrQuality' => 'VBR Quality Level - Only used if rateControlMode is VBR.', ], ], 'Ac3BitstreamMode' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$BitstreamMode' => 'Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.', ], ], 'Ac3CodingMode' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$CodingMode' => 'Dolby Digital coding mode. Determines number of channels.', ], ], 'Ac3DrcProfile' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$DrcProfile' => 'If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.', ], ], 'Ac3LfeFilter' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$LfeFilter' => 'When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.', ], ], 'Ac3MetadataControl' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$MetadataControl' => 'When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.', ], ], 'Ac3Settings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$Ac3Settings' => NULL, ], ], 'AccessDenied' => [ 'base' => NULL, 'refs' => [], ], 'AfdSignaling' => [ 'base' => NULL, 'refs' => [ 'H264Settings$AfdSignaling' => 'Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.', ], ], 'ArchiveContainerSettings' => [ 'base' => NULL, 'refs' => [ 'ArchiveOutputSettings$ContainerSettings' => 'Settings specific to the container type of the file.', ], ], 'ArchiveGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$ArchiveGroupSettings' => NULL, ], ], 'ArchiveOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$ArchiveOutputSettings' => NULL, ], ], 'AribDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$AribDestinationSettings' => NULL, ], ], 'AribSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$AribSourceSettings' => NULL, ], ], 'AudioChannelMapping' => [ 'base' => NULL, 'refs' => [ '__listOfAudioChannelMapping$member' => NULL, ], ], 'AudioCodecSettings' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$CodecSettings' => 'Audio codec settings.', ], ], 'AudioDescription' => [ 'base' => NULL, 'refs' => [ '__listOfAudioDescription$member' => NULL, ], ], 'AudioDescriptionAudioTypeControl' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$AudioTypeControl' => 'Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output.Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.', ], ], 'AudioDescriptionLanguageCodeControl' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$LanguageCodeControl' => 'Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.', ], ], 'AudioLanguageSelection' => [ 'base' => NULL, 'refs' => [ 'AudioSelectorSettings$AudioLanguageSelection' => NULL, ], ], 'AudioLanguageSelectionPolicy' => [ 'base' => NULL, 'refs' => [ 'AudioLanguageSelection$LanguageSelectionPolicy' => 'When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can\'t find one with the same language.', ], ], 'AudioNormalizationAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AudioNormalizationSettings$Algorithm' => 'Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.', ], ], 'AudioNormalizationAlgorithmControl' => [ 'base' => NULL, 'refs' => [ 'AudioNormalizationSettings$AlgorithmControl' => 'When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.', ], ], 'AudioNormalizationSettings' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$AudioNormalizationSettings' => 'Advanced audio normalization settings.', ], ], 'AudioOnlyHlsSettings' => [ 'base' => NULL, 'refs' => [ 'HlsSettings$AudioOnlyHlsSettings' => NULL, ], ], 'AudioOnlyHlsTrackType' => [ 'base' => NULL, 'refs' => [ 'AudioOnlyHlsSettings$AudioTrackType' => 'Four types of audio-only tracks are supported:Audio-Only Variant StreamThe client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.Alternate Audio, Auto Select, DefaultAlternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YESAlternate Audio, Auto Select, Not DefaultAlternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YESAlternate Audio, not Auto SelectAlternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO', ], ], 'AudioPidSelection' => [ 'base' => NULL, 'refs' => [ 'AudioSelectorSettings$AudioPidSelection' => NULL, ], ], 'AudioSelector' => [ 'base' => NULL, 'refs' => [ '__listOfAudioSelector$member' => NULL, ], ], 'AudioSelectorSettings' => [ 'base' => NULL, 'refs' => [ 'AudioSelector$SelectorSettings' => 'The audio selector settings.', ], ], 'AudioType' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$AudioType' => 'Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.', ], ], 'AuthenticationScheme' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$AuthenticationScheme' => 'Authentication scheme to use when connecting with CDN', ], ], 'AvailBlanking' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$AvailBlanking' => 'Settings for ad avail blanking.', ], ], 'AvailBlankingState' => [ 'base' => NULL, 'refs' => [ 'AvailBlanking$State' => 'When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.', ], ], 'AvailConfiguration' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$AvailConfiguration' => 'Event-wide configuration settings for ad avail insertion.', ], ], 'AvailSettings' => [ 'base' => NULL, 'refs' => [ 'AvailConfiguration$AvailSettings' => 'Ad avail settings.', ], ], 'BadGatewayException' => [ 'base' => NULL, 'refs' => [], ], 'BadRequestException' => [ 'base' => NULL, 'refs' => [], ], 'BatchScheduleActionCreateRequest' => [ 'base' => 'A list of schedule actions to create (in a request) or that have been created (in a response).', 'refs' => [ 'BatchUpdateScheduleRequest$Creates' => 'Schedule actions to create in the schedule.', ], ], 'BatchScheduleActionCreateResult' => [ 'base' => 'List of actions that have been created in the schedule.', 'refs' => [ 'BatchUpdateScheduleResult$Creates' => 'Schedule actions created in the schedule.', ], ], 'BatchScheduleActionDeleteRequest' => [ 'base' => 'A list of schedule actions to delete.', 'refs' => [ 'BatchUpdateScheduleRequest$Deletes' => 'Schedule actions to delete from the schedule.', ], ], 'BatchScheduleActionDeleteResult' => [ 'base' => 'List of actions that have been deleted from the schedule.', 'refs' => [ 'BatchUpdateScheduleResult$Deletes' => 'Schedule actions deleted from the schedule.', ], ], 'BatchUpdateScheduleRequest' => [ 'base' => 'A request to create actions (add actions to the schedule), delete actions (remove actions from the schedule), or both create and delete actions.', 'refs' => [], ], 'BatchUpdateScheduleResult' => [ 'base' => 'Results of a batch schedule update.', 'refs' => [], ], 'BlackoutSlate' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$BlackoutSlate' => 'Settings for blackout slate.', ], ], 'BlackoutSlateNetworkEndBlackout' => [ 'base' => NULL, 'refs' => [ 'BlackoutSlate$NetworkEndBlackout' => 'Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".', ], ], 'BlackoutSlateState' => [ 'base' => NULL, 'refs' => [ 'BlackoutSlate$State' => 'When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.', ], ], 'BurnInAlignment' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$Alignment' => 'If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInBackgroundColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$BackgroundColor' => 'Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$BurnInDestinationSettings' => NULL, ], ], 'BurnInFontColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$FontColor' => 'Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInOutlineColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$OutlineColor' => 'Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInShadowColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$ShadowColor' => 'Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInTeletextGridControl' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$TeletextGridControl' => 'Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.', ], ], 'CaptionDescription' => [ 'base' => 'Output groups for this Live Event. Output groups contain information about where streams should be distributed.', 'refs' => [ '__listOfCaptionDescription$member' => NULL, ], ], 'CaptionDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDescription$DestinationSettings' => 'Additional settings for captions destination that depend on the destination type.', ], ], 'CaptionLanguageMapping' => [ 'base' => 'Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.', 'refs' => [ '__listOfCaptionLanguageMapping$member' => NULL, ], ], 'CaptionSelector' => [ 'base' => 'Output groups for this Live Event. Output groups contain information about where streams should be distributed.', 'refs' => [ '__listOfCaptionSelector$member' => NULL, ], ], 'CaptionSelectorSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelector$SelectorSettings' => 'Caption selector settings.', ], ], 'Channel' => [ 'base' => NULL, 'refs' => [ 'CreateChannelResultModel$Channel' => NULL, 'UpdateChannelResultModel$Channel' => NULL, ], ], 'ChannelConfigurationValidationError' => [ 'base' => NULL, 'refs' => [], ], 'ChannelEgressEndpoint' => [ 'base' => NULL, 'refs' => [ '__listOfChannelEgressEndpoint$member' => NULL, ], ], 'ChannelState' => [ 'base' => NULL, 'refs' => [ 'Channel$State' => NULL, 'ChannelSummary$State' => NULL, ], ], 'ChannelSummary' => [ 'base' => NULL, 'refs' => [ '__listOfChannelSummary$member' => NULL, ], ], 'ConflictException' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannel' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannelResultModel' => [ 'base' => NULL, 'refs' => [], ], 'CreateInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInputResultModel' => [ 'base' => NULL, 'refs' => [], ], 'CreateInputSecurityGroupResultModel' => [ 'base' => NULL, 'refs' => [], ], 'DvbNitSettings' => [ 'base' => 'DVB Network Information Table (NIT)', 'refs' => [ 'M2tsSettings$DvbNitSettings' => 'Inserts DVB Network Information Table (NIT) at the specified table repetition interval.', ], ], 'DvbSdtOutputSdt' => [ 'base' => NULL, 'refs' => [ 'DvbSdtSettings$OutputSdt' => 'Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.', ], ], 'DvbSdtSettings' => [ 'base' => 'DVB Service Description Table (SDT)', 'refs' => [ 'M2tsSettings$DvbSdtSettings' => 'Inserts DVB Service Description Table (SDT) at the specified table repetition interval.', ], ], 'DvbSubDestinationAlignment' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$Alignment' => 'If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationBackgroundColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$BackgroundColor' => 'Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationFontColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$FontColor' => 'Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationOutlineColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$OutlineColor' => 'Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$DvbSubDestinationSettings' => NULL, ], ], 'DvbSubDestinationShadowColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$ShadowColor' => 'Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationTeletextGridControl' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$TeletextGridControl' => 'Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.', ], ], 'DvbSubSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$DvbSubSourceSettings' => NULL, ], ], 'DvbTdtSettings' => [ 'base' => 'DVB Time and Date Table (SDT)', 'refs' => [ 'M2tsSettings$DvbTdtSettings' => 'Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.', ], ], 'Eac3AttenuationControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$AttenuationControl' => 'When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.', ], ], 'Eac3BitstreamMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$BitstreamMode' => 'Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.', ], ], 'Eac3CodingMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$CodingMode' => 'Dolby Digital Plus coding mode. Determines number of channels.', ], ], 'Eac3DcFilter' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$DcFilter' => 'When set to enabled, activates a DC highpass filter for all input channels.', ], ], 'Eac3DrcLine' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$DrcLine' => 'Sets the Dolby dynamic range compression profile.', ], ], 'Eac3DrcRf' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$DrcRf' => 'Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.', ], ], 'Eac3LfeControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$LfeControl' => 'When encoding 3/2 audio, setting to lfe enables the LFE channel', ], ], 'Eac3LfeFilter' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$LfeFilter' => 'When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.', ], ], 'Eac3MetadataControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$MetadataControl' => 'When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.', ], ], 'Eac3PassthroughControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$PassthroughControl' => 'When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.', ], ], 'Eac3PhaseControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$PhaseControl' => 'When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.', ], ], 'Eac3Settings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$Eac3Settings' => NULL, ], ], 'Eac3StereoDownmix' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$StereoDownmix' => 'Stereo downmix preference. Only used for 3/2 coding mode.', ], ], 'Eac3SurroundExMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$SurroundExMode' => 'When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.', ], ], 'Eac3SurroundMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$SurroundMode' => 'When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.', ], ], 'EmbeddedConvert608To708' => [ 'base' => NULL, 'refs' => [ 'EmbeddedSourceSettings$Convert608To708' => 'If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.', ], ], 'EmbeddedDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$EmbeddedDestinationSettings' => NULL, ], ], 'EmbeddedPlusScte20DestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$EmbeddedPlusScte20DestinationSettings' => NULL, ], ], 'EmbeddedScte20Detection' => [ 'base' => NULL, 'refs' => [ 'EmbeddedSourceSettings$Scte20Detection' => 'Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.', ], ], 'EmbeddedSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$EmbeddedSourceSettings' => NULL, ], ], 'Empty' => [ 'base' => NULL, 'refs' => [], ], 'EncoderSettings' => [ 'base' => NULL, 'refs' => [ 'Channel$EncoderSettings' => NULL, 'CreateChannel$EncoderSettings' => NULL, 'UpdateChannel$EncoderSettings' => 'The encoder settings for this channel.', ], ], 'FecOutputIncludeFec' => [ 'base' => NULL, 'refs' => [ 'FecOutputSettings$IncludeFec' => 'Enables column only or column and row based FEC', ], ], 'FecOutputSettings' => [ 'base' => NULL, 'refs' => [ 'UdpOutputSettings$FecOutputSettings' => 'Settings for enabling and adjusting Forward Error Correction on UDP outputs.', ], ], 'FixedAfd' => [ 'base' => NULL, 'refs' => [ 'H264Settings$FixedAfd' => 'Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to \'Fixed\'.', ], ], 'FixedModeScheduleActionStartSettings' => [ 'base' => 'Start time for the action.', 'refs' => [ 'ScheduleActionStartSettings$FixedModeScheduleActionStartSettings' => 'Holds the start time for the action.', ], ], 'FollowModeScheduleActionStartSettings' => [ 'base' => 'Settings to specify if an action follows another.', 'refs' => [ 'ScheduleActionStartSettings$FollowModeScheduleActionStartSettings' => 'Specifies an action to follow for scheduling this action.', ], ], 'FollowPoint' => [ 'base' => 'Follow reference point.', 'refs' => [ 'FollowModeScheduleActionStartSettings$FollowPoint' => 'Identifies whether this action starts relative to the start or relative to the end of the reference action.', ], ], 'ForbiddenException' => [ 'base' => NULL, 'refs' => [], ], 'FrameCaptureGroupSettings' => [ 'base' => 'Frame Capture Group Settings', 'refs' => [ 'OutputGroupSettings$FrameCaptureGroupSettings' => NULL, ], ], 'FrameCaptureOutputSettings' => [ 'base' => 'Frame Capture Output Settings', 'refs' => [ 'OutputSettings$FrameCaptureOutputSettings' => NULL, ], ], 'FrameCaptureSettings' => [ 'base' => 'Frame Capture Settings', 'refs' => [ 'VideoCodecSettings$FrameCaptureSettings' => NULL, ], ], 'GatewayTimeoutException' => [ 'base' => NULL, 'refs' => [], ], 'GlobalConfiguration' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$GlobalConfiguration' => 'Configuration settings that apply to the event as a whole.', ], ], 'GlobalConfigurationInputEndAction' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$InputEndAction' => 'Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).', ], ], 'GlobalConfigurationLowFramerateInputs' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$SupportLowFramerateInputs' => 'Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.', ], ], 'GlobalConfigurationOutputTimingSource' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$OutputTimingSource' => 'Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.', ], ], 'H264AdaptiveQuantization' => [ 'base' => NULL, 'refs' => [ 'H264Settings$AdaptiveQuantization' => 'Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.', ], ], 'H264ColorMetadata' => [ 'base' => NULL, 'refs' => [ 'H264Settings$ColorMetadata' => 'Includes colorspace metadata in the output.', ], ], 'H264EntropyEncoding' => [ 'base' => NULL, 'refs' => [ 'H264Settings$EntropyEncoding' => 'Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.', ], ], 'H264FlickerAq' => [ 'base' => NULL, 'refs' => [ 'H264Settings$FlickerAq' => 'If set to enabled, adjust quantization within each frame to reduce flicker or \'pop\' on I-frames.', ], ], 'H264FramerateControl' => [ 'base' => NULL, 'refs' => [ 'H264Settings$FramerateControl' => 'This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.', ], ], 'H264GopBReference' => [ 'base' => NULL, 'refs' => [ 'H264Settings$GopBReference' => 'If enabled, use reference B frames for GOP structures that have B frames > 1.', ], ], 'H264GopSizeUnits' => [ 'base' => NULL, 'refs' => [ 'H264Settings$GopSizeUnits' => 'Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.', ], ], 'H264Level' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Level' => 'H.264 Level.', ], ], 'H264LookAheadRateControl' => [ 'base' => NULL, 'refs' => [ 'H264Settings$LookAheadRateControl' => 'Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.', ], ], 'H264ParControl' => [ 'base' => NULL, 'refs' => [ 'H264Settings$ParControl' => 'This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.', ], ], 'H264Profile' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Profile' => 'H.264 Profile.', ], ], 'H264RateControlMode' => [ 'base' => NULL, 'refs' => [ 'H264Settings$RateControlMode' => 'Rate control mode.QVBR: Quality will match the specified quality level except when it is constrained by themaximum bitrate. Recommended if you or your viewers pay for bandwidth.VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBRif you want to maintain a specific average bitrate over the duration of the channel.CBR: Quality varies, depending on the video complexity. Recommended only if you distributeyour assets to devices that cannot handle variable bitrates.', ], ], 'H264ScanType' => [ 'base' => NULL, 'refs' => [ 'H264Settings$ScanType' => 'Sets the scan type of the output to progressive or top-field-first interlaced.', ], ], 'H264SceneChangeDetect' => [ 'base' => NULL, 'refs' => [ 'H264Settings$SceneChangeDetect' => 'Scene change detection.- On: inserts I-frames when scene change is detected.- Off: does not force an I-frame when scene change is detected.', ], ], 'H264Settings' => [ 'base' => NULL, 'refs' => [ 'VideoCodecSettings$H264Settings' => NULL, ], ], 'H264SpatialAq' => [ 'base' => NULL, 'refs' => [ 'H264Settings$SpatialAq' => 'If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.', ], ], 'H264SubGopLength' => [ 'base' => NULL, 'refs' => [ 'H264Settings$SubgopLength' => 'If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.', ], ], 'H264Syntax' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Syntax' => 'Produces a bitstream compliant with SMPTE RP-2027.', ], ], 'H264TemporalAq' => [ 'base' => NULL, 'refs' => [ 'H264Settings$TemporalAq' => 'If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.', ], ], 'H264TimecodeInsertionBehavior' => [ 'base' => NULL, 'refs' => [ 'H264Settings$TimecodeInsertion' => 'Determines how timecodes should be inserted into the video elementary stream.- \'disabled\': Do not include timecodes- \'picTimingSei\': Pass through picture timing SEI messages from the source specified in Timecode Config', ], ], 'HlsAdMarkers' => [ 'base' => NULL, 'refs' => [ '__listOfHlsAdMarkers$member' => NULL, ], ], 'HlsAkamaiHttpTransferMode' => [ 'base' => NULL, 'refs' => [ 'HlsAkamaiSettings$HttpTransferMode' => 'Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.', ], ], 'HlsAkamaiSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsAkamaiSettings' => NULL, ], ], 'HlsBasicPutSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsBasicPutSettings' => NULL, ], ], 'HlsCaptionLanguageSetting' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$CaptionLanguageSetting' => 'Applies only to 608 Embedded output captions.insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.none: Include CLOSED-CAPTIONS=NONE line in the manifest.omit: Omit any CLOSED-CAPTIONS line from the manifest.', ], ], 'HlsCdnSettings' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$HlsCdnSettings' => 'Parameters that control interactions with the CDN.', ], ], 'HlsClientCache' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ClientCache' => 'When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.', ], ], 'HlsCodecSpecification' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$CodecSpecification' => 'Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.', ], ], 'HlsDirectoryStructure' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$DirectoryStructure' => 'Place segments in subdirectories.', ], ], 'HlsEncryptionType' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$EncryptionType' => 'Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.', ], ], 'HlsGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$HlsGroupSettings' => NULL, ], ], 'HlsInputSettings' => [ 'base' => NULL, 'refs' => [ 'NetworkInputSettings$HlsInputSettings' => 'Specifies HLS input settings when the uri is for a HLS manifest.', ], ], 'HlsIvInManifest' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$IvInManifest' => 'For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.', ], ], 'HlsIvSource' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$IvSource' => 'For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.', ], ], 'HlsManifestCompression' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ManifestCompression' => 'When set to gzip, compresses HLS playlist.', ], ], 'HlsManifestDurationFormat' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ManifestDurationFormat' => 'Indicates whether the output manifest should use floating point or integer values for segment duration.', ], ], 'HlsMediaStoreSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsMediaStoreSettings' => NULL, ], ], 'HlsMediaStoreStorageClass' => [ 'base' => NULL, 'refs' => [ 'HlsMediaStoreSettings$MediaStoreStorageClass' => 'When set to temporal, output files are stored in non-persistent memory for faster reading and writing.', ], ], 'HlsMode' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$Mode' => 'If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.', ], ], 'HlsOutputSelection' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$OutputSelection' => 'MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.SEGMENTSONLY: Does not generate any manifests for this output group.', ], ], 'HlsOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$HlsOutputSettings' => NULL, ], ], 'HlsProgramDateTime' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ProgramDateTime' => 'Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.', ], ], 'HlsRedundantManifest' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$RedundantManifest' => 'When set to "enabled", includes the media playlists from both pipelines in the master manifest (.m3u8) file.', ], ], 'HlsSegmentationMode' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$SegmentationMode' => 'useInputSegmentation has been deprecated. The configured segment size is always used.', ], ], 'HlsSettings' => [ 'base' => NULL, 'refs' => [ 'HlsOutputSettings$HlsSettings' => 'Settings regarding the underlying stream. These settings are different for audio-only outputs.', ], ], 'HlsStreamInfResolution' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$StreamInfResolution' => 'Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.', ], ], 'HlsTimedMetadataId3Frame' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$TimedMetadataId3Frame' => 'Indicates ID3 frame that has the timecode.', ], ], 'HlsTimedMetadataScheduleActionSettings' => [ 'base' => 'Settings for the action to emit HLS metadata', 'refs' => [ 'ScheduleActionSettings$HlsTimedMetadataSettings' => 'Action to insert HLS metadata', ], ], 'HlsTsFileMode' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$TsFileMode' => 'SEGMENTEDFILES: Emit the program as segments - multiple .ts media files.SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.', ], ], 'HlsWebdavHttpTransferMode' => [ 'base' => NULL, 'refs' => [ 'HlsWebdavSettings$HttpTransferMode' => 'Specify whether or not to use chunked transfer encoding to WebDAV.', ], ], 'HlsWebdavSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsWebdavSettings' => NULL, ], ], 'IFrameOnlyPlaylistType' => [ 'base' => 'When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.', 'refs' => [ 'HlsGroupSettings$IFrameOnlyPlaylists' => 'DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"', ], ], 'Input' => [ 'base' => NULL, 'refs' => [ 'CreateInputResultModel$Input' => NULL, 'UpdateInputResultModel$Input' => NULL, '__listOfInput$member' => NULL, ], ], 'InputAttachment' => [ 'base' => NULL, 'refs' => [ '__listOfInputAttachment$member' => NULL, ], ], 'InputChannelLevel' => [ 'base' => NULL, 'refs' => [ '__listOfInputChannelLevel$member' => NULL, ], ], 'InputCodec' => [ 'base' => 'codec in increasing order of complexity', 'refs' => [ 'InputSpecification$Codec' => 'Input codec', ], ], 'InputDeblockFilter' => [ 'base' => NULL, 'refs' => [ 'InputSettings$DeblockFilter' => 'Enable or disable the deblock filter when filtering.', ], ], 'InputDenoiseFilter' => [ 'base' => NULL, 'refs' => [ 'InputSettings$DenoiseFilter' => 'Enable or disable the denoise filter when filtering.', ], ], 'InputDestination' => [ 'base' => 'The settings for a PUSH type input.', 'refs' => [ '__listOfInputDestination$member' => NULL, ], ], 'InputDestinationRequest' => [ 'base' => 'Endpoint settings for a PUSH type input.', 'refs' => [ '__listOfInputDestinationRequest$member' => NULL, ], ], 'InputDestinationVpc' => [ 'base' => 'The properties for a VPC type input destination.', 'refs' => [ 'InputDestination$Vpc' => NULL, ], ], 'InputFilter' => [ 'base' => NULL, 'refs' => [ 'InputSettings$InputFilter' => 'Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.1) auto - filtering will be applied depending on input type/quality2) disabled - no filtering will be applied to the input3) forced - filtering will be applied regardless of input type', ], ], 'InputLocation' => [ 'base' => NULL, 'refs' => [ 'AudioOnlyHlsSettings$AudioOnlyImage' => 'For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}.', 'AvailBlanking$AvailBlankingImage' => 'Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.', 'BlackoutSlate$BlackoutSlateImage' => 'Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.', 'BlackoutSlate$NetworkEndBlackoutImage' => 'Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.', 'BurnInDestinationSettings$Font' => 'External font file used for caption burn-in. File extension must be \'ttf\' or \'tte\'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$Font' => 'External font file used for caption burn-in. File extension must be \'ttf\' or \'tte\'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.', 'InputLossBehavior$InputLossImageSlate' => 'When input loss image type is "slate" these fields specify the parameters for accessing the slate.', 'StaticImageActivateScheduleActionSettings$Image' => 'The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.', 'StaticKeySettings$KeyProviderServer' => 'The URL of the license server used for protecting content.', ], ], 'InputLossActionForHlsOut' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$InputLossAction' => 'Parameter that control output group behavior on input loss.', ], ], 'InputLossActionForMsSmoothOut' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$InputLossAction' => 'Parameter that control output group behavior on input loss.', ], ], 'InputLossActionForRtmpOut' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$InputLossAction' => 'Controls the behavior of this RTMP group if input becomes unavailable.- emitOutput: Emit a slate until input returns.- pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.', ], ], 'InputLossActionForUdpOut' => [ 'base' => NULL, 'refs' => [ 'UdpGroupSettings$InputLossAction' => 'Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.', ], ], 'InputLossBehavior' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$InputLossBehavior' => 'Settings for system actions when input is lost.', ], ], 'InputLossImageType' => [ 'base' => NULL, 'refs' => [ 'InputLossBehavior$InputLossImageType' => 'Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.', ], ], 'InputMaximumBitrate' => [ 'base' => 'Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.', 'refs' => [ 'InputSpecification$MaximumBitrate' => 'Maximum input bitrate, categorized coarsely', ], ], 'InputResolution' => [ 'base' => 'Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines', 'refs' => [ 'InputSpecification$Resolution' => 'Input resolution, categorized coarsely', ], ], 'InputSecurityGroup' => [ 'base' => 'An Input Security Group', 'refs' => [ 'CreateInputSecurityGroupResultModel$SecurityGroup' => NULL, 'UpdateInputSecurityGroupResultModel$SecurityGroup' => NULL, '__listOfInputSecurityGroup$member' => NULL, ], ], 'InputSecurityGroupState' => [ 'base' => NULL, 'refs' => [ 'InputSecurityGroup$State' => 'The current state of the Input Security Group.', ], ], 'InputSecurityGroupWhitelistRequest' => [ 'base' => 'Request of IPv4 CIDR addresses to whitelist in a security group.', 'refs' => [], ], 'InputSettings' => [ 'base' => 'Live Event input parameters. There can be multiple inputs in a single Live Event.', 'refs' => [ 'InputAttachment$InputSettings' => 'Settings of an input (caption selector, etc.)', ], ], 'InputSource' => [ 'base' => 'The settings for a PULL type input.', 'refs' => [ '__listOfInputSource$member' => NULL, ], ], 'InputSourceEndBehavior' => [ 'base' => NULL, 'refs' => [ 'InputSettings$SourceEndBehavior' => 'Loop input if it is a file. This allows a file input to be streamed indefinitely.', ], ], 'InputSourceRequest' => [ 'base' => 'Settings for for a PULL type input.', 'refs' => [ '__listOfInputSourceRequest$member' => NULL, ], ], 'InputSpecification' => [ 'base' => NULL, 'refs' => [ 'Channel$InputSpecification' => NULL, 'ChannelSummary$InputSpecification' => NULL, 'CreateChannel$InputSpecification' => 'Specification of input for this channel (max. bitrate, resolution, codec, etc.)', 'UpdateChannel$InputSpecification' => 'Specification of input for this channel (max. bitrate, resolution, codec, etc.)', ], ], 'InputState' => [ 'base' => NULL, 'refs' => [ 'Input$State' => NULL, ], ], 'InputSwitchScheduleActionSettings' => [ 'base' => 'Settings for the action to switch an input.', 'refs' => [ 'ScheduleActionSettings$InputSwitchSettings' => 'Action to switch the input', ], ], 'InputType' => [ 'base' => NULL, 'refs' => [ 'CreateInput$Type' => NULL, 'Input$Type' => NULL, ], ], 'InputVpcRequest' => [ 'base' => 'Settings for a private VPC Input.When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.This property requires setting the roleArn property on Input creation.Not compatible with the inputSecurityGroups property.', 'refs' => [ 'CreateInput$Vpc' => NULL, ], ], 'InputWhitelistRule' => [ 'base' => 'Whitelist rule', 'refs' => [ '__listOfInputWhitelistRule$member' => NULL, ], ], 'InputWhitelistRuleCidr' => [ 'base' => 'An IPv4 CIDR to whitelist.', 'refs' => [ '__listOfInputWhitelistRuleCidr$member' => NULL, ], ], 'InternalServerErrorException' => [ 'base' => NULL, 'refs' => [], ], 'InternalServiceError' => [ 'base' => NULL, 'refs' => [], ], 'InvalidRequest' => [ 'base' => NULL, 'refs' => [], ], 'KeyProviderSettings' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$KeyProviderSettings' => 'The key provider settings.', ], ], 'LimitExceeded' => [ 'base' => NULL, 'refs' => [], ], 'ListInputSecurityGroupsResultModel' => [ 'base' => 'Result of input security group list request', 'refs' => [], ], 'ListInputsResultModel' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingsResultModel' => [ 'base' => 'ListOfferings response', 'refs' => [], ], 'ListReservationsResultModel' => [ 'base' => 'ListReservations response', 'refs' => [], ], 'LogLevel' => [ 'base' => 'The log level the user wants for their channel.', 'refs' => [ 'Channel$LogLevel' => 'The log level being written to CloudWatch Logs.', 'ChannelSummary$LogLevel' => 'The log level being written to CloudWatch Logs.', 'CreateChannel$LogLevel' => 'The log level to write to CloudWatch Logs.', 'UpdateChannel$LogLevel' => 'The log level to write to CloudWatch Logs.', ], ], 'M2tsAbsentInputAudioBehavior' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AbsentInputAudioBehavior' => 'When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.', ], ], 'M2tsArib' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Arib' => 'When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.', ], ], 'M2tsAribCaptionsPidControl' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AribCaptionsPidControl' => 'If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.', ], ], 'M2tsAudioBufferModel' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AudioBufferModel' => 'When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.', ], ], 'M2tsAudioInterval' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EbpAudioInterval' => 'When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.', ], ], 'M2tsAudioStreamType' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AudioStreamType' => 'When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.', ], ], 'M2tsBufferModel' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$BufferModel' => 'If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.', ], ], 'M2tsCcDescriptor' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$CcDescriptor' => 'When set to enabled, generates captionServiceDescriptor in PMT.', ], ], 'M2tsEbifControl' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Ebif' => 'If set to passthrough, passes any EBIF data from the input source to this output.', ], ], 'M2tsEbpPlacement' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EbpPlacement' => 'Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.', ], ], 'M2tsEsRateInPes' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EsRateInPes' => 'Include or exclude the ES Rate field in the PES header.', ], ], 'M2tsKlv' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Klv' => 'If set to passthrough, passes any KLV data from the input source to this output.', ], ], 'M2tsPcrControl' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$PcrControl' => 'When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.', ], ], 'M2tsRateMode' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$RateMode' => 'When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.', ], ], 'M2tsScte35Control' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Scte35Control' => 'Optionally pass SCTE-35 signals from the input source to this output.', ], ], 'M2tsSegmentationMarkers' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$SegmentationMarkers' => 'Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.', ], ], 'M2tsSegmentationStyle' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$SegmentationStyle' => 'The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.', ], ], 'M2tsSettings' => [ 'base' => NULL, 'refs' => [ 'ArchiveContainerSettings$M2tsSettings' => NULL, 'UdpContainerSettings$M2tsSettings' => NULL, ], ], 'M2tsTimedMetadataBehavior' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$TimedMetadataBehavior' => 'When set to passthrough, timed metadata will be passed through from input to output.', ], ], 'M3u8PcrControl' => [ 'base' => NULL, 'refs' => [ 'M3u8Settings$PcrControl' => 'When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.', ], ], 'M3u8Scte35Behavior' => [ 'base' => NULL, 'refs' => [ 'M3u8Settings$Scte35Behavior' => 'If set to passthrough, passes any SCTE-35 signals from the input source to this output.', ], ], 'M3u8Settings' => [ 'base' => 'Settings information for the .m3u8 container', 'refs' => [ 'StandardHlsSettings$M3u8Settings' => NULL, ], ], 'M3u8TimedMetadataBehavior' => [ 'base' => NULL, 'refs' => [ 'M3u8Settings$TimedMetadataBehavior' => 'When set to passthrough, timed metadata is passed through from input to output.', ], ], 'MediaConnectFlow' => [ 'base' => 'The settings for a MediaConnect Flow.', 'refs' => [ '__listOfMediaConnectFlow$member' => NULL, ], ], 'MediaConnectFlowRequest' => [ 'base' => 'The settings for a MediaConnect Flow.', 'refs' => [ '__listOfMediaConnectFlowRequest$member' => NULL, ], ], 'Mp2CodingMode' => [ 'base' => NULL, 'refs' => [ 'Mp2Settings$CodingMode' => 'The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).', ], ], 'Mp2Settings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$Mp2Settings' => NULL, ], ], 'MsSmoothGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$MsSmoothGroupSettings' => NULL, ], ], 'MsSmoothOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$MsSmoothOutputSettings' => NULL, ], ], 'NetworkInputServerValidation' => [ 'base' => NULL, 'refs' => [ 'NetworkInputSettings$ServerValidation' => 'Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server\'s name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate\'s wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.', ], ], 'NetworkInputSettings' => [ 'base' => 'Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.', 'refs' => [ 'InputSettings$NetworkInputSettings' => 'Input settings.', ], ], 'NotFoundException' => [ 'base' => NULL, 'refs' => [], ], 'Offering' => [ 'base' => 'Reserved resources available for purchase', 'refs' => [ '__listOfOffering$member' => NULL, ], ], 'OfferingDurationUnits' => [ 'base' => 'Units for duration, e.g. \'MONTHS\'', 'refs' => [ 'Offering$DurationUnits' => 'Units for duration, e.g. \'MONTHS\'', 'Reservation$DurationUnits' => 'Units for duration, e.g. \'MONTHS\'', ], ], 'OfferingType' => [ 'base' => 'Offering type, e.g. \'NO_UPFRONT\'', 'refs' => [ 'Offering$OfferingType' => 'Offering type, e.g. \'NO_UPFRONT\'', 'Reservation$OfferingType' => 'Offering type, e.g. \'NO_UPFRONT\'', ], ], 'Output' => [ 'base' => 'Output settings. There can be multiple outputs within a group.', 'refs' => [ '__listOfOutput$member' => NULL, ], ], 'OutputDestination' => [ 'base' => NULL, 'refs' => [ '__listOfOutputDestination$member' => NULL, ], ], 'OutputDestinationSettings' => [ 'base' => NULL, 'refs' => [ '__listOfOutputDestinationSettings$member' => NULL, ], ], 'OutputGroup' => [ 'base' => 'Output groups for this Live Event. Output groups contain information about where streams should be distributed.', 'refs' => [ '__listOfOutputGroup$member' => NULL, ], ], 'OutputGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroup$OutputGroupSettings' => 'Settings associated with the output group.', ], ], 'OutputLocationRef' => [ 'base' => 'Reference to an OutputDestination ID defined in the channel', 'refs' => [ 'ArchiveGroupSettings$Destination' => 'A directory and base filename where archive files should be written.', 'FrameCaptureGroupSettings$Destination' => 'The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg', 'HlsGroupSettings$Destination' => 'A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).', 'MsSmoothGroupSettings$Destination' => 'Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.', 'RtmpOutputSettings$Destination' => 'The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.', 'UdpOutputSettings$Destination' => 'Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).', ], ], 'OutputSettings' => [ 'base' => NULL, 'refs' => [ 'Output$OutputSettings' => 'Output type-specific settings.', ], ], 'PassThroughSettings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$PassThroughSettings' => NULL, ], ], 'PauseStateScheduleActionSettings' => [ 'base' => 'Settings for the action to set pause state of a channel.', 'refs' => [ 'ScheduleActionSettings$PauseStateSettings' => 'Action to pause or unpause one or both channel pipelines', ], ], 'PipelineId' => [ 'base' => 'Pipeline ID', 'refs' => [ 'PipelinePauseStateSettings$PipelineId' => 'Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").', ], ], 'PipelinePauseStateSettings' => [ 'base' => 'Settings for pausing a pipeline.', 'refs' => [ '__listOfPipelinePauseStateSettings$member' => NULL, ], ], 'PurchaseOffering' => [ 'base' => 'PurchaseOffering request', 'refs' => [], ], 'PurchaseOfferingResultModel' => [ 'base' => 'PurchaseOffering response', 'refs' => [], ], 'RemixSettings' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$RemixSettings' => 'Settings that control how input audio channels are remixed into the output audio channels.', ], ], 'Reservation' => [ 'base' => 'Reserved resources available to use', 'refs' => [ 'PurchaseOfferingResultModel$Reservation' => NULL, '__listOfReservation$member' => NULL, ], ], 'ReservationCodec' => [ 'base' => 'Codec, \'MPEG2\', \'AVC\', \'HEVC\', or \'AUDIO\'', 'refs' => [ 'ReservationResourceSpecification$Codec' => 'Codec, e.g. \'AVC\'', ], ], 'ReservationMaximumBitrate' => [ 'base' => 'Maximum bitrate in megabits per second', 'refs' => [ 'ReservationResourceSpecification$MaximumBitrate' => 'Maximum bitrate, e.g. \'MAX_20_MBPS\'', ], ], 'ReservationMaximumFramerate' => [ 'base' => 'Maximum framerate in frames per second (Outputs only)', 'refs' => [ 'ReservationResourceSpecification$MaximumFramerate' => 'Maximum framerate, e.g. \'MAX_30_FPS\' (Outputs only)', ], ], 'ReservationResolution' => [ 'base' => 'Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines', 'refs' => [ 'ReservationResourceSpecification$Resolution' => 'Resolution, e.g. \'HD\'', ], ], 'ReservationResourceSpecification' => [ 'base' => 'Resource configuration (codec, resolution, bitrate, ...)', 'refs' => [ 'Offering$ResourceSpecification' => 'Resource configuration details', 'Reservation$ResourceSpecification' => 'Resource configuration details', ], ], 'ReservationResourceType' => [ 'base' => 'Resource type, \'INPUT\', \'OUTPUT\', or \'CHANNEL\'', 'refs' => [ 'ReservationResourceSpecification$ResourceType' => 'Resource type, \'INPUT\', \'OUTPUT\', or \'CHANNEL\'', ], ], 'ReservationSpecialFeature' => [ 'base' => 'Special features, \'ADVANCED_AUDIO\' or \'AUDIO_NORMALIZATION\'', 'refs' => [ 'ReservationResourceSpecification$SpecialFeature' => 'Special feature, e.g. \'AUDIO_NORMALIZATION\' (Channels only)', ], ], 'ReservationState' => [ 'base' => 'Current reservation state', 'refs' => [ 'Reservation$State' => 'Current state of reservation, e.g. \'ACTIVE\'', ], ], 'ReservationVideoQuality' => [ 'base' => 'Video quality, e.g. \'STANDARD\' (Outputs only)', 'refs' => [ 'ReservationResourceSpecification$VideoQuality' => 'Video quality, e.g. \'STANDARD\' (Outputs only)', ], ], 'ResourceConflict' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFound' => [ 'base' => NULL, 'refs' => [], ], 'RtmpCacheFullBehavior' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$CacheFullBehavior' => 'Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the \'Media Cache\' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.', ], ], 'RtmpCaptionData' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$CaptionData' => 'Controls the types of data that passes to onCaptionInfo outputs. If set to \'all\' then 608 and 708 carried DTVCC data will be passed. If set to \'field1AndField2608\' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to \'field1608\' then only the data carried in 608 from field 1 video will be passed.', ], ], 'RtmpCaptionInfoDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$RtmpCaptionInfoDestinationSettings' => NULL, ], ], 'RtmpGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$RtmpGroupSettings' => NULL, ], ], 'RtmpOutputCertificateMode' => [ 'base' => NULL, 'refs' => [ 'RtmpOutputSettings$CertificateMode' => 'If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.', ], ], 'RtmpOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$RtmpOutputSettings' => NULL, ], ], 'ScheduleAction' => [ 'base' => 'Contains information on a single schedule action.', 'refs' => [ '__listOfScheduleAction$member' => NULL, ], ], 'ScheduleActionSettings' => [ 'base' => 'Holds the settings for a single schedule action.', 'refs' => [ 'ScheduleAction$ScheduleActionSettings' => 'Settings for this schedule action.', ], ], 'ScheduleActionStartSettings' => [ 'base' => 'Settings to specify the start time for an action.', 'refs' => [ 'ScheduleAction$ScheduleActionStartSettings' => 'The time for the action to start in the channel.', ], ], 'ScheduleDescribeResultModel' => [ 'base' => 'Results of a schedule describe.', 'refs' => [], ], 'Scte20Convert608To708' => [ 'base' => NULL, 'refs' => [ 'Scte20SourceSettings$Convert608To708' => 'If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.', ], ], 'Scte20PlusEmbeddedDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$Scte20PlusEmbeddedDestinationSettings' => NULL, ], ], 'Scte20SourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$Scte20SourceSettings' => NULL, ], ], 'Scte27DestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$Scte27DestinationSettings' => NULL, ], ], 'Scte27SourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$Scte27SourceSettings' => NULL, ], ], 'Scte35AposNoRegionalBlackoutBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35TimeSignalApos$NoRegionalBlackoutFlag' => 'When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35AposWebDeliveryAllowedBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35TimeSignalApos$WebDeliveryAllowedFlag' => 'When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35ArchiveAllowedFlag' => [ 'base' => 'Corresponds to the archive_allowed parameter. A value of ARCHIVE_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$ArchiveAllowedFlag' => 'Corresponds to SCTE-35 archive_allowed_flag.', ], ], 'Scte35DeliveryRestrictions' => [ 'base' => 'Corresponds to SCTE-35 delivery_not_restricted_flag parameter. To declare delivery restrictions, include this element and its four "restriction" flags. To declare that there are no restrictions, omit this element.', 'refs' => [ 'Scte35SegmentationDescriptor$DeliveryRestrictions' => 'Holds the four SCTE-35 delivery restriction parameters.', ], ], 'Scte35Descriptor' => [ 'base' => 'Holds one set of SCTE-35 Descriptor Settings.', 'refs' => [ '__listOfScte35Descriptor$member' => NULL, ], ], 'Scte35DescriptorSettings' => [ 'base' => 'SCTE-35 Descriptor settings.', 'refs' => [ 'Scte35Descriptor$Scte35DescriptorSettings' => 'SCTE-35 Descriptor Settings.', ], ], 'Scte35DeviceRestrictions' => [ 'base' => 'Corresponds to the device_restrictions parameter in a segmentation_descriptor. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$DeviceRestrictions' => 'Corresponds to SCTE-35 device_restrictions parameter.', ], ], 'Scte35NoRegionalBlackoutFlag' => [ 'base' => 'Corresponds to the no_regional_blackout_flag parameter. A value of REGIONAL_BLACKOUT corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$NoRegionalBlackoutFlag' => 'Corresponds to SCTE-35 no_regional_blackout_flag parameter.', ], ], 'Scte35ReturnToNetworkScheduleActionSettings' => [ 'base' => 'Settings for a SCTE-35 return_to_network message.', 'refs' => [ 'ScheduleActionSettings$Scte35ReturnToNetworkSettings' => 'Action to insert SCTE-35 return_to_network message', ], ], 'Scte35SegmentationCancelIndicator' => [ 'base' => 'Corresponds to SCTE-35 segmentation_event_cancel_indicator. SEGMENTATION_EVENT_NOT_CANCELED corresponds to 0 in the SCTE-35 specification and indicates that this is an insertion request. SEGMENTATION_EVENT_CANCELED corresponds to 1 in the SCTE-35 specification and indicates that this is a cancelation request, in which case complete this field and the existing event ID to cancel.', 'refs' => [ 'Scte35SegmentationDescriptor$SegmentationCancelIndicator' => 'Corresponds to SCTE-35 segmentation_event_cancel_indicator.', ], ], 'Scte35SegmentationDescriptor' => [ 'base' => 'Corresponds to SCTE-35 segmentation_descriptor.', 'refs' => [ 'Scte35DescriptorSettings$SegmentationDescriptorScte35DescriptorSettings' => 'SCTE-35 Segmentation Descriptor.', ], ], 'Scte35SpliceInsert' => [ 'base' => NULL, 'refs' => [ 'AvailSettings$Scte35SpliceInsert' => NULL, ], ], 'Scte35SpliceInsertNoRegionalBlackoutBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsert$NoRegionalBlackoutFlag' => 'When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35SpliceInsertScheduleActionSettings' => [ 'base' => 'Settings for a SCTE-35 splice_insert message.', 'refs' => [ 'ScheduleActionSettings$Scte35SpliceInsertSettings' => 'Action to insert SCTE-35 splice_insert message', ], ], 'Scte35SpliceInsertWebDeliveryAllowedBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsert$WebDeliveryAllowedFlag' => 'When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35TimeSignalApos' => [ 'base' => NULL, 'refs' => [ 'AvailSettings$Scte35TimeSignalApos' => NULL, ], ], 'Scte35TimeSignalScheduleActionSettings' => [ 'base' => 'Settings for a SCTE-35 time_signal.', 'refs' => [ 'ScheduleActionSettings$Scte35TimeSignalSettings' => 'Action to insert SCTE-35 time_signal message', ], ], 'Scte35WebDeliveryAllowedFlag' => [ 'base' => 'Corresponds to the web_delivery_allowed_flag parameter. A value of WEB_DELIVERY_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$WebDeliveryAllowedFlag' => 'Corresponds to SCTE-35 web_delivery_allowed_flag parameter.', ], ], 'SmoothGroupAudioOnlyTimecodeControl' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$AudioOnlyTimecodeControl' => 'If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.', ], ], 'SmoothGroupCertificateMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$CertificateMode' => 'If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.', ], ], 'SmoothGroupEventIdMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$EventIdMode' => 'Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.Options:- "useConfigured" - use the value provided in eventId- "useTimestamp" - generate and send an event ID based on the current timestamp- "noEventId" - do not send an event ID to the IIS server.', ], ], 'SmoothGroupEventStopBehavior' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$EventStopBehavior' => 'When set to sendEos, send EOS signal to IIS server when stopping the event', ], ], 'SmoothGroupSegmentationMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$SegmentationMode' => 'useInputSegmentation has been deprecated. The configured segment size is always used.', ], ], 'SmoothGroupSparseTrackType' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$SparseTrackType' => 'If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.', ], ], 'SmoothGroupStreamManifestBehavior' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$StreamManifestBehavior' => 'When set to send, send stream manifest so publishing point doesn\'t start until all streams start.', ], ], 'SmoothGroupTimestampOffsetMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$TimestampOffsetMode' => 'Type of timestamp date offset to use.- useEventStartDate: Use the date the event was started as the offset- useConfiguredOffset: Use an explicitly configured date as the offset', ], ], 'SmpteTtDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$SmpteTtDestinationSettings' => NULL, ], ], 'StandardHlsSettings' => [ 'base' => NULL, 'refs' => [ 'HlsSettings$StandardHlsSettings' => NULL, ], ], 'StaticImageActivateScheduleActionSettings' => [ 'base' => 'Settings for the action to activate a static image.', 'refs' => [ 'ScheduleActionSettings$StaticImageActivateSettings' => 'Action to activate a static image overlay', ], ], 'StaticImageDeactivateScheduleActionSettings' => [ 'base' => 'Settings for the action to deactivate the image in a specific layer.', 'refs' => [ 'ScheduleActionSettings$StaticImageDeactivateSettings' => 'Action to deactivate a static image overlay', ], ], 'StaticKeySettings' => [ 'base' => NULL, 'refs' => [ 'KeyProviderSettings$StaticKeySettings' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'Channel$Tags' => 'A collection of key-value pairs.', 'ChannelSummary$Tags' => 'A collection of key-value pairs.', 'CreateChannel$Tags' => 'A collection of key-value pairs.', 'CreateInput$Tags' => 'A collection of key-value pairs.', 'Input$Tags' => 'A collection of key-value pairs.', 'InputSecurityGroup$Tags' => 'A collection of key-value pairs.', 'InputSecurityGroupWhitelistRequest$Tags' => 'A collection of key-value pairs.', 'TagsModel$Tags' => NULL, ], ], 'TagsModel' => [ 'base' => NULL, 'refs' => [], ], 'TeletextDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$TeletextDestinationSettings' => NULL, ], ], 'TeletextSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$TeletextSourceSettings' => NULL, ], ], 'TimecodeConfig' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$TimecodeConfig' => 'Contains settings used to acquire and adjust timecode information from inputs.', ], ], 'TimecodeConfigSource' => [ 'base' => NULL, 'refs' => [ 'TimecodeConfig$Source' => 'Identifies the source for the timecode that will be associated with the events outputs.-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased).-System Clock (systemclock): Use the UTC time.-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.', ], ], 'TooManyRequestsException' => [ 'base' => NULL, 'refs' => [], ], 'TtmlDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$TtmlDestinationSettings' => NULL, ], ], 'TtmlDestinationStyleControl' => [ 'base' => NULL, 'refs' => [ 'TtmlDestinationSettings$StyleControl' => 'When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.', ], ], 'UdpContainerSettings' => [ 'base' => NULL, 'refs' => [ 'UdpOutputSettings$ContainerSettings' => NULL, ], ], 'UdpGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$UdpGroupSettings' => NULL, ], ], 'UdpOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$UdpOutputSettings' => NULL, ], ], 'UdpTimedMetadataId3Frame' => [ 'base' => NULL, 'refs' => [ 'UdpGroupSettings$TimedMetadataId3Frame' => 'Indicates ID3 frame that has the timecode.', ], ], 'UnprocessableEntityException' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannel' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannelResultModel' => [ 'base' => 'The updated channel\'s description.', 'refs' => [], ], 'UpdateInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInputResultModel' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInputSecurityGroupResultModel' => [ 'base' => NULL, 'refs' => [], ], 'ValidationError' => [ 'base' => NULL, 'refs' => [ '__listOfValidationError$member' => NULL, ], ], 'VideoCodecSettings' => [ 'base' => NULL, 'refs' => [ 'VideoDescription$CodecSettings' => 'Video codec settings.', ], ], 'VideoDescription' => [ 'base' => 'Video settings for this stream.', 'refs' => [ '__listOfVideoDescription$member' => NULL, ], ], 'VideoDescriptionRespondToAfd' => [ 'base' => NULL, 'refs' => [ 'VideoDescription$RespondToAfd' => 'Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.', ], ], 'VideoDescriptionScalingBehavior' => [ 'base' => NULL, 'refs' => [ 'VideoDescription$ScalingBehavior' => 'STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.', ], ], 'VideoSelector' => [ 'base' => 'Specifies a particular video stream within an input source. An input may have only a single video selector.', 'refs' => [ 'InputSettings$VideoSelector' => 'Informs which video elementary stream to decode for input types that have multiple available.', ], ], 'VideoSelectorColorSpace' => [ 'base' => NULL, 'refs' => [ 'VideoSelector$ColorSpace' => 'Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed.', ], ], 'VideoSelectorColorSpaceUsage' => [ 'base' => NULL, 'refs' => [ 'VideoSelector$ColorSpaceUsage' => 'Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.', ], ], 'VideoSelectorPid' => [ 'base' => NULL, 'refs' => [ 'VideoSelectorSettings$VideoSelectorPid' => NULL, ], ], 'VideoSelectorProgramId' => [ 'base' => NULL, 'refs' => [ 'VideoSelectorSettings$VideoSelectorProgramId' => NULL, ], ], 'VideoSelectorSettings' => [ 'base' => NULL, 'refs' => [ 'VideoSelector$SelectorSettings' => 'The video selector settings.', ], ], 'WebvttDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$WebvttDestinationSettings' => NULL, ], ], '__double' => [ 'base' => NULL, 'refs' => [ 'AacSettings$Bitrate' => 'Average bitrate in bits/second. Valid values depend on rate control mode and profile.', 'AacSettings$SampleRate' => 'Sample rate in Hz. Valid values depend on rate control mode and profile.', 'Ac3Settings$Bitrate' => 'Average bitrate in bits/second. Valid bitrates depend on the coding mode.', 'Eac3Settings$Bitrate' => 'Average bitrate in bits/second. Valid bitrates depend on the coding mode.', 'Eac3Settings$LoRoCenterMixLevel' => 'Left only/Right only center mix level. Only used for 3/2 coding mode.', 'Eac3Settings$LoRoSurroundMixLevel' => 'Left only/Right only surround mix level. Only used for 3/2 coding mode.', 'Eac3Settings$LtRtCenterMixLevel' => 'Left total/Right total center mix level. Only used for 3/2 coding mode.', 'Eac3Settings$LtRtSurroundMixLevel' => 'Left total/Right total surround mix level. Only used for 3/2 coding mode.', 'Mp2Settings$Bitrate' => 'Average bitrate in bits/second.', 'Mp2Settings$SampleRate' => 'Sample rate in Hz.', 'Offering$FixedPrice' => 'One-time charge for each reserved resource, e.g. \'0.0\' for a NO_UPFRONT offering', 'Offering$UsagePrice' => 'Recurring usage charge for each reserved resource, e.g. \'157.0\'', 'Reservation$FixedPrice' => 'One-time charge for each reserved resource, e.g. \'0.0\' for a NO_UPFRONT offering', 'Reservation$UsagePrice' => 'Recurring usage charge for each reserved resource, e.g. \'157.0\'', ], ], '__doubleMin0' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$FragmentTime' => 'The length in seconds of each fragment. Only used with EBP markers.', 'M2tsSettings$NullPacketBitrate' => 'Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.', ], ], '__doubleMin1' => [ 'base' => NULL, 'refs' => [ 'H264Settings$GopSize' => 'GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.', 'M2tsSettings$SegmentationTime' => 'The length in seconds of each segment. Required unless markers is set to None_.', ], ], '__doubleMinNegative59Max0' => [ 'base' => NULL, 'refs' => [ 'AudioNormalizationSettings$TargetLkfs' => 'Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$ShadowXOffset' => 'Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$ShadowYOffset' => 'Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.', 'Channel$PipelinesRunningCount' => 'The number of currently healthy pipelines.', 'ChannelSummary$PipelinesRunningCount' => 'The number of currently healthy pipelines.', 'DvbSubDestinationSettings$ShadowXOffset' => 'Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$ShadowYOffset' => 'Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.', 'H264Settings$ParNumerator' => 'Pixel Aspect Ratio numerator.', 'Offering$Duration' => 'Lease duration, e.g. \'12\'', 'Reservation$Count' => 'Number of reserved resources', 'Reservation$Duration' => 'Lease duration, e.g. \'12\'', 'VideoDescription$Height' => 'Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.', 'VideoDescription$Width' => 'Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.', ], ], '__integerMin0' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$XPosition' => 'Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$YPosition' => 'Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$XPosition' => 'Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$YPosition' => 'Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', 'H264Settings$BufSize' => 'Size of buffer (HRD buffer model) in bits/second.', 'H264Settings$GopClosedCadence' => 'Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.', 'HlsAkamaiSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsAkamaiSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'HlsBasicPutSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsBasicPutSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'HlsGroupSettings$MinSegmentLength' => 'When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.', 'HlsGroupSettings$TimedMetadataId3Period' => 'Timed Metadata interval in seconds.', 'HlsGroupSettings$TimestampDeltaMilliseconds' => 'Provides an extra millisecond delta offset to fine tune the timestamps.', 'HlsInputSettings$Bandwidth' => 'When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.', 'HlsInputSettings$BufferSegments' => 'When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.', 'HlsInputSettings$Retries' => 'The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.', 'HlsInputSettings$RetryInterval' => 'The number of seconds between retries when an attempt to read a manifest or segment fails.', 'HlsMediaStoreSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsMediaStoreSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'HlsWebdavSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsWebdavSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'M2tsSettings$AudioFramesPerPes' => 'The number of audio frames to insert for each PES packet.', 'M2tsSettings$Bitrate' => 'The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.', 'M3u8Settings$AudioFramesPerPes' => 'The number of audio frames to insert for each PES packet.', 'MsSmoothGroupSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.', 'MsSmoothGroupSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'MsSmoothGroupSettings$NumRetries' => 'Number of retry attempts.', 'MsSmoothGroupSettings$RestartDelay' => 'Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.', 'RtmpGroupSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'RtmpOutputSettings$NumRetries' => 'Number of retry attempts.', 'StaticImageActivateScheduleActionSettings$Duration' => 'The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.', 'StaticImageActivateScheduleActionSettings$FadeIn' => 'The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).', 'StaticImageActivateScheduleActionSettings$FadeOut' => 'Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).', 'StaticImageActivateScheduleActionSettings$ImageX' => 'Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.', 'StaticImageActivateScheduleActionSettings$ImageY' => 'Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.', 'StaticImageDeactivateScheduleActionSettings$FadeOut' => 'The time in milliseconds for the image to fade out. Default is 0 (no fade-out).', 'UdpGroupSettings$TimedMetadataId3Period' => 'Timed Metadata interval in seconds.', ], ], '__integerMin0Max10' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$OutlineSize' => 'Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$OutlineSize' => 'Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], '__integerMin0Max100' => [ 'base' => NULL, 'refs' => [ 'H264Settings$BufFillPct' => 'Percentage of the buffer that should initially be filled (HRD buffer model).', 'StaticImageActivateScheduleActionSettings$Opacity' => 'Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.', 'VideoDescription$Sharpness' => 'Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.', ], ], '__integerMin0Max1000' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$PatInterval' => 'The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.', 'M2tsSettings$PmtInterval' => 'The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.', 'M3u8Settings$PatInterval' => 'The number of milliseconds between instances of this table in the output transport stream. A value of \\"0\\" writes out the PMT once per segment file.', 'M3u8Settings$PmtInterval' => 'The number of milliseconds between instances of this table in the output transport stream. A value of \\"0\\" writes out the PMT once per segment file.', ], ], '__integerMin0Max10000' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EbpLookaheadMs' => 'When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.', 'MsSmoothGroupSettings$SendDelayMs' => 'Number of milliseconds to delay the output from the second pipeline.', 'UdpOutputSettings$BufferMsec' => 'UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.', ], ], '__integerMin0Max1000000' => [ 'base' => NULL, 'refs' => [ 'InputLossBehavior$BlackFrameMsec' => 'On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite.', 'InputLossBehavior$RepeatFrameMsec' => 'On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite.', ], ], '__integerMin0Max1099511627775' => [ 'base' => NULL, 'refs' => [ 'Scte35SegmentationDescriptor$SegmentationDuration' => 'Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.', ], ], '__integerMin0Max128' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Softness' => 'Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.', ], ], '__integerMin0Max15' => [ 'base' => NULL, 'refs' => [ 'HlsAkamaiSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'HlsBasicPutSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'HlsMediaStoreSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'HlsWebdavSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'InputChannelLevel$InputChannel' => 'The index of the input channel used as a source.', ], ], '__integerMin0Max255' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$BackgroundOpacity' => 'Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$FontOpacity' => 'Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$ShadowOpacity' => 'Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$BackgroundOpacity' => 'Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$FontOpacity' => 'Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$ShadowOpacity' => 'Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'Scte35SegmentationDescriptor$SegmentNum' => 'Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.', 'Scte35SegmentationDescriptor$SegmentationTypeId' => 'Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").', 'Scte35SegmentationDescriptor$SegmentationUpidType' => 'Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").', 'Scte35SegmentationDescriptor$SegmentsExpected' => 'Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.', 'Scte35SegmentationDescriptor$SubSegmentNum' => 'Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.', 'Scte35SegmentationDescriptor$SubSegmentsExpected' => 'Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.', ], ], '__integerMin0Max30' => [ 'base' => NULL, 'refs' => [ 'H264Settings$MinIInterval' => 'Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1', ], ], '__integerMin0Max3600' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ProgramDateTimePeriod' => 'Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.', ], ], '__integerMin0Max4294967295' => [ 'base' => NULL, 'refs' => [ 'Scte35ReturnToNetworkScheduleActionSettings$SpliceEventId' => 'The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.', 'Scte35SegmentationDescriptor$SegmentationEventId' => 'Corresponds to SCTE-35 segmentation_event_id. ', 'Scte35SpliceInsertScheduleActionSettings$SpliceEventId' => 'The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.', ], ], '__integerMin0Max500' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$PcrPeriod' => 'Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.', 'M3u8Settings$PcrPeriod' => 'Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.', ], ], '__integerMin0Max600' => [ 'base' => NULL, 'refs' => [ 'HlsAkamaiSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'HlsBasicPutSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'HlsMediaStoreSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'HlsWebdavSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', ], ], '__integerMin0Max65535' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$ProgramNum' => 'The value of the program number field in the Program Map Table.', 'M2tsSettings$TransportStreamId' => 'The value of the transport stream ID field in the Program Map Table.', 'M3u8Settings$ProgramNum' => 'The value of the program number field in the Program Map Table.', 'M3u8Settings$TransportStreamId' => 'The value of the transport stream ID field in the Program Map Table.', ], ], '__integerMin0Max65536' => [ 'base' => NULL, 'refs' => [ 'DvbNitSettings$NetworkId' => 'The numeric value placed in the Network Information Table (NIT).', 'VideoSelectorProgramId$ProgramId' => 'Selects a specific program from within a multi-program transport stream. If the program doesn\'t exist, the first program within the transport stream will be selected by default.', ], ], '__integerMin0Max7' => [ 'base' => NULL, 'refs' => [ 'AudioChannelMapping$OutputChannel' => 'The index of the output channel being produced.', 'H264Settings$GopNumBFrames' => 'Number of B-frames between reference frames.', 'StaticImageActivateScheduleActionSettings$Layer' => 'The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.', 'StaticImageDeactivateScheduleActionSettings$Layer' => 'The image overlay layer to deactivate, 0 to 7. Default is 0.', ], ], '__integerMin0Max8191' => [ 'base' => NULL, 'refs' => [ 'AudioPidSelection$Pid' => 'Selects a specific PID from within a source.', 'VideoSelectorPid$Pid' => 'Selects a specific PID from within a video source.', ], ], '__integerMin0Max8589934591' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsertScheduleActionSettings$Duration' => 'Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.', ], ], '__integerMin1' => [ 'base' => NULL, 'refs' => [ 'ArchiveGroupSettings$RolloverInterval' => 'Number of seconds to write to archive file before closing and starting a new one.', 'DvbSubSourceSettings$Pid' => 'When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.', 'H264Settings$FramerateDenominator' => 'Framerate denominator.', 'H264Settings$FramerateNumerator' => 'Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.', 'H264Settings$ParDenominator' => 'Pixel Aspect Ratio denominator.', 'HlsGroupSettings$KeepSegments' => 'Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.', 'HlsGroupSettings$SegmentLength' => 'Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.', 'HlsGroupSettings$SegmentsPerSubdirectory' => 'Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.', 'MsSmoothGroupSettings$FragmentLength' => 'Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.', 'PurchaseOffering$Count' => 'Number of resources', 'RtmpOutputSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.', 'Scte27SourceSettings$Pid' => 'The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.', 'StaticImageActivateScheduleActionSettings$Height' => 'The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.', 'StaticImageActivateScheduleActionSettings$Width' => 'The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.', ], ], '__integerMin1000' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Bitrate' => 'Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.', 'H264Settings$MaxBitrate' => 'For QVBR: See the tooltip for Quality levelFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.', ], ], '__integerMin1000Max30000' => [ 'base' => NULL, 'refs' => [ 'DvbTdtSettings$RepInterval' => 'The number of milliseconds between instances of this table in the output transport stream.', ], ], '__integerMin1Max10' => [ 'base' => NULL, 'refs' => [ 'H264Settings$QvbrQualityLevel' => 'Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:- Primary screen: Quality level: 8 to 10. Max bitrate: 4M- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M', ], ], '__integerMin1Max1000000' => [ 'base' => NULL, 'refs' => [ 'TimecodeConfig$SyncThreshold' => 'Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.', ], ], '__integerMin1Max16' => [ 'base' => NULL, 'refs' => [ 'RemixSettings$ChannelsIn' => 'Number of input channels to be used.', ], ], '__integerMin1Max20' => [ 'base' => NULL, 'refs' => [ 'FecOutputSettings$RowLength' => 'Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.', ], ], '__integerMin1Max31' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$Dialnorm' => 'Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.', 'Eac3Settings$Dialnorm' => 'Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.', ], ], '__integerMin1Max32' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Slices' => 'Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.', ], ], '__integerMin1Max3600' => [ 'base' => NULL, 'refs' => [ 'FrameCaptureSettings$CaptureInterval' => 'The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.', ], ], '__integerMin1Max4' => [ 'base' => NULL, 'refs' => [ 'CaptionLanguageMapping$CaptionChannel' => 'The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)', 'EmbeddedSourceSettings$Source608ChannelNumber' => 'Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.', 'Scte20SourceSettings$Source608ChannelNumber' => 'Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.', ], ], '__integerMin1Max5' => [ 'base' => NULL, 'refs' => [ 'EmbeddedSourceSettings$Source608TrackNumber' => 'This field is unused and deprecated.', 'InputSettings$FilterStrength' => 'Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).', ], ], '__integerMin1Max6' => [ 'base' => NULL, 'refs' => [ 'H264Settings$NumRefFrames' => 'Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.', ], ], '__integerMin1Max8' => [ 'base' => NULL, 'refs' => [ 'RemixSettings$ChannelsOut' => 'Number of output channels to be produced.Valid values: 1, 2, 4, 6, 8', ], ], '__integerMin25Max10000' => [ 'base' => NULL, 'refs' => [ 'DvbNitSettings$RepInterval' => 'The number of milliseconds between instances of this table in the output transport stream.', ], ], '__integerMin25Max2000' => [ 'base' => NULL, 'refs' => [ 'DvbSdtSettings$RepInterval' => 'The number of milliseconds between instances of this table in the output transport stream.', ], ], '__integerMin3' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$IndexNSegments' => 'Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.', ], ], '__integerMin30' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$CacheLength' => 'Cache length, in seconds, is used to calculate buffer size.', ], ], '__integerMin4Max20' => [ 'base' => NULL, 'refs' => [ 'FecOutputSettings$ColumnDepth' => 'Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.', ], ], '__integerMin96Max600' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$FontResolution' => 'Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$FontResolution' => 'Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.', ], ], '__integerMinNegative1000Max1000' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsert$AdAvailOffset' => 'When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.', 'Scte35TimeSignalApos$AdAvailOffset' => 'When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.', ], ], '__integerMinNegative60Max6' => [ 'base' => NULL, 'refs' => [ 'InputChannelLevel$Gain' => 'Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.', ], ], '__integerMinNegative60Max60' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$InitialAudioGain' => 'Value to set the initial audio gain for the Live Event.', ], ], '__listOfAudioChannelMapping' => [ 'base' => NULL, 'refs' => [ 'RemixSettings$ChannelMappings' => 'Mapping of input channels to output channels, with appropriate gain adjustments.', ], ], '__listOfAudioDescription' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$AudioDescriptions' => NULL, ], ], '__listOfAudioSelector' => [ 'base' => NULL, 'refs' => [ 'InputSettings$AudioSelectors' => 'Used to select the audio stream to decode for inputs that have multiple available.', ], ], '__listOfCaptionDescription' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$CaptionDescriptions' => 'Settings for caption decriptions', ], ], '__listOfCaptionLanguageMapping' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$CaptionLanguageMappings' => 'Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".', ], ], '__listOfCaptionSelector' => [ 'base' => NULL, 'refs' => [ 'InputSettings$CaptionSelectors' => 'Used to select the caption input to use for inputs that have multiple available.', ], ], '__listOfChannelEgressEndpoint' => [ 'base' => NULL, 'refs' => [ 'Channel$EgressEndpoints' => 'The endpoints where outgoing connections initiate from', 'ChannelSummary$EgressEndpoints' => 'The endpoints where outgoing connections initiate from', ], ], '__listOfChannelSummary' => [ 'base' => NULL, 'refs' => [ 'ListChannelsResultModel$Channels' => NULL, ], ], '__listOfHlsAdMarkers' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$AdMarkers' => 'Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.', ], ], '__listOfInput' => [ 'base' => NULL, 'refs' => [ 'ListInputsResultModel$Inputs' => NULL, ], ], '__listOfInputAttachment' => [ 'base' => NULL, 'refs' => [ 'Channel$InputAttachments' => 'List of input attachments for channel.', 'ChannelSummary$InputAttachments' => 'List of input attachments for channel.', 'CreateChannel$InputAttachments' => 'List of input attachments for channel.', 'UpdateChannel$InputAttachments' => NULL, ], ], '__listOfInputChannelLevel' => [ 'base' => NULL, 'refs' => [ 'AudioChannelMapping$InputChannelLevels' => 'Indices and gain values for each input channel that should be remixed into this output channel.', ], ], '__listOfInputDestination' => [ 'base' => NULL, 'refs' => [ 'Input$Destinations' => 'A list of the destinations of the input (PUSH-type).', ], ], '__listOfInputDestinationRequest' => [ 'base' => NULL, 'refs' => [ 'CreateInput$Destinations' => 'Destination settings for PUSH type inputs.', 'UpdateInput$Destinations' => 'Destination settings for PUSH type inputs.', ], ], '__listOfInputSecurityGroup' => [ 'base' => NULL, 'refs' => [ 'ListInputSecurityGroupsResultModel$InputSecurityGroups' => 'List of input security groups', ], ], '__listOfInputSource' => [ 'base' => NULL, 'refs' => [ 'Input$Sources' => 'A list of the sources of the input (PULL-type).', ], ], '__listOfInputSourceRequest' => [ 'base' => NULL, 'refs' => [ 'CreateInput$Sources' => 'The source URLs for a PULL-type input. Every PULL type input needsexactly two source URLs for redundancy.Only specify sources for PULL type Inputs. Leave Destinations empty.', 'UpdateInput$Sources' => 'The source URLs for a PULL-type input. Every PULL type input needsexactly two source URLs for redundancy.Only specify sources for PULL type Inputs. Leave Destinations empty.', ], ], '__listOfInputWhitelistRule' => [ 'base' => NULL, 'refs' => [ 'InputSecurityGroup$WhitelistRules' => 'Whitelist rules and their sync status', ], ], '__listOfInputWhitelistRuleCidr' => [ 'base' => NULL, 'refs' => [ 'InputSecurityGroupWhitelistRequest$WhitelistRules' => 'List of IPv4 CIDR addresses to whitelist', ], ], '__listOfMediaConnectFlow' => [ 'base' => NULL, 'refs' => [ 'Input$MediaConnectFlows' => 'A list of MediaConnect Flows for this input.', ], ], '__listOfMediaConnectFlowRequest' => [ 'base' => NULL, 'refs' => [ 'CreateInput$MediaConnectFlows' => 'A list of the MediaConnect Flows that you want to use in this input. You can specify as few as oneFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in aseparate Availability Zone as this ensures your EML input is redundant to AZ issues.', 'UpdateInput$MediaConnectFlows' => 'A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as oneFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in aseparate Availability Zone as this ensures your EML input is redundant to AZ issues.', ], ], '__listOfOffering' => [ 'base' => NULL, 'refs' => [ 'ListOfferingsResultModel$Offerings' => 'List of offerings', ], ], '__listOfOutput' => [ 'base' => NULL, 'refs' => [ 'OutputGroup$Outputs' => NULL, ], ], '__listOfOutputDestination' => [ 'base' => NULL, 'refs' => [ 'Channel$Destinations' => 'A list of destinations of the channel. For UDP outputs, there is onedestination per output. For other types (HLS, for example), there isone destination per packager.', 'ChannelSummary$Destinations' => 'A list of destinations of the channel. For UDP outputs, there is onedestination per output. For other types (HLS, for example), there isone destination per packager.', 'CreateChannel$Destinations' => NULL, 'UpdateChannel$Destinations' => 'A list of output destinations for this channel.', ], ], '__listOfOutputDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'OutputDestination$Settings' => 'Destination settings for output; one for each redundant encoder.', ], ], '__listOfOutputGroup' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$OutputGroups' => NULL, ], ], '__listOfPipelinePauseStateSettings' => [ 'base' => NULL, 'refs' => [ 'PauseStateScheduleActionSettings$Pipelines' => NULL, ], ], '__listOfReservation' => [ 'base' => NULL, 'refs' => [ 'ListReservationsResultModel$Reservations' => 'List of reservations', ], ], '__listOfScheduleAction' => [ 'base' => NULL, 'refs' => [ 'BatchScheduleActionCreateRequest$ScheduleActions' => 'A list of schedule actions to create.', 'BatchScheduleActionCreateResult$ScheduleActions' => 'List of actions that have been created in the schedule.', 'BatchScheduleActionDeleteResult$ScheduleActions' => 'List of actions that have been deleted from the schedule.', 'ScheduleDescribeResultModel$ScheduleActions' => 'The list of actions in the schedule.', ], ], '__listOfScte35Descriptor' => [ 'base' => NULL, 'refs' => [ 'Scte35TimeSignalScheduleActionSettings$Scte35Descriptors' => 'The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.', ], ], '__listOfValidationError' => [ 'base' => NULL, 'refs' => [ 'ChannelConfigurationValidationError$ValidationErrors' => 'A collection of validation error responses.', ], ], '__listOfVideoDescription' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$VideoDescriptions' => NULL, ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'BatchScheduleActionDeleteRequest$ActionNames' => 'A list of schedule actions to delete.', 'CreateInput$InputSecurityGroups' => 'A list of security groups referenced by IDs to attach to the input.', 'Input$AttachedChannels' => 'A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).', 'Input$SecurityGroups' => 'A list of IDs for all the Input Security Groups attached to the input.', 'InputSecurityGroup$Inputs' => 'The list of inputs currently using this Input Security Group.', 'InputVpcRequest$SecurityGroupIds' => 'A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces.Requires subnetIds. If none are specified then the VPC default security group will be used.', 'InputVpcRequest$SubnetIds' => 'A list of 2 VPC subnet IDs from the same VPC.Subnet IDs must be mapped to two unique availability zones (AZ).', 'Output$AudioDescriptionNames' => 'The names of the AudioDescriptions used as audio sources for this output.', 'Output$CaptionDescriptionNames' => 'The names of the CaptionDescriptions used as caption sources for this output.', 'UpdateInput$InputSecurityGroups' => 'A list of security groups referenced by IDs to attach to the input.', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'AccessDenied$Message' => NULL, 'ArchiveOutputSettings$Extension' => 'Output file extension. If excluded, this will be auto-selected from the container type.', 'ArchiveOutputSettings$NameModifier' => 'String concatenated to the end of the destination filename. Required for multiple outputs of the same type.', 'AudioDescription$AudioSelectorName' => 'The name of the AudioSelector used as the source for this AudioDescription.', 'AudioDescription$Name' => 'The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.', 'AudioDescription$StreamName' => 'Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).', 'AudioLanguageSelection$LanguageCode' => 'Selects a specific three-letter language code from within an audio source.', 'AudioOnlyHlsSettings$AudioGroupId' => 'Specifies the group to which the audio Rendition belongs.', 'BadGatewayException$Message' => NULL, 'BurnInDestinationSettings$FontSize' => 'When set to \'auto\' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.', 'CaptionDescription$CaptionSelectorName' => 'Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.', 'CaptionDescription$LanguageCode' => 'ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/', 'CaptionDescription$LanguageDescription' => 'Human readable information to indicate captions available for players (eg. English, or Spanish).', 'CaptionDescription$Name' => 'Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.', 'CaptionSelector$LanguageCode' => 'When specified this field indicates the three letter language code of the caption track to extract from the source.', 'Channel$Arn' => 'The unique arn of the channel.', 'Channel$Id' => 'The unique id of the channel.', 'Channel$Name' => 'The name of the channel. (user-mutable)', 'Channel$RoleArn' => 'The Amazon Resource Name (ARN) of the role assumed when running the Channel.', 'ChannelConfigurationValidationError$Message' => NULL, 'ChannelEgressEndpoint$SourceIp' => 'Public IP of where a channel\'s output comes from', 'ChannelSummary$Arn' => 'The unique arn of the channel.', 'ChannelSummary$Id' => 'The unique id of the channel.', 'ChannelSummary$Name' => 'The name of the channel. (user-mutable)', 'ChannelSummary$RoleArn' => 'The Amazon Resource Name (ARN) of the role assumed when running the Channel.', 'CreateChannel$Name' => 'Name of channel.', 'CreateChannel$RequestId' => 'Unique request ID to be specified. This is needed to prevent retries fromcreating multiple resources.', 'CreateChannel$Reserved' => 'Deprecated field that\'s only usable by whitelisted customers.', 'CreateChannel$RoleArn' => 'An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.', 'CreateInput$Name' => 'Name of the input.', 'CreateInput$RequestId' => 'Unique identifier of the request to ensure the request is handledexactly once in case of retries.', 'CreateInput$RoleArn' => 'The Amazon Resource Name (ARN) of the role this input assumes during and after creation.', 'DvbSubDestinationSettings$FontSize' => 'When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.', 'FixedModeScheduleActionStartSettings$Time' => 'Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".', 'FollowModeScheduleActionStartSettings$ReferenceActionName' => 'The action name of another action that this one refers to.', 'FrameCaptureOutputSettings$NameModifier' => 'Required if the output group contains more than one output. This modifier forms part of the output file name.', 'GatewayTimeoutException$Message' => NULL, 'HlsAkamaiSettings$Salt' => 'Salt for authenticated Akamai.', 'HlsAkamaiSettings$Token' => 'Token parameter for authenticated akamai. If not specified, _gda_ is used.', 'HlsGroupSettings$BaseUrlContent' => 'A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.', 'HlsGroupSettings$BaseUrlManifest' => 'A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.', 'HlsGroupSettings$KeyFormat' => 'The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.', 'HlsGroupSettings$KeyFormatVersions' => 'Either a single positive integer version value or a slash delimited list of version values (1/2/3).', 'HlsOutputSettings$SegmentModifier' => 'String concatenated to end of segment filenames.', 'HlsTimedMetadataScheduleActionSettings$Id3' => 'Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure', 'Input$Arn' => 'The Unique ARN of the input (generated, immutable).', 'Input$Id' => 'The generated ID of the input (unique for user account, immutable).', 'Input$Name' => 'The user-assigned name (This is a mutable value).', 'Input$RoleArn' => 'The Amazon Resource Name (ARN) of the role this input assumes during and after creation.', 'InputAttachment$InputAttachmentName' => 'User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.', 'InputAttachment$InputId' => 'The ID of the input', 'InputDestination$Ip' => 'The system-generated static IP address of endpoint.It remains fixed for the lifetime of the input.', 'InputDestination$Port' => 'The port number for the input.', 'InputDestination$Url' => 'This represents the endpoint that the customer stream will bepushed to.', 'InputDestinationRequest$StreamName' => 'A unique name for the location the RTMP stream is being pushedto.', 'InputDestinationVpc$AvailabilityZone' => 'The availability zone of the Input destination.', 'InputDestinationVpc$NetworkInterfaceId' => 'The network interface ID of the Input destination in the VPC.', 'InputLocation$PasswordParam' => 'key used to extract the password from EC2 Parameter store', 'InputLocation$Uri' => 'Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".', 'InputLocation$Username' => 'Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://"', 'InputSecurityGroup$Arn' => 'Unique ARN of Input Security Group', 'InputSecurityGroup$Id' => 'The Id of the Input Security Group', 'InputSource$PasswordParam' => 'The key used to extract the password from EC2 Parameter store.', 'InputSource$Url' => 'This represents the customer\'s source URL where stream ispulled from.', 'InputSource$Username' => 'The username for the input source.', 'InputSourceRequest$PasswordParam' => 'The key used to extract the password from EC2 Parameter store.', 'InputSourceRequest$Url' => 'This represents the customer\'s source URL where stream ispulled from.', 'InputSourceRequest$Username' => 'The username for the input source.', 'InputSwitchScheduleActionSettings$InputAttachmentNameReference' => 'The name of the input attachment that should be switched to by this action.', 'InputWhitelistRule$Cidr' => 'The IPv4 CIDR that\'s whitelisted.', 'InputWhitelistRuleCidr$Cidr' => 'The IPv4 CIDR to whitelist.', 'InternalServiceError$Message' => NULL, 'InvalidRequest$Message' => NULL, 'LimitExceeded$Message' => NULL, 'ListChannelsResultModel$NextToken' => NULL, 'ListInputSecurityGroupsResultModel$NextToken' => NULL, 'ListInputsResultModel$NextToken' => NULL, 'ListOfferingsResultModel$NextToken' => 'Token to retrieve the next page of results', 'ListReservationsResultModel$NextToken' => 'Token to retrieve the next page of results', 'M2tsSettings$AribCaptionsPid' => 'Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$AudioPids' => 'Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$DvbSubPids' => 'Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$DvbTeletextPid' => 'Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$EcmPid' => 'This field is unused and deprecated.', 'M2tsSettings$EtvPlatformPid' => 'Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$EtvSignalPid' => 'Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$KlvDataPids' => 'Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$PcrPid' => 'Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$PmtPid' => 'Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$Scte27Pids' => 'Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$Scte35Pid' => 'Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$TimedMetadataPid' => 'Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$VideoPid' => 'Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M3u8Settings$AudioPids' => 'Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.', 'M3u8Settings$EcmPid' => 'This parameter is unused and deprecated.', 'M3u8Settings$PcrPid' => 'Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.', 'M3u8Settings$PmtPid' => 'Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.', 'M3u8Settings$Scte35Pid' => 'Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.', 'M3u8Settings$TimedMetadataPid' => 'Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M3u8Settings$VideoPid' => 'Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.', 'MediaConnectFlow$FlowArn' => 'The unique ARN of the MediaConnect Flow being used as a source.', 'MediaConnectFlowRequest$FlowArn' => 'The ARN of the MediaConnect Flow that you want to use as a source.', 'MsSmoothGroupSettings$AcquisitionPointId' => 'The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".', 'MsSmoothGroupSettings$EventId' => 'MS Smooth event ID to be sent to the IIS server.Should only be specified if eventIdMode is set to useConfigured.', 'MsSmoothGroupSettings$TimestampOffset' => 'Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.', 'MsSmoothOutputSettings$NameModifier' => 'String concatenated to the end of the destination filename. Required for multiple outputs of the same type.', 'Offering$Arn' => 'Unique offering ARN, e.g. \'arn:aws:medialive:us-west-2:123456789012:offering:87654321\'', 'Offering$CurrencyCode' => 'Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. \'USD\'', 'Offering$OfferingDescription' => 'Offering description, e.g. \'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)\'', 'Offering$OfferingId' => 'Unique offering ID, e.g. \'87654321\'', 'Offering$Region' => 'AWS region, e.g. \'us-west-2\'', 'Output$VideoDescriptionName' => 'The name of the VideoDescription used as the source for this output.', 'OutputDestination$Id' => 'User-specified id. This is used in an output group or an output.', 'OutputDestinationSettings$PasswordParam' => 'key used to extract the password from EC2 Parameter store', 'OutputDestinationSettings$StreamName' => 'Stream name for RTMP destinations (URLs of type rtmp://)', 'OutputDestinationSettings$Url' => 'A URL specifying a destination', 'OutputDestinationSettings$Username' => 'username for destination', 'OutputLocationRef$DestinationRefId' => NULL, 'PurchaseOffering$Name' => 'Name for the new reservation', 'PurchaseOffering$RequestId' => 'Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.', 'PurchaseOffering$Start' => 'Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.', 'Reservation$Arn' => 'Unique reservation ARN, e.g. \'arn:aws:medialive:us-west-2:123456789012:reservation:1234567\'', 'Reservation$CurrencyCode' => 'Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. \'USD\'', 'Reservation$End' => 'Reservation UTC end date and time in ISO-8601 format, e.g. \'2019-03-01T00:00:00\'', 'Reservation$Name' => 'User specified reservation name', 'Reservation$OfferingDescription' => 'Offering description, e.g. \'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)\'', 'Reservation$OfferingId' => 'Unique offering ID, e.g. \'87654321\'', 'Reservation$Region' => 'AWS region, e.g. \'us-west-2\'', 'Reservation$ReservationId' => 'Unique reservation ID, e.g. \'1234567\'', 'Reservation$Start' => 'Reservation UTC start date and time in ISO-8601 format, e.g. \'2018-03-01T00:00:00\'', 'ResourceConflict$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'ScheduleAction$ActionName' => 'The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.', 'ScheduleDescribeResultModel$NextToken' => 'The next token; for use in pagination.', 'Scte35SegmentationDescriptor$SegmentationUpid' => 'Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.', 'StandardHlsSettings$AudioRenditionSets' => 'List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by \',\'.', 'Tags$member' => NULL, 'TeletextSourceSettings$PageNumber' => 'Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.', 'UpdateChannel$Name' => 'The name of the channel.', 'UpdateChannel$RoleArn' => 'An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.', 'UpdateInput$Name' => 'Name of the input.', 'UpdateInput$RoleArn' => 'The Amazon Resource Name (ARN) of the role this input assumes during and after creation.', 'ValidationError$ElementPath' => NULL, 'ValidationError$ErrorMessage' => NULL, 'VideoDescription$Name' => 'The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.', '__listOf__string$member' => NULL, ], ], '__stringMax32' => [ 'base' => NULL, 'refs' => [ 'OutputGroup$Name' => 'Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.', ], ], '__stringMin1' => [ 'base' => NULL, 'refs' => [ 'AudioSelector$Name' => 'The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.', 'CaptionLanguageMapping$LanguageDescription' => 'Textual description of language', 'CaptionSelector$Name' => 'Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.', 'HlsOutputSettings$NameModifier' => 'String concatenated to the end of the destination filename. Accepts \\"Format Identifiers\\":#formatIdentifierParameters.', ], ], '__stringMin1Max255' => [ 'base' => NULL, 'refs' => [ 'Output$OutputName' => 'The name used to identify an output.', ], ], '__stringMin1Max256' => [ 'base' => NULL, 'refs' => [ 'DvbNitSettings$NetworkName' => 'The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.', 'DvbSdtSettings$ServiceName' => 'The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.', 'DvbSdtSettings$ServiceProviderName' => 'The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.', ], ], '__stringMin32Max32' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ConstantIv' => 'For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.', 'StaticKeySettings$StaticKeyValue' => 'Static key value as a 32 character hexadecimal string.', ], ], '__stringMin34Max34' => [ 'base' => NULL, 'refs' => [ 'BlackoutSlate$NetworkId' => 'Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").', ], ], '__stringMin3Max3' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$LanguageCode' => 'Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.', 'CaptionLanguageMapping$LanguageCode' => 'Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)', ], ], '__stringMin6Max6' => [ 'base' => NULL, 'refs' => [ 'InputLossBehavior$InputLossImageColor' => 'When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'API for AWS Elemental MediaLive', 'operations' => [ 'BatchUpdateSchedule' => 'Update a channel schedule', 'CreateChannel' => 'Creates a new channel', 'CreateInput' => 'Create an input', 'CreateInputSecurityGroup' => 'Creates a Input Security Group', 'CreateTags' => 'Create tags for a resource', 'DeleteChannel' => 'Starts deletion of channel. The associated outputs are also deleted.', 'DeleteInput' => 'Deletes the input end point', 'DeleteInputSecurityGroup' => 'Deletes an Input Security Group', 'DeleteReservation' => 'Delete an expired reservation.', 'DeleteTags' => 'Removes tags for a resource', 'DescribeChannel' => 'Gets details about a channel', 'DescribeInput' => 'Produces details about an input', 'DescribeInputSecurityGroup' => 'Produces a summary of an Input Security Group', 'DescribeOffering' => 'Get details for an offering.', 'DescribeReservation' => 'Get details for a reservation.', 'DescribeSchedule' => 'Get a channel schedule', 'ListChannels' => 'Produces list of channels that have been created', 'ListInputSecurityGroups' => 'Produces a list of Input Security Groups for an account', 'ListInputs' => 'Produces list of inputs that have been created', 'ListOfferings' => 'List offerings available for purchase.', 'ListReservations' => 'List purchased reservations.', 'ListTagsForResource' => 'Produces list of tags that have been created for a resource', 'PurchaseOffering' => 'Purchase an offering and create a reservation.', 'StartChannel' => 'Starts an existing channel', 'StopChannel' => 'Stops a running channel', 'UpdateChannel' => 'Updates a channel.', 'UpdateInput' => 'Updates an input.', 'UpdateInputSecurityGroup' => 'Update an Input Security Group\'s Whilelists.', ], 'shapes' => [ 'AacCodingMode' => [ 'base' => NULL, 'refs' => [ 'AacSettings$CodingMode' => 'Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.', ], ], 'AacInputType' => [ 'base' => NULL, 'refs' => [ 'AacSettings$InputType' => 'Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.Leave set to "normal" when input does not contain pre-mixed audio + AD.', ], ], 'AacProfile' => [ 'base' => NULL, 'refs' => [ 'AacSettings$Profile' => 'AAC Profile.', ], ], 'AacRateControlMode' => [ 'base' => NULL, 'refs' => [ 'AacSettings$RateControlMode' => 'Rate Control Mode.', ], ], 'AacRawFormat' => [ 'base' => NULL, 'refs' => [ 'AacSettings$RawFormat' => 'Sets LATM / LOAS AAC output for raw containers.', ], ], 'AacSettings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$AacSettings' => NULL, ], ], 'AacSpec' => [ 'base' => NULL, 'refs' => [ 'AacSettings$Spec' => 'Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.', ], ], 'AacVbrQuality' => [ 'base' => NULL, 'refs' => [ 'AacSettings$VbrQuality' => 'VBR Quality Level - Only used if rateControlMode is VBR.', ], ], 'Ac3BitstreamMode' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$BitstreamMode' => 'Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.', ], ], 'Ac3CodingMode' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$CodingMode' => 'Dolby Digital coding mode. Determines number of channels.', ], ], 'Ac3DrcProfile' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$DrcProfile' => 'If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.', ], ], 'Ac3LfeFilter' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$LfeFilter' => 'When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.', ], ], 'Ac3MetadataControl' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$MetadataControl' => 'When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.', ], ], 'Ac3Settings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$Ac3Settings' => NULL, ], ], 'AccessDenied' => [ 'base' => NULL, 'refs' => [], ], 'AfdSignaling' => [ 'base' => NULL, 'refs' => [ 'H264Settings$AfdSignaling' => 'Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.', ], ], 'ArchiveContainerSettings' => [ 'base' => NULL, 'refs' => [ 'ArchiveOutputSettings$ContainerSettings' => 'Settings specific to the container type of the file.', ], ], 'ArchiveGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$ArchiveGroupSettings' => NULL, ], ], 'ArchiveOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$ArchiveOutputSettings' => NULL, ], ], 'AribDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$AribDestinationSettings' => NULL, ], ], 'AribSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$AribSourceSettings' => NULL, ], ], 'AudioChannelMapping' => [ 'base' => NULL, 'refs' => [ '__listOfAudioChannelMapping$member' => NULL, ], ], 'AudioCodecSettings' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$CodecSettings' => 'Audio codec settings.', ], ], 'AudioDescription' => [ 'base' => NULL, 'refs' => [ '__listOfAudioDescription$member' => NULL, ], ], 'AudioDescriptionAudioTypeControl' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$AudioTypeControl' => 'Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output.Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.', ], ], 'AudioDescriptionLanguageCodeControl' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$LanguageCodeControl' => 'Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.', ], ], 'AudioLanguageSelection' => [ 'base' => NULL, 'refs' => [ 'AudioSelectorSettings$AudioLanguageSelection' => NULL, ], ], 'AudioLanguageSelectionPolicy' => [ 'base' => NULL, 'refs' => [ 'AudioLanguageSelection$LanguageSelectionPolicy' => 'When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can\'t find one with the same language.', ], ], 'AudioNormalizationAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AudioNormalizationSettings$Algorithm' => 'Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.', ], ], 'AudioNormalizationAlgorithmControl' => [ 'base' => NULL, 'refs' => [ 'AudioNormalizationSettings$AlgorithmControl' => 'When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.', ], ], 'AudioNormalizationSettings' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$AudioNormalizationSettings' => 'Advanced audio normalization settings.', ], ], 'AudioOnlyHlsSettings' => [ 'base' => NULL, 'refs' => [ 'HlsSettings$AudioOnlyHlsSettings' => NULL, ], ], 'AudioOnlyHlsTrackType' => [ 'base' => NULL, 'refs' => [ 'AudioOnlyHlsSettings$AudioTrackType' => 'Four types of audio-only tracks are supported:Audio-Only Variant StreamThe client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.Alternate Audio, Auto Select, DefaultAlternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YESAlternate Audio, Auto Select, Not DefaultAlternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YESAlternate Audio, not Auto SelectAlternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO', ], ], 'AudioPidSelection' => [ 'base' => NULL, 'refs' => [ 'AudioSelectorSettings$AudioPidSelection' => NULL, ], ], 'AudioSelector' => [ 'base' => NULL, 'refs' => [ '__listOfAudioSelector$member' => NULL, ], ], 'AudioSelectorSettings' => [ 'base' => NULL, 'refs' => [ 'AudioSelector$SelectorSettings' => 'The audio selector settings.', ], ], 'AudioType' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$AudioType' => 'Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.', ], ], 'AuthenticationScheme' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$AuthenticationScheme' => 'Authentication scheme to use when connecting with CDN', ], ], 'AvailBlanking' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$AvailBlanking' => 'Settings for ad avail blanking.', ], ], 'AvailBlankingState' => [ 'base' => NULL, 'refs' => [ 'AvailBlanking$State' => 'When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.', ], ], 'AvailConfiguration' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$AvailConfiguration' => 'Event-wide configuration settings for ad avail insertion.', ], ], 'AvailSettings' => [ 'base' => NULL, 'refs' => [ 'AvailConfiguration$AvailSettings' => 'Ad avail settings.', ], ], 'BadGatewayException' => [ 'base' => NULL, 'refs' => [], ], 'BadRequestException' => [ 'base' => NULL, 'refs' => [], ], 'BatchScheduleActionCreateRequest' => [ 'base' => 'A list of schedule actions to create (in a request) or that have been created (in a response).', 'refs' => [ 'BatchUpdateScheduleRequest$Creates' => 'Schedule actions to create in the schedule.', ], ], 'BatchScheduleActionCreateResult' => [ 'base' => 'List of actions that have been created in the schedule.', 'refs' => [ 'BatchUpdateScheduleResult$Creates' => 'Schedule actions created in the schedule.', ], ], 'BatchScheduleActionDeleteRequest' => [ 'base' => 'A list of schedule actions to delete.', 'refs' => [ 'BatchUpdateScheduleRequest$Deletes' => 'Schedule actions to delete from the schedule.', ], ], 'BatchScheduleActionDeleteResult' => [ 'base' => 'List of actions that have been deleted from the schedule.', 'refs' => [ 'BatchUpdateScheduleResult$Deletes' => 'Schedule actions deleted from the schedule.', ], ], 'BatchUpdateScheduleRequest' => [ 'base' => 'A request to create actions (add actions to the schedule), delete actions (remove actions from the schedule), or both create and delete actions.', 'refs' => [], ], 'BatchUpdateScheduleResult' => [ 'base' => 'Results of a batch schedule update.', 'refs' => [], ], 'BlackoutSlate' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$BlackoutSlate' => 'Settings for blackout slate.', ], ], 'BlackoutSlateNetworkEndBlackout' => [ 'base' => NULL, 'refs' => [ 'BlackoutSlate$NetworkEndBlackout' => 'Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".', ], ], 'BlackoutSlateState' => [ 'base' => NULL, 'refs' => [ 'BlackoutSlate$State' => 'When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.', ], ], 'BurnInAlignment' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$Alignment' => 'If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInBackgroundColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$BackgroundColor' => 'Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$BurnInDestinationSettings' => NULL, ], ], 'BurnInFontColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$FontColor' => 'Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInOutlineColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$OutlineColor' => 'Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInShadowColor' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$ShadowColor' => 'Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'BurnInTeletextGridControl' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$TeletextGridControl' => 'Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.', ], ], 'CaptionDescription' => [ 'base' => 'Output groups for this Live Event. Output groups contain information about where streams should be distributed.', 'refs' => [ '__listOfCaptionDescription$member' => NULL, ], ], 'CaptionDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDescription$DestinationSettings' => 'Additional settings for captions destination that depend on the destination type.', ], ], 'CaptionLanguageMapping' => [ 'base' => 'Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.', 'refs' => [ '__listOfCaptionLanguageMapping$member' => NULL, ], ], 'CaptionSelector' => [ 'base' => 'Output groups for this Live Event. Output groups contain information about where streams should be distributed.', 'refs' => [ '__listOfCaptionSelector$member' => NULL, ], ], 'CaptionSelectorSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelector$SelectorSettings' => 'Caption selector settings.', ], ], 'Channel' => [ 'base' => NULL, 'refs' => [ 'CreateChannelResultModel$Channel' => NULL, 'UpdateChannelResultModel$Channel' => NULL, ], ], 'ChannelConfigurationValidationError' => [ 'base' => NULL, 'refs' => [], ], 'ChannelEgressEndpoint' => [ 'base' => NULL, 'refs' => [ '__listOfChannelEgressEndpoint$member' => NULL, ], ], 'ChannelState' => [ 'base' => NULL, 'refs' => [ 'Channel$State' => NULL, 'ChannelSummary$State' => NULL, ], ], 'ChannelSummary' => [ 'base' => NULL, 'refs' => [ '__listOfChannelSummary$member' => NULL, ], ], 'ConflictException' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannel' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannelResultModel' => [ 'base' => NULL, 'refs' => [], ], 'CreateInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInputResultModel' => [ 'base' => NULL, 'refs' => [], ], 'CreateInputSecurityGroupResultModel' => [ 'base' => NULL, 'refs' => [], ], 'DvbNitSettings' => [ 'base' => 'DVB Network Information Table (NIT)', 'refs' => [ 'M2tsSettings$DvbNitSettings' => 'Inserts DVB Network Information Table (NIT) at the specified table repetition interval.', ], ], 'DvbSdtOutputSdt' => [ 'base' => NULL, 'refs' => [ 'DvbSdtSettings$OutputSdt' => 'Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.', ], ], 'DvbSdtSettings' => [ 'base' => 'DVB Service Description Table (SDT)', 'refs' => [ 'M2tsSettings$DvbSdtSettings' => 'Inserts DVB Service Description Table (SDT) at the specified table repetition interval.', ], ], 'DvbSubDestinationAlignment' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$Alignment' => 'If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationBackgroundColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$BackgroundColor' => 'Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationFontColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$FontColor' => 'Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationOutlineColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$OutlineColor' => 'Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$DvbSubDestinationSettings' => NULL, ], ], 'DvbSubDestinationShadowColor' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$ShadowColor' => 'Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.', ], ], 'DvbSubDestinationTeletextGridControl' => [ 'base' => NULL, 'refs' => [ 'DvbSubDestinationSettings$TeletextGridControl' => 'Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.', ], ], 'DvbSubSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$DvbSubSourceSettings' => NULL, ], ], 'DvbTdtSettings' => [ 'base' => 'DVB Time and Date Table (SDT)', 'refs' => [ 'M2tsSettings$DvbTdtSettings' => 'Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.', ], ], 'Eac3AttenuationControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$AttenuationControl' => 'When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.', ], ], 'Eac3BitstreamMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$BitstreamMode' => 'Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.', ], ], 'Eac3CodingMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$CodingMode' => 'Dolby Digital Plus coding mode. Determines number of channels.', ], ], 'Eac3DcFilter' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$DcFilter' => 'When set to enabled, activates a DC highpass filter for all input channels.', ], ], 'Eac3DrcLine' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$DrcLine' => 'Sets the Dolby dynamic range compression profile.', ], ], 'Eac3DrcRf' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$DrcRf' => 'Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.', ], ], 'Eac3LfeControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$LfeControl' => 'When encoding 3/2 audio, setting to lfe enables the LFE channel', ], ], 'Eac3LfeFilter' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$LfeFilter' => 'When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.', ], ], 'Eac3MetadataControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$MetadataControl' => 'When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.', ], ], 'Eac3PassthroughControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$PassthroughControl' => 'When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.', ], ], 'Eac3PhaseControl' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$PhaseControl' => 'When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.', ], ], 'Eac3Settings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$Eac3Settings' => NULL, ], ], 'Eac3StereoDownmix' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$StereoDownmix' => 'Stereo downmix preference. Only used for 3/2 coding mode.', ], ], 'Eac3SurroundExMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$SurroundExMode' => 'When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.', ], ], 'Eac3SurroundMode' => [ 'base' => NULL, 'refs' => [ 'Eac3Settings$SurroundMode' => 'When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.', ], ], 'EmbeddedConvert608To708' => [ 'base' => NULL, 'refs' => [ 'EmbeddedSourceSettings$Convert608To708' => 'If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.', ], ], 'EmbeddedDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$EmbeddedDestinationSettings' => NULL, ], ], 'EmbeddedPlusScte20DestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$EmbeddedPlusScte20DestinationSettings' => NULL, ], ], 'EmbeddedScte20Detection' => [ 'base' => NULL, 'refs' => [ 'EmbeddedSourceSettings$Scte20Detection' => 'Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.', ], ], 'EmbeddedSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$EmbeddedSourceSettings' => NULL, ], ], 'Empty' => [ 'base' => NULL, 'refs' => [], ], 'EncoderSettings' => [ 'base' => NULL, 'refs' => [ 'Channel$EncoderSettings' => NULL, 'CreateChannel$EncoderSettings' => NULL, 'UpdateChannel$EncoderSettings' => 'The encoder settings for this channel.', ], ], 'FecOutputIncludeFec' => [ 'base' => NULL, 'refs' => [ 'FecOutputSettings$IncludeFec' => 'Enables column only or column and row based FEC', ], ], 'FecOutputSettings' => [ 'base' => NULL, 'refs' => [ 'UdpOutputSettings$FecOutputSettings' => 'Settings for enabling and adjusting Forward Error Correction on UDP outputs.', ], ], 'FixedAfd' => [ 'base' => NULL, 'refs' => [ 'H264Settings$FixedAfd' => 'Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to \'Fixed\'.', ], ], 'FixedModeScheduleActionStartSettings' => [ 'base' => 'Start time for the action.', 'refs' => [ 'ScheduleActionStartSettings$FixedModeScheduleActionStartSettings' => 'Holds the start time for the action.', ], ], 'FollowModeScheduleActionStartSettings' => [ 'base' => 'Settings to specify if an action follows another.', 'refs' => [ 'ScheduleActionStartSettings$FollowModeScheduleActionStartSettings' => 'Specifies an action to follow for scheduling this action.', ], ], 'FollowPoint' => [ 'base' => 'Follow reference point.', 'refs' => [ 'FollowModeScheduleActionStartSettings$FollowPoint' => 'Identifies whether this action starts relative to the start or relative to the end of the reference action.', ], ], 'ForbiddenException' => [ 'base' => NULL, 'refs' => [], ], 'FrameCaptureGroupSettings' => [ 'base' => 'Frame Capture Group Settings', 'refs' => [ 'OutputGroupSettings$FrameCaptureGroupSettings' => NULL, ], ], 'FrameCaptureOutputSettings' => [ 'base' => 'Frame Capture Output Settings', 'refs' => [ 'OutputSettings$FrameCaptureOutputSettings' => NULL, ], ], 'FrameCaptureSettings' => [ 'base' => 'Frame Capture Settings', 'refs' => [ 'VideoCodecSettings$FrameCaptureSettings' => NULL, ], ], 'GatewayTimeoutException' => [ 'base' => NULL, 'refs' => [], ], 'GlobalConfiguration' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$GlobalConfiguration' => 'Configuration settings that apply to the event as a whole.', ], ], 'GlobalConfigurationInputEndAction' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$InputEndAction' => 'Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).', ], ], 'GlobalConfigurationLowFramerateInputs' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$SupportLowFramerateInputs' => 'Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.', ], ], 'GlobalConfigurationOutputTimingSource' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$OutputTimingSource' => 'Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.', ], ], 'H264AdaptiveQuantization' => [ 'base' => NULL, 'refs' => [ 'H264Settings$AdaptiveQuantization' => 'Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.', ], ], 'H264ColorMetadata' => [ 'base' => NULL, 'refs' => [ 'H264Settings$ColorMetadata' => 'Includes colorspace metadata in the output.', ], ], 'H264EntropyEncoding' => [ 'base' => NULL, 'refs' => [ 'H264Settings$EntropyEncoding' => 'Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.', ], ], 'H264FlickerAq' => [ 'base' => NULL, 'refs' => [ 'H264Settings$FlickerAq' => 'If set to enabled, adjust quantization within each frame to reduce flicker or \'pop\' on I-frames.', ], ], 'H264FramerateControl' => [ 'base' => NULL, 'refs' => [ 'H264Settings$FramerateControl' => 'This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.', ], ], 'H264GopBReference' => [ 'base' => NULL, 'refs' => [ 'H264Settings$GopBReference' => 'If enabled, use reference B frames for GOP structures that have B frames > 1.', ], ], 'H264GopSizeUnits' => [ 'base' => NULL, 'refs' => [ 'H264Settings$GopSizeUnits' => 'Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.', ], ], 'H264Level' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Level' => 'H.264 Level.', ], ], 'H264LookAheadRateControl' => [ 'base' => NULL, 'refs' => [ 'H264Settings$LookAheadRateControl' => 'Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.', ], ], 'H264ParControl' => [ 'base' => NULL, 'refs' => [ 'H264Settings$ParControl' => 'This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.', ], ], 'H264Profile' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Profile' => 'H.264 Profile.', ], ], 'H264RateControlMode' => [ 'base' => NULL, 'refs' => [ 'H264Settings$RateControlMode' => 'Rate control mode.QVBR: Quality will match the specified quality level except when it is constrained by themaximum bitrate. Recommended if you or your viewers pay for bandwidth.VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBRif you want to maintain a specific average bitrate over the duration of the channel.CBR: Quality varies, depending on the video complexity. Recommended only if you distributeyour assets to devices that cannot handle variable bitrates.', ], ], 'H264ScanType' => [ 'base' => NULL, 'refs' => [ 'H264Settings$ScanType' => 'Sets the scan type of the output to progressive or top-field-first interlaced.', ], ], 'H264SceneChangeDetect' => [ 'base' => NULL, 'refs' => [ 'H264Settings$SceneChangeDetect' => 'Scene change detection.- On: inserts I-frames when scene change is detected.- Off: does not force an I-frame when scene change is detected.', ], ], 'H264Settings' => [ 'base' => NULL, 'refs' => [ 'VideoCodecSettings$H264Settings' => NULL, ], ], 'H264SpatialAq' => [ 'base' => NULL, 'refs' => [ 'H264Settings$SpatialAq' => 'If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.', ], ], 'H264SubGopLength' => [ 'base' => NULL, 'refs' => [ 'H264Settings$SubgopLength' => 'If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.', ], ], 'H264Syntax' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Syntax' => 'Produces a bitstream compliant with SMPTE RP-2027.', ], ], 'H264TemporalAq' => [ 'base' => NULL, 'refs' => [ 'H264Settings$TemporalAq' => 'If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.', ], ], 'H264TimecodeInsertionBehavior' => [ 'base' => NULL, 'refs' => [ 'H264Settings$TimecodeInsertion' => 'Determines how timecodes should be inserted into the video elementary stream.- \'disabled\': Do not include timecodes- \'picTimingSei\': Pass through picture timing SEI messages from the source specified in Timecode Config', ], ], 'HlsAdMarkers' => [ 'base' => NULL, 'refs' => [ '__listOfHlsAdMarkers$member' => NULL, ], ], 'HlsAkamaiHttpTransferMode' => [ 'base' => NULL, 'refs' => [ 'HlsAkamaiSettings$HttpTransferMode' => 'Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.', ], ], 'HlsAkamaiSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsAkamaiSettings' => NULL, ], ], 'HlsBasicPutSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsBasicPutSettings' => NULL, ], ], 'HlsCaptionLanguageSetting' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$CaptionLanguageSetting' => 'Applies only to 608 Embedded output captions.insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.none: Include CLOSED-CAPTIONS=NONE line in the manifest.omit: Omit any CLOSED-CAPTIONS line from the manifest.', ], ], 'HlsCdnSettings' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$HlsCdnSettings' => 'Parameters that control interactions with the CDN.', ], ], 'HlsClientCache' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ClientCache' => 'When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.', ], ], 'HlsCodecSpecification' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$CodecSpecification' => 'Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.', ], ], 'HlsDirectoryStructure' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$DirectoryStructure' => 'Place segments in subdirectories.', ], ], 'HlsEncryptionType' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$EncryptionType' => 'Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.', ], ], 'HlsGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$HlsGroupSettings' => NULL, ], ], 'HlsInputSettings' => [ 'base' => NULL, 'refs' => [ 'NetworkInputSettings$HlsInputSettings' => 'Specifies HLS input settings when the uri is for a HLS manifest.', ], ], 'HlsIvInManifest' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$IvInManifest' => 'For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.', ], ], 'HlsIvSource' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$IvSource' => 'For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.', ], ], 'HlsManifestCompression' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ManifestCompression' => 'When set to gzip, compresses HLS playlist.', ], ], 'HlsManifestDurationFormat' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ManifestDurationFormat' => 'Indicates whether the output manifest should use floating point or integer values for segment duration.', ], ], 'HlsMediaStoreSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsMediaStoreSettings' => NULL, ], ], 'HlsMediaStoreStorageClass' => [ 'base' => NULL, 'refs' => [ 'HlsMediaStoreSettings$MediaStoreStorageClass' => 'When set to temporal, output files are stored in non-persistent memory for faster reading and writing.', ], ], 'HlsMode' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$Mode' => 'If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.', ], ], 'HlsOutputSelection' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$OutputSelection' => 'MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.SEGMENTSONLY: Does not generate any manifests for this output group.', ], ], 'HlsOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$HlsOutputSettings' => NULL, ], ], 'HlsProgramDateTime' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ProgramDateTime' => 'Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.', ], ], 'HlsRedundantManifest' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$RedundantManifest' => 'ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.', ], ], 'HlsSegmentationMode' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$SegmentationMode' => 'useInputSegmentation has been deprecated. The configured segment size is always used.', ], ], 'HlsSettings' => [ 'base' => NULL, 'refs' => [ 'HlsOutputSettings$HlsSettings' => 'Settings regarding the underlying stream. These settings are different for audio-only outputs.', ], ], 'HlsStreamInfResolution' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$StreamInfResolution' => 'Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.', ], ], 'HlsTimedMetadataId3Frame' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$TimedMetadataId3Frame' => 'Indicates ID3 frame that has the timecode.', ], ], 'HlsTimedMetadataScheduleActionSettings' => [ 'base' => 'Settings for the action to emit HLS metadata', 'refs' => [ 'ScheduleActionSettings$HlsTimedMetadataSettings' => 'Action to insert HLS metadata', ], ], 'HlsTsFileMode' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$TsFileMode' => 'SEGMENTEDFILES: Emit the program as segments - multiple .ts media files.SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.', ], ], 'HlsWebdavHttpTransferMode' => [ 'base' => NULL, 'refs' => [ 'HlsWebdavSettings$HttpTransferMode' => 'Specify whether or not to use chunked transfer encoding to WebDAV.', ], ], 'HlsWebdavSettings' => [ 'base' => NULL, 'refs' => [ 'HlsCdnSettings$HlsWebdavSettings' => NULL, ], ], 'IFrameOnlyPlaylistType' => [ 'base' => 'When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.', 'refs' => [ 'HlsGroupSettings$IFrameOnlyPlaylists' => 'DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"', ], ], 'Input' => [ 'base' => NULL, 'refs' => [ 'CreateInputResultModel$Input' => NULL, 'UpdateInputResultModel$Input' => NULL, '__listOfInput$member' => NULL, ], ], 'InputAttachment' => [ 'base' => NULL, 'refs' => [ '__listOfInputAttachment$member' => NULL, ], ], 'InputChannelLevel' => [ 'base' => NULL, 'refs' => [ '__listOfInputChannelLevel$member' => NULL, ], ], 'InputCodec' => [ 'base' => 'codec in increasing order of complexity', 'refs' => [ 'InputSpecification$Codec' => 'Input codec', ], ], 'InputDeblockFilter' => [ 'base' => NULL, 'refs' => [ 'InputSettings$DeblockFilter' => 'Enable or disable the deblock filter when filtering.', ], ], 'InputDenoiseFilter' => [ 'base' => NULL, 'refs' => [ 'InputSettings$DenoiseFilter' => 'Enable or disable the denoise filter when filtering.', ], ], 'InputDestination' => [ 'base' => 'The settings for a PUSH type input.', 'refs' => [ '__listOfInputDestination$member' => NULL, ], ], 'InputDestinationRequest' => [ 'base' => 'Endpoint settings for a PUSH type input.', 'refs' => [ '__listOfInputDestinationRequest$member' => NULL, ], ], 'InputDestinationVpc' => [ 'base' => 'The properties for a VPC type input destination.', 'refs' => [ 'InputDestination$Vpc' => NULL, ], ], 'InputFilter' => [ 'base' => NULL, 'refs' => [ 'InputSettings$InputFilter' => 'Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.1) auto - filtering will be applied depending on input type/quality2) disabled - no filtering will be applied to the input3) forced - filtering will be applied regardless of input type', ], ], 'InputLocation' => [ 'base' => NULL, 'refs' => [ 'AudioOnlyHlsSettings$AudioOnlyImage' => 'For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}.', 'AvailBlanking$AvailBlankingImage' => 'Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.', 'BlackoutSlate$BlackoutSlateImage' => 'Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.', 'BlackoutSlate$NetworkEndBlackoutImage' => 'Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.', 'BurnInDestinationSettings$Font' => 'External font file used for caption burn-in. File extension must be \'ttf\' or \'tte\'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$Font' => 'External font file used for caption burn-in. File extension must be \'ttf\' or \'tte\'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.', 'InputLossBehavior$InputLossImageSlate' => 'When input loss image type is "slate" these fields specify the parameters for accessing the slate.', 'StaticImageActivateScheduleActionSettings$Image' => 'The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.', 'StaticKeySettings$KeyProviderServer' => 'The URL of the license server used for protecting content.', ], ], 'InputLossActionForHlsOut' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$InputLossAction' => 'Parameter that control output group behavior on input loss.', ], ], 'InputLossActionForMsSmoothOut' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$InputLossAction' => 'Parameter that control output group behavior on input loss.', ], ], 'InputLossActionForRtmpOut' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$InputLossAction' => 'Controls the behavior of this RTMP group if input becomes unavailable.- emitOutput: Emit a slate until input returns.- pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.', ], ], 'InputLossActionForUdpOut' => [ 'base' => NULL, 'refs' => [ 'UdpGroupSettings$InputLossAction' => 'Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.', ], ], 'InputLossBehavior' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$InputLossBehavior' => 'Settings for system actions when input is lost.', ], ], 'InputLossImageType' => [ 'base' => NULL, 'refs' => [ 'InputLossBehavior$InputLossImageType' => 'Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.', ], ], 'InputMaximumBitrate' => [ 'base' => 'Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.', 'refs' => [ 'InputSpecification$MaximumBitrate' => 'Maximum input bitrate, categorized coarsely', ], ], 'InputResolution' => [ 'base' => 'Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines', 'refs' => [ 'InputSpecification$Resolution' => 'Input resolution, categorized coarsely', ], ], 'InputSecurityGroup' => [ 'base' => 'An Input Security Group', 'refs' => [ 'CreateInputSecurityGroupResultModel$SecurityGroup' => NULL, 'UpdateInputSecurityGroupResultModel$SecurityGroup' => NULL, '__listOfInputSecurityGroup$member' => NULL, ], ], 'InputSecurityGroupState' => [ 'base' => NULL, 'refs' => [ 'InputSecurityGroup$State' => 'The current state of the Input Security Group.', ], ], 'InputSecurityGroupWhitelistRequest' => [ 'base' => 'Request of IPv4 CIDR addresses to whitelist in a security group.', 'refs' => [], ], 'InputSettings' => [ 'base' => 'Live Event input parameters. There can be multiple inputs in a single Live Event.', 'refs' => [ 'InputAttachment$InputSettings' => 'Settings of an input (caption selector, etc.)', ], ], 'InputSource' => [ 'base' => 'The settings for a PULL type input.', 'refs' => [ '__listOfInputSource$member' => NULL, ], ], 'InputSourceEndBehavior' => [ 'base' => NULL, 'refs' => [ 'InputSettings$SourceEndBehavior' => 'Loop input if it is a file. This allows a file input to be streamed indefinitely.', ], ], 'InputSourceRequest' => [ 'base' => 'Settings for for a PULL type input.', 'refs' => [ '__listOfInputSourceRequest$member' => NULL, ], ], 'InputSpecification' => [ 'base' => NULL, 'refs' => [ 'Channel$InputSpecification' => NULL, 'ChannelSummary$InputSpecification' => NULL, 'CreateChannel$InputSpecification' => 'Specification of input for this channel (max. bitrate, resolution, codec, etc.)', 'UpdateChannel$InputSpecification' => 'Specification of input for this channel (max. bitrate, resolution, codec, etc.)', ], ], 'InputState' => [ 'base' => NULL, 'refs' => [ 'Input$State' => NULL, ], ], 'InputSwitchScheduleActionSettings' => [ 'base' => 'Settings for the action to switch an input.', 'refs' => [ 'ScheduleActionSettings$InputSwitchSettings' => 'Action to switch the input', ], ], 'InputType' => [ 'base' => NULL, 'refs' => [ 'CreateInput$Type' => NULL, 'Input$Type' => NULL, ], ], 'InputVpcRequest' => [ 'base' => 'Settings for a private VPC Input.When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.This property requires setting the roleArn property on Input creation.Not compatible with the inputSecurityGroups property.', 'refs' => [ 'CreateInput$Vpc' => NULL, ], ], 'InputWhitelistRule' => [ 'base' => 'Whitelist rule', 'refs' => [ '__listOfInputWhitelistRule$member' => NULL, ], ], 'InputWhitelistRuleCidr' => [ 'base' => 'An IPv4 CIDR to whitelist.', 'refs' => [ '__listOfInputWhitelistRuleCidr$member' => NULL, ], ], 'InternalServerErrorException' => [ 'base' => NULL, 'refs' => [], ], 'InternalServiceError' => [ 'base' => NULL, 'refs' => [], ], 'InvalidRequest' => [ 'base' => NULL, 'refs' => [], ], 'KeyProviderSettings' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$KeyProviderSettings' => 'The key provider settings.', ], ], 'LimitExceeded' => [ 'base' => NULL, 'refs' => [], ], 'ListInputSecurityGroupsResultModel' => [ 'base' => 'Result of input security group list request', 'refs' => [], ], 'ListInputsResultModel' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingsResultModel' => [ 'base' => 'ListOfferings response', 'refs' => [], ], 'ListReservationsResultModel' => [ 'base' => 'ListReservations response', 'refs' => [], ], 'LogLevel' => [ 'base' => 'The log level the user wants for their channel.', 'refs' => [ 'Channel$LogLevel' => 'The log level being written to CloudWatch Logs.', 'ChannelSummary$LogLevel' => 'The log level being written to CloudWatch Logs.', 'CreateChannel$LogLevel' => 'The log level to write to CloudWatch Logs.', 'UpdateChannel$LogLevel' => 'The log level to write to CloudWatch Logs.', ], ], 'M2tsAbsentInputAudioBehavior' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AbsentInputAudioBehavior' => 'When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.', ], ], 'M2tsArib' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Arib' => 'When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.', ], ], 'M2tsAribCaptionsPidControl' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AribCaptionsPidControl' => 'If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.', ], ], 'M2tsAudioBufferModel' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AudioBufferModel' => 'When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.', ], ], 'M2tsAudioInterval' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EbpAudioInterval' => 'When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.', ], ], 'M2tsAudioStreamType' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$AudioStreamType' => 'When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.', ], ], 'M2tsBufferModel' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$BufferModel' => 'If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.', ], ], 'M2tsCcDescriptor' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$CcDescriptor' => 'When set to enabled, generates captionServiceDescriptor in PMT.', ], ], 'M2tsEbifControl' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Ebif' => 'If set to passthrough, passes any EBIF data from the input source to this output.', ], ], 'M2tsEbpPlacement' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EbpPlacement' => 'Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.', ], ], 'M2tsEsRateInPes' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EsRateInPes' => 'Include or exclude the ES Rate field in the PES header.', ], ], 'M2tsKlv' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Klv' => 'If set to passthrough, passes any KLV data from the input source to this output.', ], ], 'M2tsPcrControl' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$PcrControl' => 'When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.', ], ], 'M2tsRateMode' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$RateMode' => 'When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.', ], ], 'M2tsScte35Control' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$Scte35Control' => 'Optionally pass SCTE-35 signals from the input source to this output.', ], ], 'M2tsSegmentationMarkers' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$SegmentationMarkers' => 'Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.', ], ], 'M2tsSegmentationStyle' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$SegmentationStyle' => 'The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.', ], ], 'M2tsSettings' => [ 'base' => NULL, 'refs' => [ 'ArchiveContainerSettings$M2tsSettings' => NULL, 'UdpContainerSettings$M2tsSettings' => NULL, ], ], 'M2tsTimedMetadataBehavior' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$TimedMetadataBehavior' => 'When set to passthrough, timed metadata will be passed through from input to output.', ], ], 'M3u8PcrControl' => [ 'base' => NULL, 'refs' => [ 'M3u8Settings$PcrControl' => 'When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.', ], ], 'M3u8Scte35Behavior' => [ 'base' => NULL, 'refs' => [ 'M3u8Settings$Scte35Behavior' => 'If set to passthrough, passes any SCTE-35 signals from the input source to this output.', ], ], 'M3u8Settings' => [ 'base' => 'Settings information for the .m3u8 container', 'refs' => [ 'StandardHlsSettings$M3u8Settings' => NULL, ], ], 'M3u8TimedMetadataBehavior' => [ 'base' => NULL, 'refs' => [ 'M3u8Settings$TimedMetadataBehavior' => 'When set to passthrough, timed metadata is passed through from input to output.', ], ], 'MediaConnectFlow' => [ 'base' => 'The settings for a MediaConnect Flow.', 'refs' => [ '__listOfMediaConnectFlow$member' => NULL, ], ], 'MediaConnectFlowRequest' => [ 'base' => 'The settings for a MediaConnect Flow.', 'refs' => [ '__listOfMediaConnectFlowRequest$member' => NULL, ], ], 'MediaPackageGroupSettings' => [ 'base' => 'Media Package Group Settings', 'refs' => [ 'OutputGroupSettings$MediaPackageGroupSettings' => NULL, ], ], 'MediaPackageOutputDestinationSettings' => [ 'base' => 'Media Package Output Destination Settings', 'refs' => [ '__listOfMediaPackageOutputDestinationSettings$member' => NULL, ], ], 'MediaPackageOutputSettings' => [ 'base' => 'Media Package Output Settings', 'refs' => [ 'OutputSettings$MediaPackageOutputSettings' => NULL, ], ], 'Mp2CodingMode' => [ 'base' => NULL, 'refs' => [ 'Mp2Settings$CodingMode' => 'The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).', ], ], 'Mp2Settings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$Mp2Settings' => NULL, ], ], 'MsSmoothGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$MsSmoothGroupSettings' => NULL, ], ], 'MsSmoothOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$MsSmoothOutputSettings' => NULL, ], ], 'NetworkInputServerValidation' => [ 'base' => NULL, 'refs' => [ 'NetworkInputSettings$ServerValidation' => 'Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server\'s name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate\'s wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.', ], ], 'NetworkInputSettings' => [ 'base' => 'Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.', 'refs' => [ 'InputSettings$NetworkInputSettings' => 'Input settings.', ], ], 'NotFoundException' => [ 'base' => NULL, 'refs' => [], ], 'Offering' => [ 'base' => 'Reserved resources available for purchase', 'refs' => [ '__listOfOffering$member' => NULL, ], ], 'OfferingDurationUnits' => [ 'base' => 'Units for duration, e.g. \'MONTHS\'', 'refs' => [ 'Offering$DurationUnits' => 'Units for duration, e.g. \'MONTHS\'', 'Reservation$DurationUnits' => 'Units for duration, e.g. \'MONTHS\'', ], ], 'OfferingType' => [ 'base' => 'Offering type, e.g. \'NO_UPFRONT\'', 'refs' => [ 'Offering$OfferingType' => 'Offering type, e.g. \'NO_UPFRONT\'', 'Reservation$OfferingType' => 'Offering type, e.g. \'NO_UPFRONT\'', ], ], 'Output' => [ 'base' => 'Output settings. There can be multiple outputs within a group.', 'refs' => [ '__listOfOutput$member' => NULL, ], ], 'OutputDestination' => [ 'base' => NULL, 'refs' => [ '__listOfOutputDestination$member' => NULL, ], ], 'OutputDestinationSettings' => [ 'base' => NULL, 'refs' => [ '__listOfOutputDestinationSettings$member' => NULL, ], ], 'OutputGroup' => [ 'base' => 'Output groups for this Live Event. Output groups contain information about where streams should be distributed.', 'refs' => [ '__listOfOutputGroup$member' => NULL, ], ], 'OutputGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroup$OutputGroupSettings' => 'Settings associated with the output group.', ], ], 'OutputLocationRef' => [ 'base' => 'Reference to an OutputDestination ID defined in the channel', 'refs' => [ 'ArchiveGroupSettings$Destination' => 'A directory and base filename where archive files should be written.', 'FrameCaptureGroupSettings$Destination' => 'The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg', 'HlsGroupSettings$Destination' => 'A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).', 'MediaPackageGroupSettings$Destination' => 'MediaPackage channel destination.', 'MsSmoothGroupSettings$Destination' => 'Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.', 'RtmpOutputSettings$Destination' => 'The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.', 'UdpOutputSettings$Destination' => 'Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).', ], ], 'OutputSettings' => [ 'base' => NULL, 'refs' => [ 'Output$OutputSettings' => 'Output type-specific settings.', ], ], 'PassThroughSettings' => [ 'base' => NULL, 'refs' => [ 'AudioCodecSettings$PassThroughSettings' => NULL, ], ], 'PauseStateScheduleActionSettings' => [ 'base' => 'Settings for the action to set pause state of a channel.', 'refs' => [ 'ScheduleActionSettings$PauseStateSettings' => 'Action to pause or unpause one or both channel pipelines', ], ], 'PipelineId' => [ 'base' => 'Pipeline ID', 'refs' => [ 'PipelinePauseStateSettings$PipelineId' => 'Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").', ], ], 'PipelinePauseStateSettings' => [ 'base' => 'Settings for pausing a pipeline.', 'refs' => [ '__listOfPipelinePauseStateSettings$member' => NULL, ], ], 'PurchaseOffering' => [ 'base' => 'PurchaseOffering request', 'refs' => [], ], 'PurchaseOfferingResultModel' => [ 'base' => 'PurchaseOffering response', 'refs' => [], ], 'RemixSettings' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$RemixSettings' => 'Settings that control how input audio channels are remixed into the output audio channels.', ], ], 'Reservation' => [ 'base' => 'Reserved resources available to use', 'refs' => [ 'PurchaseOfferingResultModel$Reservation' => NULL, '__listOfReservation$member' => NULL, ], ], 'ReservationCodec' => [ 'base' => 'Codec, \'MPEG2\', \'AVC\', \'HEVC\', or \'AUDIO\'', 'refs' => [ 'ReservationResourceSpecification$Codec' => 'Codec, e.g. \'AVC\'', ], ], 'ReservationMaximumBitrate' => [ 'base' => 'Maximum bitrate in megabits per second', 'refs' => [ 'ReservationResourceSpecification$MaximumBitrate' => 'Maximum bitrate, e.g. \'MAX_20_MBPS\'', ], ], 'ReservationMaximumFramerate' => [ 'base' => 'Maximum framerate in frames per second (Outputs only)', 'refs' => [ 'ReservationResourceSpecification$MaximumFramerate' => 'Maximum framerate, e.g. \'MAX_30_FPS\' (Outputs only)', ], ], 'ReservationResolution' => [ 'base' => 'Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines', 'refs' => [ 'ReservationResourceSpecification$Resolution' => 'Resolution, e.g. \'HD\'', ], ], 'ReservationResourceSpecification' => [ 'base' => 'Resource configuration (codec, resolution, bitrate, ...)', 'refs' => [ 'Offering$ResourceSpecification' => 'Resource configuration details', 'Reservation$ResourceSpecification' => 'Resource configuration details', ], ], 'ReservationResourceType' => [ 'base' => 'Resource type, \'INPUT\', \'OUTPUT\', or \'CHANNEL\'', 'refs' => [ 'ReservationResourceSpecification$ResourceType' => 'Resource type, \'INPUT\', \'OUTPUT\', or \'CHANNEL\'', ], ], 'ReservationSpecialFeature' => [ 'base' => 'Special features, \'ADVANCED_AUDIO\' or \'AUDIO_NORMALIZATION\'', 'refs' => [ 'ReservationResourceSpecification$SpecialFeature' => 'Special feature, e.g. \'AUDIO_NORMALIZATION\' (Channels only)', ], ], 'ReservationState' => [ 'base' => 'Current reservation state', 'refs' => [ 'Reservation$State' => 'Current state of reservation, e.g. \'ACTIVE\'', ], ], 'ReservationVideoQuality' => [ 'base' => 'Video quality, e.g. \'STANDARD\' (Outputs only)', 'refs' => [ 'ReservationResourceSpecification$VideoQuality' => 'Video quality, e.g. \'STANDARD\' (Outputs only)', ], ], 'ResourceConflict' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFound' => [ 'base' => NULL, 'refs' => [], ], 'RtmpCacheFullBehavior' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$CacheFullBehavior' => 'Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the \'Media Cache\' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.', ], ], 'RtmpCaptionData' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$CaptionData' => 'Controls the types of data that passes to onCaptionInfo outputs. If set to \'all\' then 608 and 708 carried DTVCC data will be passed. If set to \'field1AndField2608\' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to \'field1608\' then only the data carried in 608 from field 1 video will be passed.', ], ], 'RtmpCaptionInfoDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$RtmpCaptionInfoDestinationSettings' => NULL, ], ], 'RtmpGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$RtmpGroupSettings' => NULL, ], ], 'RtmpOutputCertificateMode' => [ 'base' => NULL, 'refs' => [ 'RtmpOutputSettings$CertificateMode' => 'If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.', ], ], 'RtmpOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$RtmpOutputSettings' => NULL, ], ], 'ScheduleAction' => [ 'base' => 'Contains information on a single schedule action.', 'refs' => [ '__listOfScheduleAction$member' => NULL, ], ], 'ScheduleActionSettings' => [ 'base' => 'Holds the settings for a single schedule action.', 'refs' => [ 'ScheduleAction$ScheduleActionSettings' => 'Settings for this schedule action.', ], ], 'ScheduleActionStartSettings' => [ 'base' => 'Settings to specify the start time for an action.', 'refs' => [ 'ScheduleAction$ScheduleActionStartSettings' => 'The time for the action to start in the channel.', ], ], 'ScheduleDescribeResultModel' => [ 'base' => 'Results of a schedule describe.', 'refs' => [], ], 'Scte20Convert608To708' => [ 'base' => NULL, 'refs' => [ 'Scte20SourceSettings$Convert608To708' => 'If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.', ], ], 'Scte20PlusEmbeddedDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$Scte20PlusEmbeddedDestinationSettings' => NULL, ], ], 'Scte20SourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$Scte20SourceSettings' => NULL, ], ], 'Scte27DestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$Scte27DestinationSettings' => NULL, ], ], 'Scte27SourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$Scte27SourceSettings' => NULL, ], ], 'Scte35AposNoRegionalBlackoutBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35TimeSignalApos$NoRegionalBlackoutFlag' => 'When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35AposWebDeliveryAllowedBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35TimeSignalApos$WebDeliveryAllowedFlag' => 'When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35ArchiveAllowedFlag' => [ 'base' => 'Corresponds to the archive_allowed parameter. A value of ARCHIVE_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$ArchiveAllowedFlag' => 'Corresponds to SCTE-35 archive_allowed_flag.', ], ], 'Scte35DeliveryRestrictions' => [ 'base' => 'Corresponds to SCTE-35 delivery_not_restricted_flag parameter. To declare delivery restrictions, include this element and its four "restriction" flags. To declare that there are no restrictions, omit this element.', 'refs' => [ 'Scte35SegmentationDescriptor$DeliveryRestrictions' => 'Holds the four SCTE-35 delivery restriction parameters.', ], ], 'Scte35Descriptor' => [ 'base' => 'Holds one set of SCTE-35 Descriptor Settings.', 'refs' => [ '__listOfScte35Descriptor$member' => NULL, ], ], 'Scte35DescriptorSettings' => [ 'base' => 'SCTE-35 Descriptor settings.', 'refs' => [ 'Scte35Descriptor$Scte35DescriptorSettings' => 'SCTE-35 Descriptor Settings.', ], ], 'Scte35DeviceRestrictions' => [ 'base' => 'Corresponds to the device_restrictions parameter in a segmentation_descriptor. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$DeviceRestrictions' => 'Corresponds to SCTE-35 device_restrictions parameter.', ], ], 'Scte35NoRegionalBlackoutFlag' => [ 'base' => 'Corresponds to the no_regional_blackout_flag parameter. A value of REGIONAL_BLACKOUT corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$NoRegionalBlackoutFlag' => 'Corresponds to SCTE-35 no_regional_blackout_flag parameter.', ], ], 'Scte35ReturnToNetworkScheduleActionSettings' => [ 'base' => 'Settings for a SCTE-35 return_to_network message.', 'refs' => [ 'ScheduleActionSettings$Scte35ReturnToNetworkSettings' => 'Action to insert SCTE-35 return_to_network message', ], ], 'Scte35SegmentationCancelIndicator' => [ 'base' => 'Corresponds to SCTE-35 segmentation_event_cancel_indicator. SEGMENTATION_EVENT_NOT_CANCELED corresponds to 0 in the SCTE-35 specification and indicates that this is an insertion request. SEGMENTATION_EVENT_CANCELED corresponds to 1 in the SCTE-35 specification and indicates that this is a cancelation request, in which case complete this field and the existing event ID to cancel.', 'refs' => [ 'Scte35SegmentationDescriptor$SegmentationCancelIndicator' => 'Corresponds to SCTE-35 segmentation_event_cancel_indicator.', ], ], 'Scte35SegmentationDescriptor' => [ 'base' => 'Corresponds to SCTE-35 segmentation_descriptor.', 'refs' => [ 'Scte35DescriptorSettings$SegmentationDescriptorScte35DescriptorSettings' => 'SCTE-35 Segmentation Descriptor.', ], ], 'Scte35SpliceInsert' => [ 'base' => NULL, 'refs' => [ 'AvailSettings$Scte35SpliceInsert' => NULL, ], ], 'Scte35SpliceInsertNoRegionalBlackoutBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsert$NoRegionalBlackoutFlag' => 'When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35SpliceInsertScheduleActionSettings' => [ 'base' => 'Settings for a SCTE-35 splice_insert message.', 'refs' => [ 'ScheduleActionSettings$Scte35SpliceInsertSettings' => 'Action to insert SCTE-35 splice_insert message', ], ], 'Scte35SpliceInsertWebDeliveryAllowedBehavior' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsert$WebDeliveryAllowedFlag' => 'When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates', ], ], 'Scte35TimeSignalApos' => [ 'base' => NULL, 'refs' => [ 'AvailSettings$Scte35TimeSignalApos' => NULL, ], ], 'Scte35TimeSignalScheduleActionSettings' => [ 'base' => 'Settings for a SCTE-35 time_signal.', 'refs' => [ 'ScheduleActionSettings$Scte35TimeSignalSettings' => 'Action to insert SCTE-35 time_signal message', ], ], 'Scte35WebDeliveryAllowedFlag' => [ 'base' => 'Corresponds to the web_delivery_allowed_flag parameter. A value of WEB_DELIVERY_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.', 'refs' => [ 'Scte35DeliveryRestrictions$WebDeliveryAllowedFlag' => 'Corresponds to SCTE-35 web_delivery_allowed_flag parameter.', ], ], 'SmoothGroupAudioOnlyTimecodeControl' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$AudioOnlyTimecodeControl' => 'If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.', ], ], 'SmoothGroupCertificateMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$CertificateMode' => 'If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.', ], ], 'SmoothGroupEventIdMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$EventIdMode' => 'Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.Options:- "useConfigured" - use the value provided in eventId- "useTimestamp" - generate and send an event ID based on the current timestamp- "noEventId" - do not send an event ID to the IIS server.', ], ], 'SmoothGroupEventStopBehavior' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$EventStopBehavior' => 'When set to sendEos, send EOS signal to IIS server when stopping the event', ], ], 'SmoothGroupSegmentationMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$SegmentationMode' => 'useInputSegmentation has been deprecated. The configured segment size is always used.', ], ], 'SmoothGroupSparseTrackType' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$SparseTrackType' => 'If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.', ], ], 'SmoothGroupStreamManifestBehavior' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$StreamManifestBehavior' => 'When set to send, send stream manifest so publishing point doesn\'t start until all streams start.', ], ], 'SmoothGroupTimestampOffsetMode' => [ 'base' => NULL, 'refs' => [ 'MsSmoothGroupSettings$TimestampOffsetMode' => 'Type of timestamp date offset to use.- useEventStartDate: Use the date the event was started as the offset- useConfiguredOffset: Use an explicitly configured date as the offset', ], ], 'SmpteTtDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$SmpteTtDestinationSettings' => NULL, ], ], 'StandardHlsSettings' => [ 'base' => NULL, 'refs' => [ 'HlsSettings$StandardHlsSettings' => NULL, ], ], 'StaticImageActivateScheduleActionSettings' => [ 'base' => 'Settings for the action to activate a static image.', 'refs' => [ 'ScheduleActionSettings$StaticImageActivateSettings' => 'Action to activate a static image overlay', ], ], 'StaticImageDeactivateScheduleActionSettings' => [ 'base' => 'Settings for the action to deactivate the image in a specific layer.', 'refs' => [ 'ScheduleActionSettings$StaticImageDeactivateSettings' => 'Action to deactivate a static image overlay', ], ], 'StaticKeySettings' => [ 'base' => NULL, 'refs' => [ 'KeyProviderSettings$StaticKeySettings' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'Channel$Tags' => 'A collection of key-value pairs.', 'ChannelSummary$Tags' => 'A collection of key-value pairs.', 'CreateChannel$Tags' => 'A collection of key-value pairs.', 'CreateInput$Tags' => 'A collection of key-value pairs.', 'Input$Tags' => 'A collection of key-value pairs.', 'InputSecurityGroup$Tags' => 'A collection of key-value pairs.', 'InputSecurityGroupWhitelistRequest$Tags' => 'A collection of key-value pairs.', 'TagsModel$Tags' => NULL, ], ], 'TagsModel' => [ 'base' => NULL, 'refs' => [], ], 'TeletextDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$TeletextDestinationSettings' => NULL, ], ], 'TeletextSourceSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionSelectorSettings$TeletextSourceSettings' => NULL, ], ], 'TimecodeConfig' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$TimecodeConfig' => 'Contains settings used to acquire and adjust timecode information from inputs.', ], ], 'TimecodeConfigSource' => [ 'base' => NULL, 'refs' => [ 'TimecodeConfig$Source' => 'Identifies the source for the timecode that will be associated with the events outputs.-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased).-System Clock (systemclock): Use the UTC time.-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.', ], ], 'TooManyRequestsException' => [ 'base' => NULL, 'refs' => [], ], 'TtmlDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$TtmlDestinationSettings' => NULL, ], ], 'TtmlDestinationStyleControl' => [ 'base' => NULL, 'refs' => [ 'TtmlDestinationSettings$StyleControl' => 'When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.', ], ], 'UdpContainerSettings' => [ 'base' => NULL, 'refs' => [ 'UdpOutputSettings$ContainerSettings' => NULL, ], ], 'UdpGroupSettings' => [ 'base' => NULL, 'refs' => [ 'OutputGroupSettings$UdpGroupSettings' => NULL, ], ], 'UdpOutputSettings' => [ 'base' => NULL, 'refs' => [ 'OutputSettings$UdpOutputSettings' => NULL, ], ], 'UdpTimedMetadataId3Frame' => [ 'base' => NULL, 'refs' => [ 'UdpGroupSettings$TimedMetadataId3Frame' => 'Indicates ID3 frame that has the timecode.', ], ], 'UnprocessableEntityException' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannel' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannelResultModel' => [ 'base' => 'The updated channel\'s description.', 'refs' => [], ], 'UpdateInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInputResultModel' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInputSecurityGroupResultModel' => [ 'base' => NULL, 'refs' => [], ], 'ValidationError' => [ 'base' => NULL, 'refs' => [ '__listOfValidationError$member' => NULL, ], ], 'VideoCodecSettings' => [ 'base' => NULL, 'refs' => [ 'VideoDescription$CodecSettings' => 'Video codec settings.', ], ], 'VideoDescription' => [ 'base' => 'Video settings for this stream.', 'refs' => [ '__listOfVideoDescription$member' => NULL, ], ], 'VideoDescriptionRespondToAfd' => [ 'base' => NULL, 'refs' => [ 'VideoDescription$RespondToAfd' => 'Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.', ], ], 'VideoDescriptionScalingBehavior' => [ 'base' => NULL, 'refs' => [ 'VideoDescription$ScalingBehavior' => 'STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.', ], ], 'VideoSelector' => [ 'base' => 'Specifies a particular video stream within an input source. An input may have only a single video selector.', 'refs' => [ 'InputSettings$VideoSelector' => 'Informs which video elementary stream to decode for input types that have multiple available.', ], ], 'VideoSelectorColorSpace' => [ 'base' => NULL, 'refs' => [ 'VideoSelector$ColorSpace' => 'Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed.', ], ], 'VideoSelectorColorSpaceUsage' => [ 'base' => NULL, 'refs' => [ 'VideoSelector$ColorSpaceUsage' => 'Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.', ], ], 'VideoSelectorPid' => [ 'base' => NULL, 'refs' => [ 'VideoSelectorSettings$VideoSelectorPid' => NULL, ], ], 'VideoSelectorProgramId' => [ 'base' => NULL, 'refs' => [ 'VideoSelectorSettings$VideoSelectorProgramId' => NULL, ], ], 'VideoSelectorSettings' => [ 'base' => NULL, 'refs' => [ 'VideoSelector$SelectorSettings' => 'The video selector settings.', ], ], 'WebvttDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'CaptionDestinationSettings$WebvttDestinationSettings' => NULL, ], ], '__double' => [ 'base' => NULL, 'refs' => [ 'AacSettings$Bitrate' => 'Average bitrate in bits/second. Valid values depend on rate control mode and profile.', 'AacSettings$SampleRate' => 'Sample rate in Hz. Valid values depend on rate control mode and profile.', 'Ac3Settings$Bitrate' => 'Average bitrate in bits/second. Valid bitrates depend on the coding mode.', 'Eac3Settings$Bitrate' => 'Average bitrate in bits/second. Valid bitrates depend on the coding mode.', 'Eac3Settings$LoRoCenterMixLevel' => 'Left only/Right only center mix level. Only used for 3/2 coding mode.', 'Eac3Settings$LoRoSurroundMixLevel' => 'Left only/Right only surround mix level. Only used for 3/2 coding mode.', 'Eac3Settings$LtRtCenterMixLevel' => 'Left total/Right total center mix level. Only used for 3/2 coding mode.', 'Eac3Settings$LtRtSurroundMixLevel' => 'Left total/Right total surround mix level. Only used for 3/2 coding mode.', 'Mp2Settings$Bitrate' => 'Average bitrate in bits/second.', 'Mp2Settings$SampleRate' => 'Sample rate in Hz.', 'Offering$FixedPrice' => 'One-time charge for each reserved resource, e.g. \'0.0\' for a NO_UPFRONT offering', 'Offering$UsagePrice' => 'Recurring usage charge for each reserved resource, e.g. \'157.0\'', 'Reservation$FixedPrice' => 'One-time charge for each reserved resource, e.g. \'0.0\' for a NO_UPFRONT offering', 'Reservation$UsagePrice' => 'Recurring usage charge for each reserved resource, e.g. \'157.0\'', ], ], '__doubleMin0' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$FragmentTime' => 'The length in seconds of each fragment. Only used with EBP markers.', 'M2tsSettings$NullPacketBitrate' => 'Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.', ], ], '__doubleMin1' => [ 'base' => NULL, 'refs' => [ 'H264Settings$GopSize' => 'GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.', 'M2tsSettings$SegmentationTime' => 'The length in seconds of each segment. Required unless markers is set to None_.', ], ], '__doubleMinNegative59Max0' => [ 'base' => NULL, 'refs' => [ 'AudioNormalizationSettings$TargetLkfs' => 'Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$ShadowXOffset' => 'Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$ShadowYOffset' => 'Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.', 'Channel$PipelinesRunningCount' => 'The number of currently healthy pipelines.', 'ChannelSummary$PipelinesRunningCount' => 'The number of currently healthy pipelines.', 'DvbSubDestinationSettings$ShadowXOffset' => 'Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$ShadowYOffset' => 'Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.', 'H264Settings$ParNumerator' => 'Pixel Aspect Ratio numerator.', 'Offering$Duration' => 'Lease duration, e.g. \'12\'', 'Reservation$Count' => 'Number of reserved resources', 'Reservation$Duration' => 'Lease duration, e.g. \'12\'', 'VideoDescription$Height' => 'Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.', 'VideoDescription$Width' => 'Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.', ], ], '__integerMin0' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$XPosition' => 'Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$YPosition' => 'Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$XPosition' => 'Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$YPosition' => 'Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', 'H264Settings$BufSize' => 'Size of buffer (HRD buffer model) in bits/second.', 'H264Settings$GopClosedCadence' => 'Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.', 'HlsAkamaiSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsAkamaiSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'HlsBasicPutSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsBasicPutSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'HlsGroupSettings$MinSegmentLength' => 'When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.', 'HlsGroupSettings$TimedMetadataId3Period' => 'Timed Metadata interval in seconds.', 'HlsGroupSettings$TimestampDeltaMilliseconds' => 'Provides an extra millisecond delta offset to fine tune the timestamps.', 'HlsInputSettings$Bandwidth' => 'When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.', 'HlsInputSettings$BufferSegments' => 'When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.', 'HlsInputSettings$Retries' => 'The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.', 'HlsInputSettings$RetryInterval' => 'The number of seconds between retries when an attempt to read a manifest or segment fails.', 'HlsMediaStoreSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsMediaStoreSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'HlsWebdavSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the CDN if the connection is lost.', 'HlsWebdavSettings$NumRetries' => 'Number of retry attempts that will be made before the Live Event is put into an error state.', 'M2tsSettings$AudioFramesPerPes' => 'The number of audio frames to insert for each PES packet.', 'M2tsSettings$Bitrate' => 'The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.', 'M3u8Settings$AudioFramesPerPes' => 'The number of audio frames to insert for each PES packet.', 'MsSmoothGroupSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.', 'MsSmoothGroupSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'MsSmoothGroupSettings$NumRetries' => 'Number of retry attempts.', 'MsSmoothGroupSettings$RestartDelay' => 'Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.', 'RtmpGroupSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'RtmpOutputSettings$NumRetries' => 'Number of retry attempts.', 'StaticImageActivateScheduleActionSettings$Duration' => 'The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.', 'StaticImageActivateScheduleActionSettings$FadeIn' => 'The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).', 'StaticImageActivateScheduleActionSettings$FadeOut' => 'Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).', 'StaticImageActivateScheduleActionSettings$ImageX' => 'Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.', 'StaticImageActivateScheduleActionSettings$ImageY' => 'Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.', 'StaticImageDeactivateScheduleActionSettings$FadeOut' => 'The time in milliseconds for the image to fade out. Default is 0 (no fade-out).', 'UdpGroupSettings$TimedMetadataId3Period' => 'Timed Metadata interval in seconds.', ], ], '__integerMin0Max10' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$OutlineSize' => 'Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$OutlineSize' => 'Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.', ], ], '__integerMin0Max100' => [ 'base' => NULL, 'refs' => [ 'H264Settings$BufFillPct' => 'Percentage of the buffer that should initially be filled (HRD buffer model).', 'StaticImageActivateScheduleActionSettings$Opacity' => 'Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.', 'VideoDescription$Sharpness' => 'Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.', ], ], '__integerMin0Max1000' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$PatInterval' => 'The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.', 'M2tsSettings$PmtInterval' => 'The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.', 'M3u8Settings$PatInterval' => 'The number of milliseconds between instances of this table in the output transport stream. A value of \\"0\\" writes out the PMT once per segment file.', 'M3u8Settings$PmtInterval' => 'The number of milliseconds between instances of this table in the output transport stream. A value of \\"0\\" writes out the PMT once per segment file.', ], ], '__integerMin0Max10000' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$EbpLookaheadMs' => 'When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.', 'MsSmoothGroupSettings$SendDelayMs' => 'Number of milliseconds to delay the output from the second pipeline.', 'UdpOutputSettings$BufferMsec' => 'UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.', ], ], '__integerMin0Max1000000' => [ 'base' => NULL, 'refs' => [ 'InputLossBehavior$BlackFrameMsec' => 'On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite.', 'InputLossBehavior$RepeatFrameMsec' => 'On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite.', ], ], '__integerMin0Max1099511627775' => [ 'base' => NULL, 'refs' => [ 'Scte35SegmentationDescriptor$SegmentationDuration' => 'Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.', ], ], '__integerMin0Max128' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Softness' => 'Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.', ], ], '__integerMin0Max15' => [ 'base' => NULL, 'refs' => [ 'HlsAkamaiSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'HlsBasicPutSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'HlsMediaStoreSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'HlsWebdavSettings$RestartDelay' => 'If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.', 'InputChannelLevel$InputChannel' => 'The index of the input channel used as a source.', ], ], '__integerMin0Max255' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$BackgroundOpacity' => 'Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$FontOpacity' => 'Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.', 'BurnInDestinationSettings$ShadowOpacity' => 'Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$BackgroundOpacity' => 'Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$FontOpacity' => 'Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$ShadowOpacity' => 'Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.', 'Scte35SegmentationDescriptor$SegmentNum' => 'Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.', 'Scte35SegmentationDescriptor$SegmentationTypeId' => 'Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").', 'Scte35SegmentationDescriptor$SegmentationUpidType' => 'Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").', 'Scte35SegmentationDescriptor$SegmentsExpected' => 'Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.', 'Scte35SegmentationDescriptor$SubSegmentNum' => 'Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.', 'Scte35SegmentationDescriptor$SubSegmentsExpected' => 'Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.', ], ], '__integerMin0Max30' => [ 'base' => NULL, 'refs' => [ 'H264Settings$MinIInterval' => 'Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1', ], ], '__integerMin0Max3600' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ProgramDateTimePeriod' => 'Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.', ], ], '__integerMin0Max4294967295' => [ 'base' => NULL, 'refs' => [ 'Scte35ReturnToNetworkScheduleActionSettings$SpliceEventId' => 'The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.', 'Scte35SegmentationDescriptor$SegmentationEventId' => 'Corresponds to SCTE-35 segmentation_event_id. ', 'Scte35SpliceInsertScheduleActionSettings$SpliceEventId' => 'The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.', ], ], '__integerMin0Max500' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$PcrPeriod' => 'Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.', 'M3u8Settings$PcrPeriod' => 'Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.', ], ], '__integerMin0Max600' => [ 'base' => NULL, 'refs' => [ 'HlsAkamaiSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'HlsBasicPutSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'HlsMediaStoreSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', 'HlsWebdavSettings$FilecacheDuration' => 'Size in seconds of file cache for streaming outputs.', ], ], '__integerMin0Max65535' => [ 'base' => NULL, 'refs' => [ 'M2tsSettings$ProgramNum' => 'The value of the program number field in the Program Map Table.', 'M2tsSettings$TransportStreamId' => 'The value of the transport stream ID field in the Program Map Table.', 'M3u8Settings$ProgramNum' => 'The value of the program number field in the Program Map Table.', 'M3u8Settings$TransportStreamId' => 'The value of the transport stream ID field in the Program Map Table.', ], ], '__integerMin0Max65536' => [ 'base' => NULL, 'refs' => [ 'DvbNitSettings$NetworkId' => 'The numeric value placed in the Network Information Table (NIT).', 'VideoSelectorProgramId$ProgramId' => 'Selects a specific program from within a multi-program transport stream. If the program doesn\'t exist, the first program within the transport stream will be selected by default.', ], ], '__integerMin0Max7' => [ 'base' => NULL, 'refs' => [ 'AudioChannelMapping$OutputChannel' => 'The index of the output channel being produced.', 'H264Settings$GopNumBFrames' => 'Number of B-frames between reference frames.', 'StaticImageActivateScheduleActionSettings$Layer' => 'The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.', 'StaticImageDeactivateScheduleActionSettings$Layer' => 'The image overlay layer to deactivate, 0 to 7. Default is 0.', ], ], '__integerMin0Max8191' => [ 'base' => NULL, 'refs' => [ 'AudioPidSelection$Pid' => 'Selects a specific PID from within a source.', 'VideoSelectorPid$Pid' => 'Selects a specific PID from within a video source.', ], ], '__integerMin0Max8589934591' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsertScheduleActionSettings$Duration' => 'Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.', ], ], '__integerMin1' => [ 'base' => NULL, 'refs' => [ 'ArchiveGroupSettings$RolloverInterval' => 'Number of seconds to write to archive file before closing and starting a new one.', 'DvbSubSourceSettings$Pid' => 'When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.', 'H264Settings$FramerateDenominator' => 'Framerate denominator.', 'H264Settings$FramerateNumerator' => 'Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.', 'H264Settings$ParDenominator' => 'Pixel Aspect Ratio denominator.', 'HlsGroupSettings$KeepSegments' => 'Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.', 'HlsGroupSettings$SegmentLength' => 'Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.', 'HlsGroupSettings$SegmentsPerSubdirectory' => 'Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.', 'MsSmoothGroupSettings$FragmentLength' => 'Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.', 'PurchaseOffering$Count' => 'Number of resources', 'RtmpOutputSettings$ConnectionRetryInterval' => 'Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.', 'Scte27SourceSettings$Pid' => 'The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.', 'StaticImageActivateScheduleActionSettings$Height' => 'The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.', 'StaticImageActivateScheduleActionSettings$Width' => 'The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.', ], ], '__integerMin1000' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Bitrate' => 'Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.', 'H264Settings$MaxBitrate' => 'For QVBR: See the tooltip for Quality levelFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.', ], ], '__integerMin1000Max30000' => [ 'base' => NULL, 'refs' => [ 'DvbTdtSettings$RepInterval' => 'The number of milliseconds between instances of this table in the output transport stream.', ], ], '__integerMin1Max10' => [ 'base' => NULL, 'refs' => [ 'H264Settings$QvbrQualityLevel' => 'Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:- Primary screen: Quality level: 8 to 10. Max bitrate: 4M- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M', ], ], '__integerMin1Max1000000' => [ 'base' => NULL, 'refs' => [ 'TimecodeConfig$SyncThreshold' => 'Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.', ], ], '__integerMin1Max16' => [ 'base' => NULL, 'refs' => [ 'RemixSettings$ChannelsIn' => 'Number of input channels to be used.', ], ], '__integerMin1Max20' => [ 'base' => NULL, 'refs' => [ 'FecOutputSettings$RowLength' => 'Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.', ], ], '__integerMin1Max31' => [ 'base' => NULL, 'refs' => [ 'Ac3Settings$Dialnorm' => 'Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.', 'Eac3Settings$Dialnorm' => 'Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.', ], ], '__integerMin1Max32' => [ 'base' => NULL, 'refs' => [ 'H264Settings$Slices' => 'Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.', ], ], '__integerMin1Max3600' => [ 'base' => NULL, 'refs' => [ 'FrameCaptureSettings$CaptureInterval' => 'The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.', ], ], '__integerMin1Max4' => [ 'base' => NULL, 'refs' => [ 'CaptionLanguageMapping$CaptionChannel' => 'The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)', 'EmbeddedSourceSettings$Source608ChannelNumber' => 'Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.', 'Scte20SourceSettings$Source608ChannelNumber' => 'Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.', ], ], '__integerMin1Max5' => [ 'base' => NULL, 'refs' => [ 'EmbeddedSourceSettings$Source608TrackNumber' => 'This field is unused and deprecated.', 'InputSettings$FilterStrength' => 'Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).', ], ], '__integerMin1Max6' => [ 'base' => NULL, 'refs' => [ 'H264Settings$NumRefFrames' => 'Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.', ], ], '__integerMin1Max8' => [ 'base' => NULL, 'refs' => [ 'RemixSettings$ChannelsOut' => 'Number of output channels to be produced.Valid values: 1, 2, 4, 6, 8', ], ], '__integerMin25Max10000' => [ 'base' => NULL, 'refs' => [ 'DvbNitSettings$RepInterval' => 'The number of milliseconds between instances of this table in the output transport stream.', ], ], '__integerMin25Max2000' => [ 'base' => NULL, 'refs' => [ 'DvbSdtSettings$RepInterval' => 'The number of milliseconds between instances of this table in the output transport stream.', ], ], '__integerMin3' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$IndexNSegments' => 'Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.', ], ], '__integerMin30' => [ 'base' => NULL, 'refs' => [ 'RtmpGroupSettings$CacheLength' => 'Cache length, in seconds, is used to calculate buffer size.', ], ], '__integerMin4Max20' => [ 'base' => NULL, 'refs' => [ 'FecOutputSettings$ColumnDepth' => 'Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.', ], ], '__integerMin96Max600' => [ 'base' => NULL, 'refs' => [ 'BurnInDestinationSettings$FontResolution' => 'Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.', 'DvbSubDestinationSettings$FontResolution' => 'Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.', ], ], '__integerMinNegative1000Max1000' => [ 'base' => NULL, 'refs' => [ 'Scte35SpliceInsert$AdAvailOffset' => 'When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.', 'Scte35TimeSignalApos$AdAvailOffset' => 'When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.', ], ], '__integerMinNegative60Max6' => [ 'base' => NULL, 'refs' => [ 'InputChannelLevel$Gain' => 'Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.', ], ], '__integerMinNegative60Max60' => [ 'base' => NULL, 'refs' => [ 'GlobalConfiguration$InitialAudioGain' => 'Value to set the initial audio gain for the Live Event.', ], ], '__listOfAudioChannelMapping' => [ 'base' => NULL, 'refs' => [ 'RemixSettings$ChannelMappings' => 'Mapping of input channels to output channels, with appropriate gain adjustments.', ], ], '__listOfAudioDescription' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$AudioDescriptions' => NULL, ], ], '__listOfAudioSelector' => [ 'base' => NULL, 'refs' => [ 'InputSettings$AudioSelectors' => 'Used to select the audio stream to decode for inputs that have multiple available.', ], ], '__listOfCaptionDescription' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$CaptionDescriptions' => 'Settings for caption decriptions', ], ], '__listOfCaptionLanguageMapping' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$CaptionLanguageMappings' => 'Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".', ], ], '__listOfCaptionSelector' => [ 'base' => NULL, 'refs' => [ 'InputSettings$CaptionSelectors' => 'Used to select the caption input to use for inputs that have multiple available.', ], ], '__listOfChannelEgressEndpoint' => [ 'base' => NULL, 'refs' => [ 'Channel$EgressEndpoints' => 'The endpoints where outgoing connections initiate from', 'ChannelSummary$EgressEndpoints' => 'The endpoints where outgoing connections initiate from', ], ], '__listOfChannelSummary' => [ 'base' => NULL, 'refs' => [ 'ListChannelsResultModel$Channels' => NULL, ], ], '__listOfHlsAdMarkers' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$AdMarkers' => 'Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.', ], ], '__listOfInput' => [ 'base' => NULL, 'refs' => [ 'ListInputsResultModel$Inputs' => NULL, ], ], '__listOfInputAttachment' => [ 'base' => NULL, 'refs' => [ 'Channel$InputAttachments' => 'List of input attachments for channel.', 'ChannelSummary$InputAttachments' => 'List of input attachments for channel.', 'CreateChannel$InputAttachments' => 'List of input attachments for channel.', 'UpdateChannel$InputAttachments' => NULL, ], ], '__listOfInputChannelLevel' => [ 'base' => NULL, 'refs' => [ 'AudioChannelMapping$InputChannelLevels' => 'Indices and gain values for each input channel that should be remixed into this output channel.', ], ], '__listOfInputDestination' => [ 'base' => NULL, 'refs' => [ 'Input$Destinations' => 'A list of the destinations of the input (PUSH-type).', ], ], '__listOfInputDestinationRequest' => [ 'base' => NULL, 'refs' => [ 'CreateInput$Destinations' => 'Destination settings for PUSH type inputs.', 'UpdateInput$Destinations' => 'Destination settings for PUSH type inputs.', ], ], '__listOfInputSecurityGroup' => [ 'base' => NULL, 'refs' => [ 'ListInputSecurityGroupsResultModel$InputSecurityGroups' => 'List of input security groups', ], ], '__listOfInputSource' => [ 'base' => NULL, 'refs' => [ 'Input$Sources' => 'A list of the sources of the input (PULL-type).', ], ], '__listOfInputSourceRequest' => [ 'base' => NULL, 'refs' => [ 'CreateInput$Sources' => 'The source URLs for a PULL-type input. Every PULL type input needsexactly two source URLs for redundancy.Only specify sources for PULL type Inputs. Leave Destinations empty.', 'UpdateInput$Sources' => 'The source URLs for a PULL-type input. Every PULL type input needsexactly two source URLs for redundancy.Only specify sources for PULL type Inputs. Leave Destinations empty.', ], ], '__listOfInputWhitelistRule' => [ 'base' => NULL, 'refs' => [ 'InputSecurityGroup$WhitelistRules' => 'Whitelist rules and their sync status', ], ], '__listOfInputWhitelistRuleCidr' => [ 'base' => NULL, 'refs' => [ 'InputSecurityGroupWhitelistRequest$WhitelistRules' => 'List of IPv4 CIDR addresses to whitelist', ], ], '__listOfMediaConnectFlow' => [ 'base' => NULL, 'refs' => [ 'Input$MediaConnectFlows' => 'A list of MediaConnect Flows for this input.', ], ], '__listOfMediaConnectFlowRequest' => [ 'base' => NULL, 'refs' => [ 'CreateInput$MediaConnectFlows' => 'A list of the MediaConnect Flows that you want to use in this input. You can specify as few as oneFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in aseparate Availability Zone as this ensures your EML input is redundant to AZ issues.', 'UpdateInput$MediaConnectFlows' => 'A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as oneFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in aseparate Availability Zone as this ensures your EML input is redundant to AZ issues.', ], ], '__listOfMediaPackageOutputDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'OutputDestination$MediaPackageSettings' => 'Destination settings for a MediaPackage output; one destination for both encoders.', ], ], '__listOfOffering' => [ 'base' => NULL, 'refs' => [ 'ListOfferingsResultModel$Offerings' => 'List of offerings', ], ], '__listOfOutput' => [ 'base' => NULL, 'refs' => [ 'OutputGroup$Outputs' => NULL, ], ], '__listOfOutputDestination' => [ 'base' => NULL, 'refs' => [ 'Channel$Destinations' => 'A list of destinations of the channel. For UDP outputs, there is onedestination per output. For other types (HLS, for example), there isone destination per packager.', 'ChannelSummary$Destinations' => 'A list of destinations of the channel. For UDP outputs, there is onedestination per output. For other types (HLS, for example), there isone destination per packager.', 'CreateChannel$Destinations' => NULL, 'UpdateChannel$Destinations' => 'A list of output destinations for this channel.', ], ], '__listOfOutputDestinationSettings' => [ 'base' => NULL, 'refs' => [ 'OutputDestination$Settings' => 'Destination settings for a standard output; one destination for each redundant encoder.', ], ], '__listOfOutputGroup' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$OutputGroups' => NULL, ], ], '__listOfPipelinePauseStateSettings' => [ 'base' => NULL, 'refs' => [ 'PauseStateScheduleActionSettings$Pipelines' => NULL, ], ], '__listOfReservation' => [ 'base' => NULL, 'refs' => [ 'ListReservationsResultModel$Reservations' => 'List of reservations', ], ], '__listOfScheduleAction' => [ 'base' => NULL, 'refs' => [ 'BatchScheduleActionCreateRequest$ScheduleActions' => 'A list of schedule actions to create.', 'BatchScheduleActionCreateResult$ScheduleActions' => 'List of actions that have been created in the schedule.', 'BatchScheduleActionDeleteResult$ScheduleActions' => 'List of actions that have been deleted from the schedule.', 'ScheduleDescribeResultModel$ScheduleActions' => 'The list of actions in the schedule.', ], ], '__listOfScte35Descriptor' => [ 'base' => NULL, 'refs' => [ 'Scte35TimeSignalScheduleActionSettings$Scte35Descriptors' => 'The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.', ], ], '__listOfValidationError' => [ 'base' => NULL, 'refs' => [ 'ChannelConfigurationValidationError$ValidationErrors' => 'A collection of validation error responses.', ], ], '__listOfVideoDescription' => [ 'base' => NULL, 'refs' => [ 'EncoderSettings$VideoDescriptions' => NULL, ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'BatchScheduleActionDeleteRequest$ActionNames' => 'A list of schedule actions to delete.', 'CreateInput$InputSecurityGroups' => 'A list of security groups referenced by IDs to attach to the input.', 'Input$AttachedChannels' => 'A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).', 'Input$SecurityGroups' => 'A list of IDs for all the Input Security Groups attached to the input.', 'InputSecurityGroup$Inputs' => 'The list of inputs currently using this Input Security Group.', 'InputVpcRequest$SecurityGroupIds' => 'A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces.Requires subnetIds. If none are specified then the VPC default security group will be used.', 'InputVpcRequest$SubnetIds' => 'A list of 2 VPC subnet IDs from the same VPC.Subnet IDs must be mapped to two unique availability zones (AZ).', 'Output$AudioDescriptionNames' => 'The names of the AudioDescriptions used as audio sources for this output.', 'Output$CaptionDescriptionNames' => 'The names of the CaptionDescriptions used as caption sources for this output.', 'UpdateInput$InputSecurityGroups' => 'A list of security groups referenced by IDs to attach to the input.', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'AccessDenied$Message' => NULL, 'ArchiveOutputSettings$Extension' => 'Output file extension. If excluded, this will be auto-selected from the container type.', 'ArchiveOutputSettings$NameModifier' => 'String concatenated to the end of the destination filename. Required for multiple outputs of the same type.', 'AudioDescription$AudioSelectorName' => 'The name of the AudioSelector used as the source for this AudioDescription.', 'AudioDescription$Name' => 'The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.', 'AudioDescription$StreamName' => 'Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).', 'AudioLanguageSelection$LanguageCode' => 'Selects a specific three-letter language code from within an audio source.', 'AudioOnlyHlsSettings$AudioGroupId' => 'Specifies the group to which the audio Rendition belongs.', 'BadGatewayException$Message' => NULL, 'BurnInDestinationSettings$FontSize' => 'When set to \'auto\' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.', 'CaptionDescription$CaptionSelectorName' => 'Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.', 'CaptionDescription$LanguageCode' => 'ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/', 'CaptionDescription$LanguageDescription' => 'Human readable information to indicate captions available for players (eg. English, or Spanish).', 'CaptionDescription$Name' => 'Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.', 'CaptionSelector$LanguageCode' => 'When specified this field indicates the three letter language code of the caption track to extract from the source.', 'Channel$Arn' => 'The unique arn of the channel.', 'Channel$Id' => 'The unique id of the channel.', 'Channel$Name' => 'The name of the channel. (user-mutable)', 'Channel$RoleArn' => 'The Amazon Resource Name (ARN) of the role assumed when running the Channel.', 'ChannelConfigurationValidationError$Message' => NULL, 'ChannelEgressEndpoint$SourceIp' => 'Public IP of where a channel\'s output comes from', 'ChannelSummary$Arn' => 'The unique arn of the channel.', 'ChannelSummary$Id' => 'The unique id of the channel.', 'ChannelSummary$Name' => 'The name of the channel. (user-mutable)', 'ChannelSummary$RoleArn' => 'The Amazon Resource Name (ARN) of the role assumed when running the Channel.', 'CreateChannel$Name' => 'Name of channel.', 'CreateChannel$RequestId' => 'Unique request ID to be specified. This is needed to prevent retries fromcreating multiple resources.', 'CreateChannel$Reserved' => 'Deprecated field that\'s only usable by whitelisted customers.', 'CreateChannel$RoleArn' => 'An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.', 'CreateInput$Name' => 'Name of the input.', 'CreateInput$RequestId' => 'Unique identifier of the request to ensure the request is handledexactly once in case of retries.', 'CreateInput$RoleArn' => 'The Amazon Resource Name (ARN) of the role this input assumes during and after creation.', 'DvbSubDestinationSettings$FontSize' => 'When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.', 'FixedModeScheduleActionStartSettings$Time' => 'Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".', 'FollowModeScheduleActionStartSettings$ReferenceActionName' => 'The action name of another action that this one refers to.', 'FrameCaptureOutputSettings$NameModifier' => 'Required if the output group contains more than one output. This modifier forms part of the output file name.', 'GatewayTimeoutException$Message' => NULL, 'HlsAkamaiSettings$Salt' => 'Salt for authenticated Akamai.', 'HlsAkamaiSettings$Token' => 'Token parameter for authenticated akamai. If not specified, _gda_ is used.', 'HlsGroupSettings$BaseUrlContent' => 'A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.', 'HlsGroupSettings$BaseUrlManifest' => 'A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.', 'HlsGroupSettings$KeyFormat' => 'The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.', 'HlsGroupSettings$KeyFormatVersions' => 'Either a single positive integer version value or a slash delimited list of version values (1/2/3).', 'HlsOutputSettings$SegmentModifier' => 'String concatenated to end of segment filenames.', 'HlsTimedMetadataScheduleActionSettings$Id3' => 'Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure', 'Input$Arn' => 'The Unique ARN of the input (generated, immutable).', 'Input$Id' => 'The generated ID of the input (unique for user account, immutable).', 'Input$Name' => 'The user-assigned name (This is a mutable value).', 'Input$RoleArn' => 'The Amazon Resource Name (ARN) of the role this input assumes during and after creation.', 'InputAttachment$InputAttachmentName' => 'User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.', 'InputAttachment$InputId' => 'The ID of the input', 'InputDestination$Ip' => 'The system-generated static IP address of endpoint.It remains fixed for the lifetime of the input.', 'InputDestination$Port' => 'The port number for the input.', 'InputDestination$Url' => 'This represents the endpoint that the customer stream will bepushed to.', 'InputDestinationRequest$StreamName' => 'A unique name for the location the RTMP stream is being pushedto.', 'InputDestinationVpc$AvailabilityZone' => 'The availability zone of the Input destination.', 'InputDestinationVpc$NetworkInterfaceId' => 'The network interface ID of the Input destination in the VPC.', 'InputLocation$PasswordParam' => 'key used to extract the password from EC2 Parameter store', 'InputLocation$Uri' => 'Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".', 'InputLocation$Username' => 'Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://"', 'InputSecurityGroup$Arn' => 'Unique ARN of Input Security Group', 'InputSecurityGroup$Id' => 'The Id of the Input Security Group', 'InputSource$PasswordParam' => 'The key used to extract the password from EC2 Parameter store.', 'InputSource$Url' => 'This represents the customer\'s source URL where stream ispulled from.', 'InputSource$Username' => 'The username for the input source.', 'InputSourceRequest$PasswordParam' => 'The key used to extract the password from EC2 Parameter store.', 'InputSourceRequest$Url' => 'This represents the customer\'s source URL where stream ispulled from.', 'InputSourceRequest$Username' => 'The username for the input source.', 'InputSwitchScheduleActionSettings$InputAttachmentNameReference' => 'The name of the input attachment that should be switched to by this action.', 'InputWhitelistRule$Cidr' => 'The IPv4 CIDR that\'s whitelisted.', 'InputWhitelistRuleCidr$Cidr' => 'The IPv4 CIDR to whitelist.', 'InternalServiceError$Message' => NULL, 'InvalidRequest$Message' => NULL, 'LimitExceeded$Message' => NULL, 'ListChannelsResultModel$NextToken' => NULL, 'ListInputSecurityGroupsResultModel$NextToken' => NULL, 'ListInputsResultModel$NextToken' => NULL, 'ListOfferingsResultModel$NextToken' => 'Token to retrieve the next page of results', 'ListReservationsResultModel$NextToken' => 'Token to retrieve the next page of results', 'M2tsSettings$AribCaptionsPid' => 'Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$AudioPids' => 'Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$DvbSubPids' => 'Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$DvbTeletextPid' => 'Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$EcmPid' => 'This field is unused and deprecated.', 'M2tsSettings$EtvPlatformPid' => 'Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$EtvSignalPid' => 'Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$KlvDataPids' => 'Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$PcrPid' => 'Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$PmtPid' => 'Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$Scte27Pids' => 'Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$Scte35Pid' => 'Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$TimedMetadataPid' => 'Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M2tsSettings$VideoPid' => 'Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M3u8Settings$AudioPids' => 'Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.', 'M3u8Settings$EcmPid' => 'This parameter is unused and deprecated.', 'M3u8Settings$PcrPid' => 'Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.', 'M3u8Settings$PmtPid' => 'Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.', 'M3u8Settings$Scte35Pid' => 'Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.', 'M3u8Settings$TimedMetadataPid' => 'Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).', 'M3u8Settings$VideoPid' => 'Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.', 'MediaConnectFlow$FlowArn' => 'The unique ARN of the MediaConnect Flow being used as a source.', 'MediaConnectFlowRequest$FlowArn' => 'The ARN of the MediaConnect Flow that you want to use as a source.', 'MsSmoothGroupSettings$AcquisitionPointId' => 'The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".', 'MsSmoothGroupSettings$EventId' => 'MS Smooth event ID to be sent to the IIS server.Should only be specified if eventIdMode is set to useConfigured.', 'MsSmoothGroupSettings$TimestampOffset' => 'Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.', 'MsSmoothOutputSettings$NameModifier' => 'String concatenated to the end of the destination filename. Required for multiple outputs of the same type.', 'Offering$Arn' => 'Unique offering ARN, e.g. \'arn:aws:medialive:us-west-2:123456789012:offering:87654321\'', 'Offering$CurrencyCode' => 'Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. \'USD\'', 'Offering$OfferingDescription' => 'Offering description, e.g. \'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)\'', 'Offering$OfferingId' => 'Unique offering ID, e.g. \'87654321\'', 'Offering$Region' => 'AWS region, e.g. \'us-west-2\'', 'Output$VideoDescriptionName' => 'The name of the VideoDescription used as the source for this output.', 'OutputDestination$Id' => 'User-specified id. This is used in an output group or an output.', 'OutputDestinationSettings$PasswordParam' => 'key used to extract the password from EC2 Parameter store', 'OutputDestinationSettings$StreamName' => 'Stream name for RTMP destinations (URLs of type rtmp://)', 'OutputDestinationSettings$Url' => 'A URL specifying a destination', 'OutputDestinationSettings$Username' => 'username for destination', 'OutputLocationRef$DestinationRefId' => NULL, 'PurchaseOffering$Name' => 'Name for the new reservation', 'PurchaseOffering$RequestId' => 'Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.', 'PurchaseOffering$Start' => 'Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.', 'Reservation$Arn' => 'Unique reservation ARN, e.g. \'arn:aws:medialive:us-west-2:123456789012:reservation:1234567\'', 'Reservation$CurrencyCode' => 'Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. \'USD\'', 'Reservation$End' => 'Reservation UTC end date and time in ISO-8601 format, e.g. \'2019-03-01T00:00:00\'', 'Reservation$Name' => 'User specified reservation name', 'Reservation$OfferingDescription' => 'Offering description, e.g. \'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)\'', 'Reservation$OfferingId' => 'Unique offering ID, e.g. \'87654321\'', 'Reservation$Region' => 'AWS region, e.g. \'us-west-2\'', 'Reservation$ReservationId' => 'Unique reservation ID, e.g. \'1234567\'', 'Reservation$Start' => 'Reservation UTC start date and time in ISO-8601 format, e.g. \'2018-03-01T00:00:00\'', 'ResourceConflict$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'ScheduleAction$ActionName' => 'The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.', 'ScheduleDescribeResultModel$NextToken' => 'The next token; for use in pagination.', 'Scte35SegmentationDescriptor$SegmentationUpid' => 'Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.', 'StandardHlsSettings$AudioRenditionSets' => 'List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by \',\'.', 'Tags$member' => NULL, 'TeletextSourceSettings$PageNumber' => 'Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.', 'UpdateChannel$Name' => 'The name of the channel.', 'UpdateChannel$RoleArn' => 'An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.', 'UpdateInput$Name' => 'Name of the input.', 'UpdateInput$RoleArn' => 'The Amazon Resource Name (ARN) of the role this input assumes during and after creation.', 'ValidationError$ElementPath' => NULL, 'ValidationError$ErrorMessage' => NULL, 'VideoDescription$Name' => 'The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.', '__listOf__string$member' => NULL, ], ], '__stringMax32' => [ 'base' => NULL, 'refs' => [ 'OutputGroup$Name' => 'Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.', ], ], '__stringMin1' => [ 'base' => NULL, 'refs' => [ 'AudioSelector$Name' => 'The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.', 'CaptionLanguageMapping$LanguageDescription' => 'Textual description of language', 'CaptionSelector$Name' => 'Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.', 'HlsOutputSettings$NameModifier' => 'String concatenated to the end of the destination filename. Accepts \\"Format Identifiers\\":#formatIdentifierParameters.', 'MediaPackageOutputDestinationSettings$ChannelId' => 'ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.', ], ], '__stringMin1Max255' => [ 'base' => NULL, 'refs' => [ 'Output$OutputName' => 'The name used to identify an output.', ], ], '__stringMin1Max256' => [ 'base' => NULL, 'refs' => [ 'DvbNitSettings$NetworkName' => 'The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.', 'DvbSdtSettings$ServiceName' => 'The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.', 'DvbSdtSettings$ServiceProviderName' => 'The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.', ], ], '__stringMin32Max32' => [ 'base' => NULL, 'refs' => [ 'HlsGroupSettings$ConstantIv' => 'For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.', 'StaticKeySettings$StaticKeyValue' => 'Static key value as a 32 character hexadecimal string.', ], ], '__stringMin34Max34' => [ 'base' => NULL, 'refs' => [ 'BlackoutSlate$NetworkId' => 'Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").', ], ], '__stringMin3Max3' => [ 'base' => NULL, 'refs' => [ 'AudioDescription$LanguageCode' => 'Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.', 'CaptionLanguageMapping$LanguageCode' => 'Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)', ], ], '__stringMin6Max6' => [ 'base' => NULL, 'refs' => [ 'InputLossBehavior$InputLossImageColor' => 'When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.', ], ], ],]; diff --git a/src/data/rds/2014-10-31/api-2.json b/src/data/rds/2014-10-31/api-2.json index 59adf4ecb5..a712df6c2b 100644 --- a/src/data/rds/2014-10-31/api-2.json +++ b/src/data/rds/2014-10-31/api-2.json @@ -2331,7 +2331,8 @@ "EngineMode":{"shape":"String"}, "ScalingConfiguration":{"shape":"ScalingConfiguration"}, "DeletionProtection":{"shape":"BooleanOptional"}, - "GlobalClusterIdentifier":{"shape":"String"} + "GlobalClusterIdentifier":{"shape":"String"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"} } }, "CreateDBClusterParameterGroupMessage":{ @@ -2667,7 +2668,8 @@ "EngineMode":{"shape":"String"}, "ScalingConfigurationInfo":{"shape":"ScalingConfigurationInfo"}, "DeletionProtection":{"shape":"Boolean"}, - "HttpEndpointEnabled":{"shape":"Boolean"} + "HttpEndpointEnabled":{"shape":"Boolean"}, + "CopyTagsToSnapshot":{"shape":"Boolean"} }, "wrapper":true }, @@ -4879,7 +4881,8 @@ "EngineVersion":{"shape":"String"}, "ScalingConfiguration":{"shape":"ScalingConfiguration"}, "DeletionProtection":{"shape":"BooleanOptional"}, - "EnableHttpEndpoint":{"shape":"BooleanOptional"} + "EnableHttpEndpoint":{"shape":"BooleanOptional"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"} } }, "ModifyDBClusterParameterGroupMessage":{ @@ -5834,7 +5837,8 @@ "S3IngestionRoleArn":{"shape":"String"}, "BacktrackWindow":{"shape":"LongOptional"}, "EnableCloudwatchLogsExports":{"shape":"LogTypeList"}, - "DeletionProtection":{"shape":"BooleanOptional"} + "DeletionProtection":{"shape":"BooleanOptional"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"} } }, "RestoreDBClusterFromS3Result":{ @@ -5869,7 +5873,8 @@ "EngineMode":{"shape":"String"}, "ScalingConfiguration":{"shape":"ScalingConfiguration"}, "DBClusterParameterGroupName":{"shape":"String"}, - "DeletionProtection":{"shape":"BooleanOptional"} + "DeletionProtection":{"shape":"BooleanOptional"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"} } }, "RestoreDBClusterFromSnapshotResult":{ @@ -5900,7 +5905,8 @@ "BacktrackWindow":{"shape":"LongOptional"}, "EnableCloudwatchLogsExports":{"shape":"LogTypeList"}, "DBClusterParameterGroupName":{"shape":"String"}, - "DeletionProtection":{"shape":"BooleanOptional"} + "DeletionProtection":{"shape":"BooleanOptional"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"} } }, "RestoreDBClusterToPointInTimeResult":{ diff --git a/src/data/rds/2014-10-31/api-2.json.php b/src/data/rds/2014-10-31/api-2.json.php index 9d86fc6fe8..4988aeaaa1 100644 --- a/src/data/rds/2014-10-31/api-2.json.php +++ b/src/data/rds/2014-10-31/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2014-10-31', 'endpointPrefix' => 'rds', 'protocol' => 'query', 'serviceAbbreviation' => 'Amazon RDS', 'serviceFullName' => 'Amazon Relational Database Service', 'serviceId' => 'RDS', 'signatureVersion' => 'v4', 'uid' => 'rds-2014-10-31', 'xmlNamespace' => 'http://rds.amazonaws.com/doc/2014-10-31/', ], 'operations' => [ 'AddRoleToDBCluster' => [ 'name' => 'AddRoleToDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterRoleQuotaExceededFault', ], ], ], 'AddRoleToDBInstance' => [ 'name' => 'AddRoleToDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceRoleQuotaExceededFault', ], ], ], 'AddSourceIdentifierToSubscription' => [ 'name' => 'AddSourceIdentifierToSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddSourceIdentifierToSubscriptionMessage', ], 'output' => [ 'shape' => 'AddSourceIdentifierToSubscriptionResult', 'resultWrapper' => 'AddSourceIdentifierToSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ApplyPendingMaintenanceAction' => [ 'name' => 'ApplyPendingMaintenanceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ApplyPendingMaintenanceActionMessage', ], 'output' => [ 'shape' => 'ApplyPendingMaintenanceActionResult', 'resultWrapper' => 'ApplyPendingMaintenanceActionResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'AuthorizeDBSecurityGroupIngress' => [ 'name' => 'AuthorizeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressResult', 'resultWrapper' => 'AuthorizeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'AuthorizationAlreadyExistsFault', ], [ 'shape' => 'AuthorizationQuotaExceededFault', ], ], ], 'BacktrackDBCluster' => [ 'name' => 'BacktrackDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BacktrackDBClusterMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrack', 'resultWrapper' => 'BacktrackDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'CopyDBClusterParameterGroup' => [ 'name' => 'CopyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBClusterParameterGroupResult', 'resultWrapper' => 'CopyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CopyDBClusterSnapshot' => [ 'name' => 'CopyDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBClusterSnapshotResult', 'resultWrapper' => 'CopyDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CopyDBParameterGroup' => [ 'name' => 'CopyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBParameterGroupResult', 'resultWrapper' => 'CopyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], ], ], 'CopyDBSnapshot' => [ 'name' => 'CopyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBSnapshotResult', 'resultWrapper' => 'CopyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CopyOptionGroup' => [ 'name' => 'CopyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyOptionGroupMessage', ], 'output' => [ 'shape' => 'CopyOptionGroupResult', 'resultWrapper' => 'CopyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'CreateDBCluster' => [ 'name' => 'CreateDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterMessage', ], 'output' => [ 'shape' => 'CreateDBClusterResult', 'resultWrapper' => 'CreateDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'CreateDBClusterEndpoint' => [ 'name' => 'CreateDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'CreateDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'DBClusterEndpointQuotaExceededFault', ], [ 'shape' => 'DBClusterEndpointAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'CreateDBClusterParameterGroup' => [ 'name' => 'CreateDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBClusterParameterGroupResult', 'resultWrapper' => 'CreateDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBClusterSnapshot' => [ 'name' => 'CreateDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBClusterSnapshotResult', 'resultWrapper' => 'CreateDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'CreateDBInstance' => [ 'name' => 'CreateDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceResult', 'resultWrapper' => 'CreateDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'CreateDBInstanceReadReplica' => [ 'name' => 'CreateDBInstanceReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceReadReplicaMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceReadReplicaResult', 'resultWrapper' => 'CreateDBInstanceReadReplicaResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotAllowedFault', ], [ 'shape' => 'InvalidDBSubnetGroupFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CreateDBParameterGroup' => [ 'name' => 'CreateDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBParameterGroupResult', 'resultWrapper' => 'CreateDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBSecurityGroup' => [ 'name' => 'CreateDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSecurityGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSecurityGroupResult', 'resultWrapper' => 'CreateDBSecurityGroupResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupAlreadyExistsFault', ], [ 'shape' => 'DBSecurityGroupQuotaExceededFault', ], [ 'shape' => 'DBSecurityGroupNotSupportedFault', ], ], ], 'CreateDBSnapshot' => [ 'name' => 'CreateDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBSnapshotResult', 'resultWrapper' => 'CreateDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], ], ], 'CreateDBSubnetGroup' => [ 'name' => 'CreateDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSubnetGroupResult', 'resultWrapper' => 'CreateDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'DBSubnetGroupQuotaExceededFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'CreateEventSubscription' => [ 'name' => 'CreateEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventSubscriptionMessage', ], 'output' => [ 'shape' => 'CreateEventSubscriptionResult', 'resultWrapper' => 'CreateEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionAlreadyExistFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'CreateGlobalCluster' => [ 'name' => 'CreateGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalClusterMessage', ], 'output' => [ 'shape' => 'CreateGlobalClusterResult', 'resultWrapper' => 'CreateGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterAlreadyExistsFault', ], [ 'shape' => 'GlobalClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'CreateOptionGroup' => [ 'name' => 'CreateOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOptionGroupMessage', ], 'output' => [ 'shape' => 'CreateOptionGroupResult', 'resultWrapper' => 'CreateOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'DeleteDBCluster' => [ 'name' => 'DeleteDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterResult', 'resultWrapper' => 'DeleteDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'DeleteDBClusterEndpoint' => [ 'name' => 'DeleteDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'DeleteDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBClusterParameterGroup' => [ 'name' => 'DeleteDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBClusterSnapshot' => [ 'name' => 'DeleteDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterSnapshotResult', 'resultWrapper' => 'DeleteDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DeleteDBInstance' => [ 'name' => 'DeleteDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceResult', 'resultWrapper' => 'DeleteDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupQuotaExceededFault', ], ], ], 'DeleteDBInstanceAutomatedBackup' => [ 'name' => 'DeleteDBInstanceAutomatedBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupResult', 'resultWrapper' => 'DeleteDBInstanceAutomatedBackupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceAutomatedBackupStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DeleteDBParameterGroup' => [ 'name' => 'DeleteDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBSecurityGroup' => [ 'name' => 'DeleteDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSecurityGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DeleteDBSnapshot' => [ 'name' => 'DeleteDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBSnapshotResult', 'resultWrapper' => 'DeleteDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DeleteDBSubnetGroup' => [ 'name' => 'DeleteDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidDBSubnetStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DeleteEventSubscription' => [ 'name' => 'DeleteEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventSubscriptionMessage', ], 'output' => [ 'shape' => 'DeleteEventSubscriptionResult', 'resultWrapper' => 'DeleteEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'InvalidEventSubscriptionStateFault', ], ], ], 'DeleteGlobalCluster' => [ 'name' => 'DeleteGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalClusterMessage', ], 'output' => [ 'shape' => 'DeleteGlobalClusterResult', 'resultWrapper' => 'DeleteGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'DeleteOptionGroup' => [ 'name' => 'DeleteOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptionGroupMessage', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'InvalidOptionGroupStateFault', ], ], ], 'DescribeAccountAttributes' => [ 'name' => 'DescribeAccountAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountAttributesMessage', ], 'output' => [ 'shape' => 'AccountAttributesMessage', 'resultWrapper' => 'DescribeAccountAttributesResult', ], ], 'DescribeCertificates' => [ 'name' => 'DescribeCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificatesMessage', ], 'output' => [ 'shape' => 'CertificateMessage', 'resultWrapper' => 'DescribeCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'DescribeDBClusterBacktracks' => [ 'name' => 'DescribeDBClusterBacktracks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterBacktracksMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrackMessage', 'resultWrapper' => 'DescribeDBClusterBacktracksResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterBacktrackNotFoundFault', ], ], ], 'DescribeDBClusterEndpoints' => [ 'name' => 'DescribeDBClusterEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterEndpointsMessage', ], 'output' => [ 'shape' => 'DBClusterEndpointMessage', 'resultWrapper' => 'DescribeDBClusterEndpointsResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBClusterParameterGroups' => [ 'name' => 'DescribeDBClusterParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupsMessage', 'resultWrapper' => 'DescribeDBClusterParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterParameters' => [ 'name' => 'DescribeDBClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParametersMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupDetails', 'resultWrapper' => 'DescribeDBClusterParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterSnapshotAttributes' => [ 'name' => 'DescribeDBClusterSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBClusterSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusterSnapshots' => [ 'name' => 'DescribeDBClusterSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotsMessage', ], 'output' => [ 'shape' => 'DBClusterSnapshotMessage', 'resultWrapper' => 'DescribeDBClusterSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusters' => [ 'name' => 'DescribeDBClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClustersMessage', ], 'output' => [ 'shape' => 'DBClusterMessage', 'resultWrapper' => 'DescribeDBClustersResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBEngineVersions' => [ 'name' => 'DescribeDBEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBEngineVersionsMessage', ], 'output' => [ 'shape' => 'DBEngineVersionMessage', 'resultWrapper' => 'DescribeDBEngineVersionsResult', ], ], 'DescribeDBInstanceAutomatedBackups' => [ 'name' => 'DescribeDBInstanceAutomatedBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstanceAutomatedBackupsMessage', ], 'output' => [ 'shape' => 'DBInstanceAutomatedBackupMessage', 'resultWrapper' => 'DescribeDBInstanceAutomatedBackupsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DescribeDBInstances' => [ 'name' => 'DescribeDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstancesMessage', ], 'output' => [ 'shape' => 'DBInstanceMessage', 'resultWrapper' => 'DescribeDBInstancesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBLogFiles' => [ 'name' => 'DescribeDBLogFiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBLogFilesMessage', ], 'output' => [ 'shape' => 'DescribeDBLogFilesResponse', 'resultWrapper' => 'DescribeDBLogFilesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBParameterGroups' => [ 'name' => 'DescribeDBParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBParameterGroupsMessage', 'resultWrapper' => 'DescribeDBParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBParameters' => [ 'name' => 'DescribeDBParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParametersMessage', ], 'output' => [ 'shape' => 'DBParameterGroupDetails', 'resultWrapper' => 'DescribeDBParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBSecurityGroups' => [ 'name' => 'DescribeDBSecurityGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSecurityGroupsMessage', ], 'output' => [ 'shape' => 'DBSecurityGroupMessage', 'resultWrapper' => 'DescribeDBSecurityGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DescribeDBSnapshotAttributes' => [ 'name' => 'DescribeDBSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSnapshots' => [ 'name' => 'DescribeDBSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotsMessage', ], 'output' => [ 'shape' => 'DBSnapshotMessage', 'resultWrapper' => 'DescribeDBSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSubnetGroups' => [ 'name' => 'DescribeDBSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSubnetGroupsMessage', ], 'output' => [ 'shape' => 'DBSubnetGroupMessage', 'resultWrapper' => 'DescribeDBSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultClusterParameters' => [ 'name' => 'DescribeEngineDefaultClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultClusterParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultClusterParametersResult', 'resultWrapper' => 'DescribeEngineDefaultClusterParametersResult', ], ], 'DescribeEngineDefaultParameters' => [ 'name' => 'DescribeEngineDefaultParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultParametersResult', 'resultWrapper' => 'DescribeEngineDefaultParametersResult', ], ], 'DescribeEventCategories' => [ 'name' => 'DescribeEventCategories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventCategoriesMessage', ], 'output' => [ 'shape' => 'EventCategoriesMessage', 'resultWrapper' => 'DescribeEventCategoriesResult', ], ], 'DescribeEventSubscriptions' => [ 'name' => 'DescribeEventSubscriptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventSubscriptionsMessage', ], 'output' => [ 'shape' => 'EventSubscriptionsMessage', 'resultWrapper' => 'DescribeEventSubscriptionsResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], ], 'DescribeGlobalClusters' => [ 'name' => 'DescribeGlobalClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalClustersMessage', ], 'output' => [ 'shape' => 'GlobalClustersMessage', 'resultWrapper' => 'DescribeGlobalClustersResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], ], ], 'DescribeOptionGroupOptions' => [ 'name' => 'DescribeOptionGroupOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupOptionsMessage', ], 'output' => [ 'shape' => 'OptionGroupOptionsMessage', 'resultWrapper' => 'DescribeOptionGroupOptionsResult', ], ], 'DescribeOptionGroups' => [ 'name' => 'DescribeOptionGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupsMessage', ], 'output' => [ 'shape' => 'OptionGroups', 'resultWrapper' => 'DescribeOptionGroupsResult', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'DescribeOrderableDBInstanceOptions' => [ 'name' => 'DescribeOrderableDBInstanceOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrderableDBInstanceOptionsMessage', ], 'output' => [ 'shape' => 'OrderableDBInstanceOptionsMessage', 'resultWrapper' => 'DescribeOrderableDBInstanceOptionsResult', ], ], 'DescribePendingMaintenanceActions' => [ 'name' => 'DescribePendingMaintenanceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingMaintenanceActionsMessage', ], 'output' => [ 'shape' => 'PendingMaintenanceActionsMessage', 'resultWrapper' => 'DescribePendingMaintenanceActionsResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], ], ], 'DescribeReservedDBInstances' => [ 'name' => 'DescribeReservedDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesMessage', ], 'output' => [ 'shape' => 'ReservedDBInstanceMessage', 'resultWrapper' => 'DescribeReservedDBInstancesResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstanceNotFoundFault', ], ], ], 'DescribeReservedDBInstancesOfferings' => [ 'name' => 'DescribeReservedDBInstancesOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesOfferingsMessage', ], 'output' => [ 'shape' => 'ReservedDBInstancesOfferingMessage', 'resultWrapper' => 'DescribeReservedDBInstancesOfferingsResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], ], ], 'DescribeSourceRegions' => [ 'name' => 'DescribeSourceRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSourceRegionsMessage', ], 'output' => [ 'shape' => 'SourceRegionMessage', 'resultWrapper' => 'DescribeSourceRegionsResult', ], ], 'DescribeValidDBInstanceModifications' => [ 'name' => 'DescribeValidDBInstanceModifications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeValidDBInstanceModificationsMessage', ], 'output' => [ 'shape' => 'DescribeValidDBInstanceModificationsResult', 'resultWrapper' => 'DescribeValidDBInstanceModificationsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'DownloadDBLogFilePortion' => [ 'name' => 'DownloadDBLogFilePortion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDBLogFilePortionMessage', ], 'output' => [ 'shape' => 'DownloadDBLogFilePortionDetails', 'resultWrapper' => 'DownloadDBLogFilePortionResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBLogFileNotFoundFault', ], ], ], 'FailoverDBCluster' => [ 'name' => 'FailoverDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverDBClusterMessage', ], 'output' => [ 'shape' => 'FailoverDBClusterResult', 'resultWrapper' => 'FailoverDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ModifyCurrentDBClusterCapacity' => [ 'name' => 'ModifyCurrentDBClusterCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCurrentDBClusterCapacityMessage', ], 'output' => [ 'shape' => 'DBClusterCapacityInfo', 'resultWrapper' => 'ModifyCurrentDBClusterCapacityResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterCapacityFault', ], ], ], 'ModifyDBCluster' => [ 'name' => 'ModifyDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterResult', 'resultWrapper' => 'ModifyDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterAlreadyExistsFault', ], ], ], 'ModifyDBClusterEndpoint' => [ 'name' => 'ModifyDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'ModifyDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ModifyDBClusterParameterGroup' => [ 'name' => 'ModifyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBClusterSnapshotAttribute' => [ 'name' => 'ModifyDBClusterSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBClusterSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBInstance' => [ 'name' => 'ModifyDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBInstanceMessage', ], 'output' => [ 'shape' => 'ModifyDBInstanceResult', 'resultWrapper' => 'ModifyDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBUpgradeDependencyFailureFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'ModifyDBParameterGroup' => [ 'name' => 'ModifyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBSnapshot' => [ 'name' => 'ModifyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotResult', 'resultWrapper' => 'ModifyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'ModifyDBSnapshotAttribute' => [ 'name' => 'ModifyDBSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBSubnetGroup' => [ 'name' => 'ModifyDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyDBSubnetGroupResult', 'resultWrapper' => 'ModifyDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetAlreadyInUse', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'ModifyEventSubscription' => [ 'name' => 'ModifyEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyEventSubscriptionMessage', ], 'output' => [ 'shape' => 'ModifyEventSubscriptionResult', 'resultWrapper' => 'ModifyEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], ], ], 'ModifyGlobalCluster' => [ 'name' => 'ModifyGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalClusterMessage', ], 'output' => [ 'shape' => 'ModifyGlobalClusterResult', 'resultWrapper' => 'ModifyGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'ModifyOptionGroup' => [ 'name' => 'ModifyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyOptionGroupMessage', ], 'output' => [ 'shape' => 'ModifyOptionGroupResult', 'resultWrapper' => 'ModifyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidOptionGroupStateFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'PromoteReadReplica' => [ 'name' => 'PromoteReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaResult', 'resultWrapper' => 'PromoteReadReplicaResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'PromoteReadReplicaDBCluster' => [ 'name' => 'PromoteReadReplicaDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaDBClusterMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaDBClusterResult', 'resultWrapper' => 'PromoteReadReplicaDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'PurchaseReservedDBInstancesOffering' => [ 'name' => 'PurchaseReservedDBInstancesOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingMessage', ], 'output' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingResult', 'resultWrapper' => 'PurchaseReservedDBInstancesOfferingResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], [ 'shape' => 'ReservedDBInstanceAlreadyExistsFault', ], [ 'shape' => 'ReservedDBInstanceQuotaExceededFault', ], ], ], 'RebootDBInstance' => [ 'name' => 'RebootDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBInstanceMessage', ], 'output' => [ 'shape' => 'RebootDBInstanceResult', 'resultWrapper' => 'RebootDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'RemoveFromGlobalCluster' => [ 'name' => 'RemoveFromGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveFromGlobalClusterMessage', ], 'output' => [ 'shape' => 'RemoveFromGlobalClusterResult', 'resultWrapper' => 'RemoveFromGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'RemoveRoleFromDBCluster' => [ 'name' => 'RemoveRoleFromDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'RemoveRoleFromDBInstance' => [ 'name' => 'RemoveRoleFromDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'RemoveSourceIdentifierFromSubscription' => [ 'name' => 'RemoveSourceIdentifierFromSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionMessage', ], 'output' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionResult', 'resultWrapper' => 'RemoveSourceIdentifierFromSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ResetDBClusterParameterGroup' => [ 'name' => 'ResetDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ResetDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'ResetDBParameterGroup' => [ 'name' => 'ResetDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ResetDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterFromS3' => [ 'name' => 'RestoreDBClusterFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBClusterFromS3Result', 'resultWrapper' => 'RestoreDBClusterFromS3Result', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], ], ], 'RestoreDBClusterFromSnapshot' => [ 'name' => 'RestoreDBClusterFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterFromSnapshotResult', 'resultWrapper' => 'RestoreDBClusterFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterToPointInTime' => [ 'name' => 'RestoreDBClusterToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterToPointInTimeResult', 'resultWrapper' => 'RestoreDBClusterToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], ], ], 'RestoreDBInstanceFromDBSnapshot' => [ 'name' => 'RestoreDBInstanceFromDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotResult', 'resultWrapper' => 'RestoreDBInstanceFromDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'RestoreDBInstanceFromS3' => [ 'name' => 'RestoreDBInstanceFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromS3Result', 'resultWrapper' => 'RestoreDBInstanceFromS3Result', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'RestoreDBInstanceToPointInTime' => [ 'name' => 'RestoreDBInstanceToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceToPointInTimeResult', 'resultWrapper' => 'RestoreDBInstanceToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'PointInTimeRestoreNotEnabledFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'RevokeDBSecurityGroupIngress' => [ 'name' => 'RevokeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'RevokeDBSecurityGroupIngressResult', 'resultWrapper' => 'RevokeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], ], ], 'StartDBCluster' => [ 'name' => 'StartDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBClusterMessage', ], 'output' => [ 'shape' => 'StartDBClusterResult', 'resultWrapper' => 'StartDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StartDBInstance' => [ 'name' => 'StartDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBInstanceMessage', ], 'output' => [ 'shape' => 'StartDBInstanceResult', 'resultWrapper' => 'StartDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'StopDBCluster' => [ 'name' => 'StopDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBClusterMessage', ], 'output' => [ 'shape' => 'StopDBClusterResult', 'resultWrapper' => 'StopDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StopDBInstance' => [ 'name' => 'StopDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBInstanceMessage', ], 'output' => [ 'shape' => 'StopDBInstanceResult', 'resultWrapper' => 'StopDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], ], 'shapes' => [ 'AccountAttributesMessage' => [ 'type' => 'structure', 'members' => [ 'AccountQuotas' => [ 'shape' => 'AccountQuotaList', ], ], ], 'AccountQuota' => [ 'type' => 'structure', 'members' => [ 'AccountQuotaName' => [ 'shape' => 'String', ], 'Used' => [ 'shape' => 'Long', ], 'Max' => [ 'shape' => 'Long', ], ], 'wrapper' => true, ], 'AccountQuotaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountQuota', 'locationName' => 'AccountQuota', ], ], 'AddRoleToDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], ], ], 'AddRoleToDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ApplyMethod' => [ 'type' => 'string', 'enum' => [ 'immediate', 'pending-reboot', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceIdentifier', 'ApplyAction', 'OptInType', ], 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'ApplyAction' => [ 'shape' => 'String', ], 'OptInType' => [ 'shape' => 'String', ], ], ], 'ApplyPendingMaintenanceActionResult' => [ 'type' => 'structure', 'members' => [ 'ResourcePendingMaintenanceActions' => [ 'shape' => 'ResourcePendingMaintenanceActions', ], ], ], 'AttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AttributeValue', ], ], 'AuthorizationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', 'locationName' => 'AvailabilityZone', ], ], 'AvailabilityZones' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'AvailableProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], ], ], 'AvailableProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailableProcessorFeature', 'locationName' => 'AvailableProcessorFeature', ], ], 'BacktrackDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'BacktrackTo', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'Force' => [ 'shape' => 'BooleanOptional', ], 'UseEarliestTimeOnPointInTimeUnavailable' => [ 'shape' => 'BooleanOptional', ], ], ], 'BackupPolicyNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'deprecated' => true, 'deprecatedMessage' => 'Please avoid using this fault', 'error' => [ 'code' => 'BackupPolicyNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'CertificateType' => [ 'shape' => 'String', ], 'Thumbprint' => [ 'shape' => 'String', ], 'ValidFrom' => [ 'shape' => 'TStamp', ], 'ValidTill' => [ 'shape' => 'TStamp', ], 'CertificateArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Certificate', 'locationName' => 'Certificate', ], ], 'CertificateMessage' => [ 'type' => 'structure', 'members' => [ 'Certificates' => [ 'shape' => 'CertificateList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'CertificateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CertificateNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CharacterSet' => [ 'type' => 'structure', 'members' => [ 'CharacterSetName' => [ 'shape' => 'String', ], 'CharacterSetDescription' => [ 'shape' => 'String', ], ], ], 'CloudwatchLogsExportConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableLogTypes' => [ 'shape' => 'LogTypeList', ], 'DisableLogTypes' => [ 'shape' => 'LogTypeList', ], ], ], 'CopyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupDescription', ], 'members' => [ 'SourceDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CopyDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterSnapshotIdentifier', 'TargetDBClusterSnapshotIdentifier', ], 'members' => [ 'SourceDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CopyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBParameterGroupIdentifier', 'TargetDBParameterGroupIdentifier', 'TargetDBParameterGroupDescription', ], 'members' => [ 'SourceDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CopyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBSnapshotIdentifier', 'TargetDBSnapshotIdentifier', ], 'members' => [ 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'CopyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CopyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceOptionGroupIdentifier', 'TargetOptionGroupIdentifier', 'TargetOptionGroupDescription', ], 'members' => [ 'SourceOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'CreateDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'DBClusterEndpointIdentifier', 'EndpointType', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], ], ], 'CreateDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'CreateDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CreateDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'CreateDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'DBClusterIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'Timezone' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBInstanceReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'SourceDBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'StorageType' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBInstanceReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CreateDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', 'DBSecurityGroupDescription', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSecurityGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'CreateDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'DBInstanceIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CreateDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'DBSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'CreateEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SnsTopicArn', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'SourceIds' => [ 'shape' => 'SourceIdsList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'CreateGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'CreateOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', 'EngineName', 'MajorEngineVersion', 'OptionGroupDescription', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'DBCluster' => [ 'type' => 'structure', 'members' => [ 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroup' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'String', ], 'EarliestRestorableTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'String', ], 'ReaderEndpoint' => [ 'shape' => 'String', ], 'CustomEndpoints' => [ 'shape' => 'StringList', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBClusterOptionGroupMemberships' => [ 'shape' => 'DBClusterOptionGroupMemberships', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaIdentifiers' => [ 'shape' => 'ReadReplicaIdentifierList', ], 'DBClusterMembers' => [ 'shape' => 'DBClusterMemberList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'HostedZoneId' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'AssociatedRoles' => [ 'shape' => 'DBClusterRoles', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'CloneGroupId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'EarliestBacktrackTime' => [ 'shape' => 'TStamp', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'BacktrackConsumedChangeRecords' => [ 'shape' => 'LongOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfigurationInfo' => [ 'shape' => 'ScalingConfigurationInfo', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'HttpEndpointEnabled' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'DBClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterBacktrack' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'BacktrackedFrom' => [ 'shape' => 'TStamp', ], 'BacktrackRequestCreationTime' => [ 'shape' => 'TStamp', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterBacktrackList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterBacktrack', 'locationName' => 'DBClusterBacktrack', ], ], 'DBClusterBacktrackMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterBacktracks' => [ 'shape' => 'DBClusterBacktrackList', ], ], ], 'DBClusterBacktrackNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterBacktrackNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterCapacityInfo' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'PendingCapacity' => [ 'shape' => 'IntegerOptional', ], 'CurrentCapacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpoint' => [ 'type' => 'structure', 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointResourceIdentifier' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'CustomEndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], 'DBClusterEndpointArn' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpointAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterEndpoint', 'locationName' => 'DBClusterEndpointList', ], ], 'DBClusterEndpointMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterEndpoints' => [ 'shape' => 'DBClusterEndpointList', ], ], ], 'DBClusterEndpointNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBCluster', 'locationName' => 'DBCluster', ], ], 'DBClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'IsClusterWriter' => [ 'shape' => 'Boolean', ], 'DBClusterParameterGroupStatus' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterMember', 'locationName' => 'DBClusterMember', ], ], 'DBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusters' => [ 'shape' => 'DBClusterList', ], ], ], 'DBClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterOptionGroupMemberships' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterOptionGroupStatus', 'locationName' => 'DBClusterOptionGroup', ], ], 'DBClusterOptionGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBClusterOptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBClusterParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterParameterGroup', 'locationName' => 'DBClusterParameterGroup', ], ], 'DBClusterParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterParameterGroups' => [ 'shape' => 'DBClusterParameterGroupList', ], ], ], 'DBClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterRole', 'locationName' => 'DBClusterRole', ], ], 'DBClusterSnapshot' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'VpcId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBClusterSnapshotArn' => [ 'shape' => 'String', ], 'SourceDBClusterSnapshotArn' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], ], 'DBClusterSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshotAttribute', 'locationName' => 'DBClusterSnapshotAttribute', ], ], 'DBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotAttributes' => [ 'shape' => 'DBClusterSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBClusterSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshot', 'locationName' => 'DBClusterSnapshot', ], ], 'DBClusterSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterSnapshots' => [ 'shape' => 'DBClusterSnapshotList', ], ], ], 'DBClusterSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'DBEngineDescription' => [ 'shape' => 'String', ], 'DBEngineVersionDescription' => [ 'shape' => 'String', ], 'DefaultCharacterSet' => [ 'shape' => 'CharacterSet', ], 'SupportedCharacterSets' => [ 'shape' => 'SupportedCharacterSetsList', ], 'ValidUpgradeTarget' => [ 'shape' => 'ValidUpgradeTargetList', ], 'SupportedTimezones' => [ 'shape' => 'SupportedTimezonesList', ], 'ExportableLogTypes' => [ 'shape' => 'LogTypeList', ], 'SupportsLogExportsToCloudwatchLogs' => [ 'shape' => 'Boolean', ], 'SupportsReadReplica' => [ 'shape' => 'Boolean', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportedFeatureNames' => [ 'shape' => 'FeatureNameList', ], ], ], 'DBEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBEngineVersion', 'locationName' => 'DBEngineVersion', ], ], 'DBEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBEngineVersions' => [ 'shape' => 'DBEngineVersionList', ], ], ], 'DBInstance' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DBInstanceStatus' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'Integer', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupStatusList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'ReadReplicaSourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaDBInstanceIdentifiers' => [ 'shape' => 'ReadReplicaDBInstanceIdentifierList', ], 'ReadReplicaDBClusterIdentifiers' => [ 'shape' => 'ReadReplicaDBClusterIdentifierList', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupMemberships' => [ 'shape' => 'OptionGroupMembershipList', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'SecondaryAvailabilityZone' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'Boolean', ], 'StatusInfos' => [ 'shape' => 'DBInstanceStatusInfoList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'DbInstancePort' => [ 'shape' => 'Integer', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DomainMemberships' => [ 'shape' => 'DomainMembershipList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'Boolean', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'EnhancedMonitoringResourceArn' => [ 'shape' => 'String', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'PerformanceInsightsEnabled' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'AssociatedRoles' => [ 'shape' => 'DBInstanceRoles', ], 'ListenerEndpoint' => [ 'shape' => 'Endpoint', ], ], 'wrapper' => true, ], 'DBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackup' => [ 'type' => 'structure', 'members' => [ 'DBInstanceArn' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'Region' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreWindow' => [ 'shape' => 'RestoreWindow', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'DBInstanceAutomatedBackupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceAutomatedBackup', 'locationName' => 'DBInstanceAutomatedBackup', ], ], 'DBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackups' => [ 'shape' => 'DBInstanceAutomatedBackupList', ], ], ], 'DBInstanceAutomatedBackupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstance', 'locationName' => 'DBInstance', ], ], 'DBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstances' => [ 'shape' => 'DBInstanceList', ], ], ], 'DBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceRole', 'locationName' => 'DBInstanceRole', ], ], 'DBInstanceStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBInstanceStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceStatusInfo', 'locationName' => 'DBInstanceStatusInfo', ], ], 'DBLogFileNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBLogFileNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroup', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ParameterApplyStatus' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroupStatus', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupList', ], ], ], 'DBSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'OwnerId' => [ 'shape' => 'String', ], 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'EC2SecurityGroups' => [ 'shape' => 'EC2SecurityGroupList', ], 'IPRanges' => [ 'shape' => 'IPRangeList', ], 'DBSecurityGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSecurityGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroupMembership', 'locationName' => 'DBSecurityGroup', ], ], 'DBSecurityGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroups', ], ], ], 'DBSecurityGroupNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'DBSecurityGroupName', ], ], 'DBSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'QuotaExceeded.DBSecurityGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroup', 'locationName' => 'DBSecurityGroup', ], ], 'DBSnapshot' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'SourceRegion' => [ 'shape' => 'String', ], 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBSnapshotArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], 'wrapper' => true, ], 'DBSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshotAttribute', 'locationName' => 'DBSnapshotAttribute', ], ], 'DBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotAttributes' => [ 'shape' => 'DBSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshot', 'locationName' => 'DBSnapshot', ], ], 'DBSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSnapshots' => [ 'shape' => 'DBSnapshotList', ], ], ], 'DBSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'SubnetGroupStatus' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'DBSubnetGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupDoesNotCoverEnoughAZs', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSubnetGroups' => [ 'shape' => 'DBSubnetGroups', ], ], ], 'DBSubnetGroupNotAllowedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotAllowedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSubnetGroup', 'locationName' => 'DBSubnetGroup', ], ], 'DBSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBUpgradeDependencyFailureFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBUpgradeDependencyFailure', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DeleteDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'DeleteDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'required' => [ 'DbiResourceId', ], 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DeleteDBInstanceAutomatedBackupResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'DeleteDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DeleteAutomatedBackups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'DeleteDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'DeleteDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'DeleteGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DeleteOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'DescribeAccountAttributesMessage' => [ 'type' => 'structure', 'members' => [], ], 'DescribeCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterBacktracksMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterEndpointsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'DescribeDBClusterSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], ], ], 'DescribeDBClustersMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], 'ListSupportedCharacterSets' => [ 'shape' => 'BooleanOptional', ], 'ListSupportedTimezones' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeDBInstanceAutomatedBackupsMessage' => [ 'type' => 'structure', 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileName' => [ 'shape' => 'String', ], 'LastWritten' => [ 'shape' => 'Long', ], 'Size' => [ 'shape' => 'Long', ], ], ], 'DescribeDBLogFilesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribeDBLogFilesDetails', 'locationName' => 'DescribeDBLogFilesDetails', ], ], 'DescribeDBLogFilesMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'FilenameContains' => [ 'shape' => 'String', ], 'FileLastWritten' => [ 'shape' => 'Long', ], 'FileSize' => [ 'shape' => 'Long', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesResponse' => [ 'type' => 'structure', 'members' => [ 'DescribeDBLogFiles' => [ 'shape' => 'DescribeDBLogFilesList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSecurityGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'DescribeDBSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEngineDefaultParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeEventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeGlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOptionGroupOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'EngineName', ], 'members' => [ 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOptionGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], ], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', ], 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Vpc' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribePendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeReservedDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedDBInstancesOfferingsMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeSourceRegionsMessage' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeValidDBInstanceModificationsResult' => [ 'type' => 'structure', 'members' => [ 'ValidDBInstanceModificationsMessage' => [ 'shape' => 'ValidDBInstanceModificationsMessage', ], ], ], 'DomainMembership' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FQDN' => [ 'shape' => 'String', ], 'IAMRoleName' => [ 'shape' => 'String', ], ], ], 'DomainMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainMembership', 'locationName' => 'DomainMembership', ], ], 'DomainNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DomainNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'Double' => [ 'type' => 'double', ], 'DoubleOptional' => [ 'type' => 'double', ], 'DoubleRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Double', ], 'To' => [ 'shape' => 'Double', ], ], ], 'DoubleRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DoubleRange', 'locationName' => 'DoubleRange', ], ], 'DownloadDBLogFilePortionDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileData' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'AdditionalDataPending' => [ 'shape' => 'Boolean', ], ], ], 'DownloadDBLogFilePortionMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'LogFileName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'LogFileName' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'NumberOfLines' => [ 'shape' => 'Integer', ], ], ], 'EC2SecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'EC2SecurityGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2SecurityGroup', 'locationName' => 'EC2SecurityGroup', ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'HostedZoneId' => [ 'shape' => 'String', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], 'wrapper' => true, ], 'EngineModeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Date' => [ 'shape' => 'TStamp', ], 'SourceArn' => [ 'shape' => 'String', ], ], ], 'EventCategoriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'EventCategory', ], ], 'EventCategoriesMap' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], ], 'wrapper' => true, ], 'EventCategoriesMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventCategoriesMap', 'locationName' => 'EventCategoriesMap', ], ], 'EventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'EventCategoriesMapList' => [ 'shape' => 'EventCategoriesMapList', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventSubscription' => [ 'type' => 'structure', 'members' => [ 'CustomerAwsId' => [ 'shape' => 'String', ], 'CustSubscriptionId' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SubscriptionCreationTime' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'SourceIdsList' => [ 'shape' => 'SourceIdsList', ], 'EventCategoriesList' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'EventSubscriptionArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'EventSubscriptionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'EventSubscriptionQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EventSubscriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSubscription', 'locationName' => 'EventSubscription', ], ], 'EventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'EventSubscriptionsList' => [ 'shape' => 'EventSubscriptionsList', ], ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'FailoverDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'FailoverDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'FeatureNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', 'locationName' => 'Filter', ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'Value', ], ], 'GlobalCluster' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'GlobalClusterResourceId' => [ 'shape' => 'String', ], 'GlobalClusterArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterMembers' => [ 'shape' => 'GlobalClusterMemberList', ], ], 'wrapper' => true, ], 'GlobalClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalCluster', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBClusterArn' => [ 'shape' => 'String', ], 'Readers' => [ 'shape' => 'ReadersArnList', ], 'IsWriter' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'GlobalClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalClusterMember', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalClusters' => [ 'shape' => 'GlobalClusterList', ], ], ], 'IPRange' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], ], ], 'IPRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPRange', 'locationName' => 'IPRange', ], ], 'InstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBClusterCapacityFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBInstanceCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBInstanceCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientStorageClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientStorageClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'InvalidDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterCapacityFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterEndpointStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterEndpointStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceAutomatedBackupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidEventSubscriptionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidEventSubscriptionState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidOptionGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidOptionGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidRestoreFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidRestoreFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidS3BucketFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidS3BucketFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KMSKeyNotAccessibleFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'KMSKeyNotAccessibleFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'LogTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Long' => [ 'type' => 'long', ], 'LongOptional' => [ 'type' => 'long', ], 'MinimumEngineVersionPerAllowedValue' => [ 'type' => 'structure', 'members' => [ 'AllowedValue' => [ 'shape' => 'String', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MinimumEngineVersionPerAllowedValue', 'locationName' => 'MinimumEngineVersionPerAllowedValue', ], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'ModifyDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'NewDBClusterIdentifier' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'EngineVersion' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EnableHttpEndpoint' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'Parameters', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'ModifyDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'NewDBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'DBPortNumber' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ModifyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'Parameters', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'ModifyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'ModifyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'ModifyDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'ModifyEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'ModifyGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'NewGlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'ModifyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionsToInclude' => [ 'shape' => 'OptionConfigurationList', ], 'OptionsToRemove' => [ 'shape' => 'OptionNamesList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'ModifyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'Option' => [ 'type' => 'structure', 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'OptionDescription' => [ 'shape' => 'String', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'OptionSettings' => [ 'shape' => 'OptionSettingConfigurationList', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], ], ], 'OptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'OptionName', ], 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'OptionSettings' => [ 'shape' => 'OptionSettingsList', ], ], ], 'OptionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionConfiguration', 'locationName' => 'OptionConfiguration', ], ], 'OptionGroup' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Options' => [ 'shape' => 'OptionsList', ], 'AllowsVpcAndNonVpcInstanceMemberships' => [ 'shape' => 'Boolean', ], 'VpcId' => [ 'shape' => 'String', ], 'OptionGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'OptionGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupMembership' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'OptionGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupMembership', 'locationName' => 'OptionGroupMembership', ], ], 'OptionGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupOption' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'MinimumRequiredMinorEngineVersion' => [ 'shape' => 'String', ], 'PortRequired' => [ 'shape' => 'Boolean', ], 'DefaultPort' => [ 'shape' => 'IntegerOptional', ], 'OptionsDependedOn' => [ 'shape' => 'OptionsDependedOn', ], 'OptionsConflictsWith' => [ 'shape' => 'OptionsConflictsWith', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'RequiresAutoMinorEngineVersionUpgrade' => [ 'shape' => 'Boolean', ], 'VpcOnly' => [ 'shape' => 'Boolean', ], 'SupportsOptionVersionDowngrade' => [ 'shape' => 'BooleanOptional', ], 'OptionGroupOptionSettings' => [ 'shape' => 'OptionGroupOptionSettingsList', ], 'OptionGroupOptionVersions' => [ 'shape' => 'OptionGroupOptionVersionsList', ], ], ], 'OptionGroupOptionSetting' => [ 'type' => 'structure', 'members' => [ 'SettingName' => [ 'shape' => 'String', ], 'SettingDescription' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersionPerAllowedValue' => [ 'shape' => 'MinimumEngineVersionPerAllowedValueList', ], ], ], 'OptionGroupOptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOptionSetting', 'locationName' => 'OptionGroupOptionSetting', ], ], 'OptionGroupOptionVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionVersion', 'locationName' => 'OptionVersion', ], ], 'OptionGroupOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOption', 'locationName' => 'OptionGroupOption', ], ], 'OptionGroupOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupOptions' => [ 'shape' => 'OptionGroupOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroups' => [ 'type' => 'structure', 'members' => [ 'OptionGroupsList' => [ 'shape' => 'OptionGroupsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroup', 'locationName' => 'OptionGroup', ], ], 'OptionNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'OptionSetting' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsCollection' => [ 'shape' => 'Boolean', ], ], ], 'OptionSettingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionVersion' => [ 'type' => 'structure', 'members' => [ 'Version' => [ 'shape' => 'String', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'OptionsConflictsWith' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionConflictName', ], ], 'OptionsDependedOn' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionName', ], ], 'OptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Option', 'locationName' => 'Option', ], ], 'OrderableDBInstanceOption' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'MultiAZCapable' => [ 'shape' => 'Boolean', ], 'ReadReplicaCapable' => [ 'shape' => 'Boolean', ], 'Vpc' => [ 'shape' => 'Boolean', ], 'SupportsStorageEncryption' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'SupportsIops' => [ 'shape' => 'Boolean', ], 'SupportsEnhancedMonitoring' => [ 'shape' => 'Boolean', ], 'SupportsIAMDatabaseAuthentication' => [ 'shape' => 'Boolean', ], 'SupportsPerformanceInsights' => [ 'shape' => 'Boolean', ], 'MinStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MaxStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MaxIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'MaxIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'AvailableProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], ], 'wrapper' => true, ], 'OrderableDBInstanceOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderableDBInstanceOption', 'locationName' => 'OrderableDBInstanceOption', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OrderableDBInstanceOptions' => [ 'shape' => 'OrderableDBInstanceOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ApplyMethod' => [ 'shape' => 'ApplyMethod', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PendingCloudwatchLogsExports' => [ 'type' => 'structure', 'members' => [ 'LogTypesToEnable' => [ 'shape' => 'LogTypeList', ], 'LogTypesToDisable' => [ 'shape' => 'LogTypeList', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'String', ], 'AutoAppliedAfterDate' => [ 'shape' => 'TStamp', ], 'ForcedApplyDate' => [ 'shape' => 'TStamp', ], 'OptInStatus' => [ 'shape' => 'String', ], 'CurrentApplyDate' => [ 'shape' => 'TStamp', ], 'Description' => [ 'shape' => 'String', ], ], ], 'PendingMaintenanceActionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', 'locationName' => 'PendingMaintenanceAction', ], ], 'PendingMaintenanceActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePendingMaintenanceActions', 'locationName' => 'ResourcePendingMaintenanceActions', ], ], 'PendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'PendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActions', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'DBInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], ], ], 'PointInTimeRestoreNotEnabledFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'PointInTimeRestoreNotEnabled', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'ProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessorFeature', 'locationName' => 'ProcessorFeature', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'PromoteReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ProvisionedIopsNotAvailableInAZFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'required' => [ 'ReservedDBInstancesOfferingId', ], 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'IntegerOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstance' => [ 'shape' => 'ReservedDBInstance', ], ], ], 'Range' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Integer', ], 'To' => [ 'shape' => 'Integer', ], 'Step' => [ 'shape' => 'IntegerOptional', ], ], ], 'RangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Range', 'locationName' => 'Range', ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBClusterIdentifier', ], ], 'ReadReplicaDBInstanceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBInstanceIdentifier', ], ], 'ReadReplicaIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaIdentifier', ], ], 'ReadersArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RebootDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'ForceFailover' => [ 'shape' => 'BooleanOptional', ], ], ], 'RebootDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', 'locationName' => 'RecurringCharge', ], ], 'RemoveFromGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DbClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveFromGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'RemoveRoleFromDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], ], ], 'RemoveRoleFromDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ReservedDBInstance' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'Integer', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'State' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], 'ReservedDBInstanceArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'ReservedDBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceAlreadyExists', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstance', 'locationName' => 'ReservedDBInstance', ], ], 'ReservedDBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstances' => [ 'shape' => 'ReservedDBInstanceList', ], ], ], 'ReservedDBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstancesOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], 'wrapper' => true, ], 'ReservedDBInstancesOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstancesOffering', 'locationName' => 'ReservedDBInstancesOffering', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferings' => [ 'shape' => 'ReservedDBInstancesOfferingList', ], ], ], 'ReservedDBInstancesOfferingNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstancesOfferingNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResetDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResetDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ResourceNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourcePendingMaintenanceActions' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'PendingMaintenanceActionDetails' => [ 'shape' => 'PendingMaintenanceActionDetails', ], ], 'wrapper' => true, ], 'RestoreDBClusterFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', 'MasterUsername', 'MasterUserPassword', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBClusterFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SnapshotIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBClusterFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SourceDBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreType' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreToTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBClusterToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBSnapshotIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBInstanceFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'TargetDBInstanceIdentifier', ], 'members' => [ 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'SourceDbiResourceId' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreWindow' => [ 'type' => 'structure', 'members' => [ 'EarliestTime' => [ 'shape' => 'TStamp', ], 'LatestTime' => [ 'shape' => 'TStamp', ], ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'RevokeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'SNSInvalidTopicFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSInvalidTopic', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSNoAuthorizationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSNoAuthorization', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSTopicArnNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSTopicArnNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], ], ], 'ScalingConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], ], ], 'SharedSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SharedSnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SourceId', ], ], 'SourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SourceRegion' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'SourceRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceRegion', 'locationName' => 'SourceRegion', ], ], 'SourceRegionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'SourceRegions' => [ 'shape' => 'SourceRegionList', ], ], ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'db-instance', 'db-parameter-group', 'db-security-group', 'db-snapshot', 'db-cluster', 'db-cluster-snapshot', ], ], 'StartDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StartDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StopDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StopDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StorageQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetStatus' => [ 'shape' => 'String', ], ], ], 'SubnetAlreadyInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetAlreadyInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubscriptionAlreadyExistFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionAlreadyExist', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionCategoryNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionCategoryNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SupportedCharacterSetsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CharacterSet', 'locationName' => 'CharacterSet', ], ], 'SupportedTimezonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Timezone', 'locationName' => 'Timezone', ], ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'Timezone' => [ 'type' => 'structure', 'members' => [ 'TimezoneName' => [ 'shape' => 'String', ], ], ], 'UpgradeTarget' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'AutoUpgrade' => [ 'shape' => 'Boolean', ], 'IsMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], ], ], 'ValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'Storage' => [ 'shape' => 'ValidStorageOptionsList', ], 'ValidProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], ], 'wrapper' => true, ], 'ValidStorageOptions' => [ 'type' => 'structure', 'members' => [ 'StorageType' => [ 'shape' => 'String', ], 'StorageSize' => [ 'shape' => 'RangeList', ], 'ProvisionedIops' => [ 'shape' => 'RangeList', ], 'IopsToStorageRatio' => [ 'shape' => 'DoubleRangeList', ], ], ], 'ValidStorageOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidStorageOptions', 'locationName' => 'ValidStorageOptions', ], ], 'ValidUpgradeTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeTarget', 'locationName' => 'UpgradeTarget', ], ], 'VpcSecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'VpcSecurityGroupId', ], ], 'VpcSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'VpcSecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'VpcSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcSecurityGroupMembership', 'locationName' => 'VpcSecurityGroupMembership', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2014-10-31', 'endpointPrefix' => 'rds', 'protocol' => 'query', 'serviceAbbreviation' => 'Amazon RDS', 'serviceFullName' => 'Amazon Relational Database Service', 'serviceId' => 'RDS', 'signatureVersion' => 'v4', 'uid' => 'rds-2014-10-31', 'xmlNamespace' => 'http://rds.amazonaws.com/doc/2014-10-31/', ], 'operations' => [ 'AddRoleToDBCluster' => [ 'name' => 'AddRoleToDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterRoleQuotaExceededFault', ], ], ], 'AddRoleToDBInstance' => [ 'name' => 'AddRoleToDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddRoleToDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceRoleQuotaExceededFault', ], ], ], 'AddSourceIdentifierToSubscription' => [ 'name' => 'AddSourceIdentifierToSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddSourceIdentifierToSubscriptionMessage', ], 'output' => [ 'shape' => 'AddSourceIdentifierToSubscriptionResult', 'resultWrapper' => 'AddSourceIdentifierToSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ApplyPendingMaintenanceAction' => [ 'name' => 'ApplyPendingMaintenanceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ApplyPendingMaintenanceActionMessage', ], 'output' => [ 'shape' => 'ApplyPendingMaintenanceActionResult', 'resultWrapper' => 'ApplyPendingMaintenanceActionResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'AuthorizeDBSecurityGroupIngress' => [ 'name' => 'AuthorizeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'AuthorizeDBSecurityGroupIngressResult', 'resultWrapper' => 'AuthorizeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'AuthorizationAlreadyExistsFault', ], [ 'shape' => 'AuthorizationQuotaExceededFault', ], ], ], 'BacktrackDBCluster' => [ 'name' => 'BacktrackDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BacktrackDBClusterMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrack', 'resultWrapper' => 'BacktrackDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'CopyDBClusterParameterGroup' => [ 'name' => 'CopyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBClusterParameterGroupResult', 'resultWrapper' => 'CopyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CopyDBClusterSnapshot' => [ 'name' => 'CopyDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBClusterSnapshotResult', 'resultWrapper' => 'CopyDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CopyDBParameterGroup' => [ 'name' => 'CopyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBParameterGroupResult', 'resultWrapper' => 'CopyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], ], ], 'CopyDBSnapshot' => [ 'name' => 'CopyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBSnapshotResult', 'resultWrapper' => 'CopyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CopyOptionGroup' => [ 'name' => 'CopyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyOptionGroupMessage', ], 'output' => [ 'shape' => 'CopyOptionGroupResult', 'resultWrapper' => 'CopyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'CreateDBCluster' => [ 'name' => 'CreateDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterMessage', ], 'output' => [ 'shape' => 'CreateDBClusterResult', 'resultWrapper' => 'CreateDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'CreateDBClusterEndpoint' => [ 'name' => 'CreateDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'CreateDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'DBClusterEndpointQuotaExceededFault', ], [ 'shape' => 'DBClusterEndpointAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'CreateDBClusterParameterGroup' => [ 'name' => 'CreateDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBClusterParameterGroupResult', 'resultWrapper' => 'CreateDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBClusterSnapshot' => [ 'name' => 'CreateDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBClusterSnapshotResult', 'resultWrapper' => 'CreateDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'CreateDBInstance' => [ 'name' => 'CreateDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceResult', 'resultWrapper' => 'CreateDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'CreateDBInstanceReadReplica' => [ 'name' => 'CreateDBInstanceReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceReadReplicaMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceReadReplicaResult', 'resultWrapper' => 'CreateDBInstanceReadReplicaResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotAllowedFault', ], [ 'shape' => 'InvalidDBSubnetGroupFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CreateDBParameterGroup' => [ 'name' => 'CreateDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBParameterGroupResult', 'resultWrapper' => 'CreateDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBSecurityGroup' => [ 'name' => 'CreateDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSecurityGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSecurityGroupResult', 'resultWrapper' => 'CreateDBSecurityGroupResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupAlreadyExistsFault', ], [ 'shape' => 'DBSecurityGroupQuotaExceededFault', ], [ 'shape' => 'DBSecurityGroupNotSupportedFault', ], ], ], 'CreateDBSnapshot' => [ 'name' => 'CreateDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBSnapshotResult', 'resultWrapper' => 'CreateDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], ], ], 'CreateDBSubnetGroup' => [ 'name' => 'CreateDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSubnetGroupResult', 'resultWrapper' => 'CreateDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'DBSubnetGroupQuotaExceededFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'CreateEventSubscription' => [ 'name' => 'CreateEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventSubscriptionMessage', ], 'output' => [ 'shape' => 'CreateEventSubscriptionResult', 'resultWrapper' => 'CreateEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionAlreadyExistFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'CreateGlobalCluster' => [ 'name' => 'CreateGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalClusterMessage', ], 'output' => [ 'shape' => 'CreateGlobalClusterResult', 'resultWrapper' => 'CreateGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterAlreadyExistsFault', ], [ 'shape' => 'GlobalClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'CreateOptionGroup' => [ 'name' => 'CreateOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOptionGroupMessage', ], 'output' => [ 'shape' => 'CreateOptionGroupResult', 'resultWrapper' => 'CreateOptionGroupResult', ], 'errors' => [ [ 'shape' => 'OptionGroupAlreadyExistsFault', ], [ 'shape' => 'OptionGroupQuotaExceededFault', ], ], ], 'DeleteDBCluster' => [ 'name' => 'DeleteDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterResult', 'resultWrapper' => 'DeleteDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'DeleteDBClusterEndpoint' => [ 'name' => 'DeleteDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'DeleteDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBClusterParameterGroup' => [ 'name' => 'DeleteDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBClusterSnapshot' => [ 'name' => 'DeleteDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterSnapshotResult', 'resultWrapper' => 'DeleteDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DeleteDBInstance' => [ 'name' => 'DeleteDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceResult', 'resultWrapper' => 'DeleteDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupQuotaExceededFault', ], ], ], 'DeleteDBInstanceAutomatedBackup' => [ 'name' => 'DeleteDBInstanceAutomatedBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceAutomatedBackupResult', 'resultWrapper' => 'DeleteDBInstanceAutomatedBackupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceAutomatedBackupStateFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DeleteDBParameterGroup' => [ 'name' => 'DeleteDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBSecurityGroup' => [ 'name' => 'DeleteDBSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSecurityGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DeleteDBSnapshot' => [ 'name' => 'DeleteDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBSnapshotResult', 'resultWrapper' => 'DeleteDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DeleteDBSubnetGroup' => [ 'name' => 'DeleteDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidDBSubnetStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DeleteEventSubscription' => [ 'name' => 'DeleteEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventSubscriptionMessage', ], 'output' => [ 'shape' => 'DeleteEventSubscriptionResult', 'resultWrapper' => 'DeleteEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'InvalidEventSubscriptionStateFault', ], ], ], 'DeleteGlobalCluster' => [ 'name' => 'DeleteGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalClusterMessage', ], 'output' => [ 'shape' => 'DeleteGlobalClusterResult', 'resultWrapper' => 'DeleteGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'DeleteOptionGroup' => [ 'name' => 'DeleteOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOptionGroupMessage', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'InvalidOptionGroupStateFault', ], ], ], 'DescribeAccountAttributes' => [ 'name' => 'DescribeAccountAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAccountAttributesMessage', ], 'output' => [ 'shape' => 'AccountAttributesMessage', 'resultWrapper' => 'DescribeAccountAttributesResult', ], ], 'DescribeCertificates' => [ 'name' => 'DescribeCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificatesMessage', ], 'output' => [ 'shape' => 'CertificateMessage', 'resultWrapper' => 'DescribeCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'DescribeDBClusterBacktracks' => [ 'name' => 'DescribeDBClusterBacktracks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterBacktracksMessage', ], 'output' => [ 'shape' => 'DBClusterBacktrackMessage', 'resultWrapper' => 'DescribeDBClusterBacktracksResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterBacktrackNotFoundFault', ], ], ], 'DescribeDBClusterEndpoints' => [ 'name' => 'DescribeDBClusterEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterEndpointsMessage', ], 'output' => [ 'shape' => 'DBClusterEndpointMessage', 'resultWrapper' => 'DescribeDBClusterEndpointsResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBClusterParameterGroups' => [ 'name' => 'DescribeDBClusterParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupsMessage', 'resultWrapper' => 'DescribeDBClusterParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterParameters' => [ 'name' => 'DescribeDBClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParametersMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupDetails', 'resultWrapper' => 'DescribeDBClusterParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterSnapshotAttributes' => [ 'name' => 'DescribeDBClusterSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBClusterSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusterSnapshots' => [ 'name' => 'DescribeDBClusterSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotsMessage', ], 'output' => [ 'shape' => 'DBClusterSnapshotMessage', 'resultWrapper' => 'DescribeDBClusterSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusters' => [ 'name' => 'DescribeDBClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClustersMessage', ], 'output' => [ 'shape' => 'DBClusterMessage', 'resultWrapper' => 'DescribeDBClustersResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBEngineVersions' => [ 'name' => 'DescribeDBEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBEngineVersionsMessage', ], 'output' => [ 'shape' => 'DBEngineVersionMessage', 'resultWrapper' => 'DescribeDBEngineVersionsResult', ], ], 'DescribeDBInstanceAutomatedBackups' => [ 'name' => 'DescribeDBInstanceAutomatedBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstanceAutomatedBackupsMessage', ], 'output' => [ 'shape' => 'DBInstanceAutomatedBackupMessage', 'resultWrapper' => 'DescribeDBInstanceAutomatedBackupsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'DescribeDBInstances' => [ 'name' => 'DescribeDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstancesMessage', ], 'output' => [ 'shape' => 'DBInstanceMessage', 'resultWrapper' => 'DescribeDBInstancesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBLogFiles' => [ 'name' => 'DescribeDBLogFiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBLogFilesMessage', ], 'output' => [ 'shape' => 'DescribeDBLogFilesResponse', 'resultWrapper' => 'DescribeDBLogFilesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBParameterGroups' => [ 'name' => 'DescribeDBParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBParameterGroupsMessage', 'resultWrapper' => 'DescribeDBParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBParameters' => [ 'name' => 'DescribeDBParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBParametersMessage', ], 'output' => [ 'shape' => 'DBParameterGroupDetails', 'resultWrapper' => 'DescribeDBParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBSecurityGroups' => [ 'name' => 'DescribeDBSecurityGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSecurityGroupsMessage', ], 'output' => [ 'shape' => 'DBSecurityGroupMessage', 'resultWrapper' => 'DescribeDBSecurityGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], ], ], 'DescribeDBSnapshotAttributes' => [ 'name' => 'DescribeDBSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSnapshots' => [ 'name' => 'DescribeDBSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSnapshotsMessage', ], 'output' => [ 'shape' => 'DBSnapshotMessage', 'resultWrapper' => 'DescribeDBSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'DescribeDBSubnetGroups' => [ 'name' => 'DescribeDBSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSubnetGroupsMessage', ], 'output' => [ 'shape' => 'DBSubnetGroupMessage', 'resultWrapper' => 'DescribeDBSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultClusterParameters' => [ 'name' => 'DescribeEngineDefaultClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultClusterParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultClusterParametersResult', 'resultWrapper' => 'DescribeEngineDefaultClusterParametersResult', ], ], 'DescribeEngineDefaultParameters' => [ 'name' => 'DescribeEngineDefaultParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultParametersResult', 'resultWrapper' => 'DescribeEngineDefaultParametersResult', ], ], 'DescribeEventCategories' => [ 'name' => 'DescribeEventCategories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventCategoriesMessage', ], 'output' => [ 'shape' => 'EventCategoriesMessage', 'resultWrapper' => 'DescribeEventCategoriesResult', ], ], 'DescribeEventSubscriptions' => [ 'name' => 'DescribeEventSubscriptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventSubscriptionsMessage', ], 'output' => [ 'shape' => 'EventSubscriptionsMessage', 'resultWrapper' => 'DescribeEventSubscriptionsResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], ], 'DescribeGlobalClusters' => [ 'name' => 'DescribeGlobalClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalClustersMessage', ], 'output' => [ 'shape' => 'GlobalClustersMessage', 'resultWrapper' => 'DescribeGlobalClustersResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], ], ], 'DescribeOptionGroupOptions' => [ 'name' => 'DescribeOptionGroupOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupOptionsMessage', ], 'output' => [ 'shape' => 'OptionGroupOptionsMessage', 'resultWrapper' => 'DescribeOptionGroupOptionsResult', ], ], 'DescribeOptionGroups' => [ 'name' => 'DescribeOptionGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOptionGroupsMessage', ], 'output' => [ 'shape' => 'OptionGroups', 'resultWrapper' => 'DescribeOptionGroupsResult', ], 'errors' => [ [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'DescribeOrderableDBInstanceOptions' => [ 'name' => 'DescribeOrderableDBInstanceOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrderableDBInstanceOptionsMessage', ], 'output' => [ 'shape' => 'OrderableDBInstanceOptionsMessage', 'resultWrapper' => 'DescribeOrderableDBInstanceOptionsResult', ], ], 'DescribePendingMaintenanceActions' => [ 'name' => 'DescribePendingMaintenanceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingMaintenanceActionsMessage', ], 'output' => [ 'shape' => 'PendingMaintenanceActionsMessage', 'resultWrapper' => 'DescribePendingMaintenanceActionsResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], ], ], 'DescribeReservedDBInstances' => [ 'name' => 'DescribeReservedDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesMessage', ], 'output' => [ 'shape' => 'ReservedDBInstanceMessage', 'resultWrapper' => 'DescribeReservedDBInstancesResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstanceNotFoundFault', ], ], ], 'DescribeReservedDBInstancesOfferings' => [ 'name' => 'DescribeReservedDBInstancesOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedDBInstancesOfferingsMessage', ], 'output' => [ 'shape' => 'ReservedDBInstancesOfferingMessage', 'resultWrapper' => 'DescribeReservedDBInstancesOfferingsResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], ], ], 'DescribeSourceRegions' => [ 'name' => 'DescribeSourceRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSourceRegionsMessage', ], 'output' => [ 'shape' => 'SourceRegionMessage', 'resultWrapper' => 'DescribeSourceRegionsResult', ], ], 'DescribeValidDBInstanceModifications' => [ 'name' => 'DescribeValidDBInstanceModifications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeValidDBInstanceModificationsMessage', ], 'output' => [ 'shape' => 'DescribeValidDBInstanceModificationsResult', 'resultWrapper' => 'DescribeValidDBInstanceModificationsResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'DownloadDBLogFilePortion' => [ 'name' => 'DownloadDBLogFilePortion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDBLogFilePortionMessage', ], 'output' => [ 'shape' => 'DownloadDBLogFilePortionDetails', 'resultWrapper' => 'DownloadDBLogFilePortionResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBLogFileNotFoundFault', ], ], ], 'FailoverDBCluster' => [ 'name' => 'FailoverDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverDBClusterMessage', ], 'output' => [ 'shape' => 'FailoverDBClusterResult', 'resultWrapper' => 'FailoverDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ModifyCurrentDBClusterCapacity' => [ 'name' => 'ModifyCurrentDBClusterCapacity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCurrentDBClusterCapacityMessage', ], 'output' => [ 'shape' => 'DBClusterCapacityInfo', 'resultWrapper' => 'ModifyCurrentDBClusterCapacityResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterCapacityFault', ], ], ], 'ModifyDBCluster' => [ 'name' => 'ModifyDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterResult', 'resultWrapper' => 'ModifyDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterAlreadyExistsFault', ], ], ], 'ModifyDBClusterEndpoint' => [ 'name' => 'ModifyDBClusterEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterEndpointMessage', ], 'output' => [ 'shape' => 'DBClusterEndpoint', 'resultWrapper' => 'ModifyDBClusterEndpointResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterEndpointStateFault', ], [ 'shape' => 'DBClusterEndpointNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ModifyDBClusterParameterGroup' => [ 'name' => 'ModifyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBClusterSnapshotAttribute' => [ 'name' => 'ModifyDBClusterSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBClusterSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBInstance' => [ 'name' => 'ModifyDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBInstanceMessage', ], 'output' => [ 'shape' => 'ModifyDBInstanceResult', 'resultWrapper' => 'ModifyDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'DBUpgradeDependencyFailureFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'ModifyDBParameterGroup' => [ 'name' => 'ModifyDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBSnapshot' => [ 'name' => 'ModifyDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotResult', 'resultWrapper' => 'ModifyDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], ], ], 'ModifyDBSnapshotAttribute' => [ 'name' => 'ModifyDBSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBSubnetGroup' => [ 'name' => 'ModifyDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyDBSubnetGroupResult', 'resultWrapper' => 'ModifyDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetAlreadyInUse', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'ModifyEventSubscription' => [ 'name' => 'ModifyEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyEventSubscriptionMessage', ], 'output' => [ 'shape' => 'ModifyEventSubscriptionResult', 'resultWrapper' => 'ModifyEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], ], ], 'ModifyGlobalCluster' => [ 'name' => 'ModifyGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalClusterMessage', ], 'output' => [ 'shape' => 'ModifyGlobalClusterResult', 'resultWrapper' => 'ModifyGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'ModifyOptionGroup' => [ 'name' => 'ModifyOptionGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyOptionGroupMessage', ], 'output' => [ 'shape' => 'ModifyOptionGroupResult', 'resultWrapper' => 'ModifyOptionGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidOptionGroupStateFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], ], ], 'PromoteReadReplica' => [ 'name' => 'PromoteReadReplica', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaResult', 'resultWrapper' => 'PromoteReadReplicaResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'PromoteReadReplicaDBCluster' => [ 'name' => 'PromoteReadReplicaDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PromoteReadReplicaDBClusterMessage', ], 'output' => [ 'shape' => 'PromoteReadReplicaDBClusterResult', 'resultWrapper' => 'PromoteReadReplicaDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'PurchaseReservedDBInstancesOffering' => [ 'name' => 'PurchaseReservedDBInstancesOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingMessage', ], 'output' => [ 'shape' => 'PurchaseReservedDBInstancesOfferingResult', 'resultWrapper' => 'PurchaseReservedDBInstancesOfferingResult', ], 'errors' => [ [ 'shape' => 'ReservedDBInstancesOfferingNotFoundFault', ], [ 'shape' => 'ReservedDBInstanceAlreadyExistsFault', ], [ 'shape' => 'ReservedDBInstanceQuotaExceededFault', ], ], ], 'RebootDBInstance' => [ 'name' => 'RebootDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBInstanceMessage', ], 'output' => [ 'shape' => 'RebootDBInstanceResult', 'resultWrapper' => 'RebootDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'RemoveFromGlobalCluster' => [ 'name' => 'RemoveFromGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveFromGlobalClusterMessage', ], 'output' => [ 'shape' => 'RemoveFromGlobalClusterResult', 'resultWrapper' => 'RemoveFromGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'RemoveRoleFromDBCluster' => [ 'name' => 'RemoveRoleFromDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBClusterMessage', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterRoleNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'RemoveRoleFromDBInstance' => [ 'name' => 'RemoveRoleFromDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveRoleFromDBInstanceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBInstanceRoleNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'RemoveSourceIdentifierFromSubscription' => [ 'name' => 'RemoveSourceIdentifierFromSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionMessage', ], 'output' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionResult', 'resultWrapper' => 'RemoveSourceIdentifierFromSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ResetDBClusterParameterGroup' => [ 'name' => 'ResetDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ResetDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'ResetDBParameterGroup' => [ 'name' => 'ResetDBParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBParameterGroupMessage', ], 'output' => [ 'shape' => 'DBParameterGroupNameMessage', 'resultWrapper' => 'ResetDBParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterFromS3' => [ 'name' => 'RestoreDBClusterFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBClusterFromS3Result', 'resultWrapper' => 'RestoreDBClusterFromS3Result', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], ], ], 'RestoreDBClusterFromSnapshot' => [ 'name' => 'RestoreDBClusterFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterFromSnapshotResult', 'resultWrapper' => 'RestoreDBClusterFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterToPointInTime' => [ 'name' => 'RestoreDBClusterToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterToPointInTimeResult', 'resultWrapper' => 'RestoreDBClusterToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], ], ], 'RestoreDBInstanceFromDBSnapshot' => [ 'name' => 'RestoreDBInstanceFromDBSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromDBSnapshotResult', 'resultWrapper' => 'RestoreDBInstanceFromDBSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'RestoreDBInstanceFromS3' => [ 'name' => 'RestoreDBInstanceFromS3', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceFromS3Message', ], 'output' => [ 'shape' => 'RestoreDBInstanceFromS3Result', 'resultWrapper' => 'RestoreDBInstanceFromS3Result', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidS3BucketFault', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], ], ], 'RestoreDBInstanceToPointInTime' => [ 'name' => 'RestoreDBInstanceToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBInstanceToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBInstanceToPointInTimeResult', 'resultWrapper' => 'RestoreDBInstanceToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'PointInTimeRestoreNotEnabledFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'ProvisionedIopsNotAvailableInAZFault', ], [ 'shape' => 'OptionGroupNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DomainNotFoundFault', ], [ 'shape' => 'BackupPolicyNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBInstanceAutomatedBackupNotFoundFault', ], ], ], 'RevokeDBSecurityGroupIngress' => [ 'name' => 'RevokeDBSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeDBSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'RevokeDBSecurityGroupIngressResult', 'resultWrapper' => 'RevokeDBSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], ], ], 'StartDBCluster' => [ 'name' => 'StartDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBClusterMessage', ], 'output' => [ 'shape' => 'StartDBClusterResult', 'resultWrapper' => 'StartDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StartDBInstance' => [ 'name' => 'StartDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBInstanceMessage', ], 'output' => [ 'shape' => 'StartDBInstanceResult', 'resultWrapper' => 'StartDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'StopDBCluster' => [ 'name' => 'StopDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBClusterMessage', ], 'output' => [ 'shape' => 'StopDBClusterResult', 'resultWrapper' => 'StopDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StopDBInstance' => [ 'name' => 'StopDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBInstanceMessage', ], 'output' => [ 'shape' => 'StopDBInstanceResult', 'resultWrapper' => 'StopDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], ], 'shapes' => [ 'AccountAttributesMessage' => [ 'type' => 'structure', 'members' => [ 'AccountQuotas' => [ 'shape' => 'AccountQuotaList', ], ], ], 'AccountQuota' => [ 'type' => 'structure', 'members' => [ 'AccountQuotaName' => [ 'shape' => 'String', ], 'Used' => [ 'shape' => 'Long', ], 'Max' => [ 'shape' => 'Long', ], ], 'wrapper' => true, ], 'AccountQuotaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountQuota', 'locationName' => 'AccountQuota', ], ], 'AddRoleToDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], ], ], 'AddRoleToDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ApplyMethod' => [ 'type' => 'string', 'enum' => [ 'immediate', 'pending-reboot', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceIdentifier', 'ApplyAction', 'OptInType', ], 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'ApplyAction' => [ 'shape' => 'String', ], 'OptInType' => [ 'shape' => 'String', ], ], ], 'ApplyPendingMaintenanceActionResult' => [ 'type' => 'structure', 'members' => [ 'ResourcePendingMaintenanceActions' => [ 'shape' => 'ResourcePendingMaintenanceActions', ], ], ], 'AttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AttributeValue', ], ], 'AuthorizationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', 'locationName' => 'AvailabilityZone', ], ], 'AvailabilityZones' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'AvailableProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], ], ], 'AvailableProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailableProcessorFeature', 'locationName' => 'AvailableProcessorFeature', ], ], 'BacktrackDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'BacktrackTo', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'Force' => [ 'shape' => 'BooleanOptional', ], 'UseEarliestTimeOnPointInTimeUnavailable' => [ 'shape' => 'BooleanOptional', ], ], ], 'BackupPolicyNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'deprecated' => true, 'deprecatedMessage' => 'Please avoid using this fault', 'error' => [ 'code' => 'BackupPolicyNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'CertificateType' => [ 'shape' => 'String', ], 'Thumbprint' => [ 'shape' => 'String', ], 'ValidFrom' => [ 'shape' => 'TStamp', ], 'ValidTill' => [ 'shape' => 'TStamp', ], 'CertificateArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Certificate', 'locationName' => 'Certificate', ], ], 'CertificateMessage' => [ 'type' => 'structure', 'members' => [ 'Certificates' => [ 'shape' => 'CertificateList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'CertificateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CertificateNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CharacterSet' => [ 'type' => 'structure', 'members' => [ 'CharacterSetName' => [ 'shape' => 'String', ], 'CharacterSetDescription' => [ 'shape' => 'String', ], ], ], 'CloudwatchLogsExportConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableLogTypes' => [ 'shape' => 'LogTypeList', ], 'DisableLogTypes' => [ 'shape' => 'LogTypeList', ], ], ], 'CopyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupDescription', ], 'members' => [ 'SourceDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CopyDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterSnapshotIdentifier', 'TargetDBClusterSnapshotIdentifier', ], 'members' => [ 'SourceDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CopyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBParameterGroupIdentifier', 'TargetDBParameterGroupIdentifier', 'TargetDBParameterGroupDescription', ], 'members' => [ 'SourceDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CopyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBSnapshotIdentifier', 'TargetDBSnapshotIdentifier', ], 'members' => [ 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'CopyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CopyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceOptionGroupIdentifier', 'TargetOptionGroupIdentifier', 'TargetOptionGroupDescription', ], 'members' => [ 'SourceOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupIdentifier' => [ 'shape' => 'String', ], 'TargetOptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'CreateDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'DBClusterEndpointIdentifier', 'EndpointType', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], ], ], 'CreateDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CreateDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'CreateDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'DBClusterIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'Timezone' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBInstanceReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'SourceDBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'StorageType' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'DestinationRegion' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateDBInstanceReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroup' => [ 'shape' => 'DBParameterGroup', ], ], ], 'CreateDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', 'DBSecurityGroupDescription', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSecurityGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'CreateDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'DBInstanceIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'CreateDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'DBSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'CreateEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SnsTopicArn', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'SourceIds' => [ 'shape' => 'SourceIdsList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'CreateGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'CreateOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', 'EngineName', 'MajorEngineVersion', 'OptionGroupDescription', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'DBCluster' => [ 'type' => 'structure', 'members' => [ 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroup' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'String', ], 'EarliestRestorableTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'String', ], 'ReaderEndpoint' => [ 'shape' => 'String', ], 'CustomEndpoints' => [ 'shape' => 'StringList', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBClusterOptionGroupMemberships' => [ 'shape' => 'DBClusterOptionGroupMemberships', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaIdentifiers' => [ 'shape' => 'ReadReplicaIdentifierList', ], 'DBClusterMembers' => [ 'shape' => 'DBClusterMemberList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'HostedZoneId' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'AssociatedRoles' => [ 'shape' => 'DBClusterRoles', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'CloneGroupId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'EarliestBacktrackTime' => [ 'shape' => 'TStamp', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'BacktrackConsumedChangeRecords' => [ 'shape' => 'LongOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfigurationInfo' => [ 'shape' => 'ScalingConfigurationInfo', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'HttpEndpointEnabled' => [ 'shape' => 'Boolean', ], 'CopyTagsToSnapshot' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'DBClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterBacktrack' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'BacktrackTo' => [ 'shape' => 'TStamp', ], 'BacktrackedFrom' => [ 'shape' => 'TStamp', ], 'BacktrackRequestCreationTime' => [ 'shape' => 'TStamp', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterBacktrackList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterBacktrack', 'locationName' => 'DBClusterBacktrack', ], ], 'DBClusterBacktrackMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterBacktracks' => [ 'shape' => 'DBClusterBacktrackList', ], ], ], 'DBClusterBacktrackNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterBacktrackNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterCapacityInfo' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'PendingCapacity' => [ 'shape' => 'IntegerOptional', ], 'CurrentCapacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpoint' => [ 'type' => 'structure', 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointResourceIdentifier' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'CustomEndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], 'DBClusterEndpointArn' => [ 'shape' => 'String', ], ], ], 'DBClusterEndpointAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterEndpoint', 'locationName' => 'DBClusterEndpointList', ], ], 'DBClusterEndpointMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterEndpoints' => [ 'shape' => 'DBClusterEndpointList', ], ], ], 'DBClusterEndpointNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterEndpointQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterEndpointQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBCluster', 'locationName' => 'DBCluster', ], ], 'DBClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'IsClusterWriter' => [ 'shape' => 'Boolean', ], 'DBClusterParameterGroupStatus' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterMember', 'locationName' => 'DBClusterMember', ], ], 'DBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusters' => [ 'shape' => 'DBClusterList', ], ], ], 'DBClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterOptionGroupMemberships' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterOptionGroupStatus', 'locationName' => 'DBClusterOptionGroup', ], ], 'DBClusterOptionGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBClusterOptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBClusterParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterParameterGroup', 'locationName' => 'DBClusterParameterGroup', ], ], 'DBClusterParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterParameterGroups' => [ 'shape' => 'DBClusterParameterGroupList', ], ], ], 'DBClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterRole', 'locationName' => 'DBClusterRole', ], ], 'DBClusterSnapshot' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'VpcId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBClusterSnapshotArn' => [ 'shape' => 'String', ], 'SourceDBClusterSnapshotArn' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], ], 'DBClusterSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshotAttribute', 'locationName' => 'DBClusterSnapshotAttribute', ], ], 'DBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotAttributes' => [ 'shape' => 'DBClusterSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBClusterSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshot', 'locationName' => 'DBClusterSnapshot', ], ], 'DBClusterSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterSnapshots' => [ 'shape' => 'DBClusterSnapshotList', ], ], ], 'DBClusterSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'DBEngineDescription' => [ 'shape' => 'String', ], 'DBEngineVersionDescription' => [ 'shape' => 'String', ], 'DefaultCharacterSet' => [ 'shape' => 'CharacterSet', ], 'SupportedCharacterSets' => [ 'shape' => 'SupportedCharacterSetsList', ], 'ValidUpgradeTarget' => [ 'shape' => 'ValidUpgradeTargetList', ], 'SupportedTimezones' => [ 'shape' => 'SupportedTimezonesList', ], 'ExportableLogTypes' => [ 'shape' => 'LogTypeList', ], 'SupportsLogExportsToCloudwatchLogs' => [ 'shape' => 'Boolean', ], 'SupportsReadReplica' => [ 'shape' => 'Boolean', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], 'SupportedFeatureNames' => [ 'shape' => 'FeatureNameList', ], ], ], 'DBEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBEngineVersion', 'locationName' => 'DBEngineVersion', ], ], 'DBEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBEngineVersions' => [ 'shape' => 'DBEngineVersionList', ], ], ], 'DBInstance' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DBInstanceStatus' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'Integer', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupStatusList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'ReadReplicaSourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaDBInstanceIdentifiers' => [ 'shape' => 'ReadReplicaDBInstanceIdentifierList', ], 'ReadReplicaDBClusterIdentifiers' => [ 'shape' => 'ReadReplicaDBClusterIdentifierList', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupMemberships' => [ 'shape' => 'OptionGroupMembershipList', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'SecondaryAvailabilityZone' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'Boolean', ], 'StatusInfos' => [ 'shape' => 'DBInstanceStatusInfoList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'DbInstancePort' => [ 'shape' => 'Integer', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DomainMemberships' => [ 'shape' => 'DomainMembershipList', ], 'CopyTagsToSnapshot' => [ 'shape' => 'Boolean', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'EnhancedMonitoringResourceArn' => [ 'shape' => 'String', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'PerformanceInsightsEnabled' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'AssociatedRoles' => [ 'shape' => 'DBInstanceRoles', ], 'ListenerEndpoint' => [ 'shape' => 'Endpoint', ], ], 'wrapper' => true, ], 'DBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackup' => [ 'type' => 'structure', 'members' => [ 'DBInstanceArn' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'Region' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreWindow' => [ 'shape' => 'RestoreWindow', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'DBInstanceAutomatedBackupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceAutomatedBackup', 'locationName' => 'DBInstanceAutomatedBackup', ], ], 'DBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstanceAutomatedBackups' => [ 'shape' => 'DBInstanceAutomatedBackupList', ], ], ], 'DBInstanceAutomatedBackupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAutomatedBackupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstance', 'locationName' => 'DBInstance', ], ], 'DBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstances' => [ 'shape' => 'DBInstanceList', ], ], ], 'DBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoleQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceRoleQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceRole', 'locationName' => 'DBInstanceRole', ], ], 'DBInstanceStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBInstanceStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceStatusInfo', 'locationName' => 'DBInstanceStatusInfo', ], ], 'DBLogFileNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBLogFileNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroup', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupStatus' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ParameterApplyStatus' => [ 'shape' => 'String', ], ], ], 'DBParameterGroupStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBParameterGroupStatus', 'locationName' => 'DBParameterGroup', ], ], 'DBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBParameterGroups' => [ 'shape' => 'DBParameterGroupList', ], ], ], 'DBSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'OwnerId' => [ 'shape' => 'String', ], 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'EC2SecurityGroups' => [ 'shape' => 'EC2SecurityGroupList', ], 'IPRanges' => [ 'shape' => 'IPRangeList', ], 'DBSecurityGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSecurityGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroupMembership', 'locationName' => 'DBSecurityGroup', ], ], 'DBSecurityGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroups', ], ], ], 'DBSecurityGroupNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'DBSecurityGroupName', ], ], 'DBSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'QuotaExceeded.DBSecurityGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSecurityGroup', 'locationName' => 'DBSecurityGroup', ], ], 'DBSnapshot' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'SourceRegion' => [ 'shape' => 'String', ], 'SourceDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'Encrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBSnapshotArn' => [ 'shape' => 'String', ], 'Timezone' => [ 'shape' => 'String', ], 'IAMDatabaseAuthenticationEnabled' => [ 'shape' => 'Boolean', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], 'wrapper' => true, ], 'DBSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshotAttribute', 'locationName' => 'DBSnapshotAttribute', ], ], 'DBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotAttributes' => [ 'shape' => 'DBSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSnapshot', 'locationName' => 'DBSnapshot', ], ], 'DBSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSnapshots' => [ 'shape' => 'DBSnapshotList', ], ], ], 'DBSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'SubnetGroupStatus' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'DBSubnetGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupDoesNotCoverEnoughAZs', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSubnetGroups' => [ 'shape' => 'DBSubnetGroups', ], ], ], 'DBSubnetGroupNotAllowedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotAllowedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSubnetGroup', 'locationName' => 'DBSubnetGroup', ], ], 'DBSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBUpgradeDependencyFailureFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBUpgradeDependencyFailure', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DeleteDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'DeleteDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'type' => 'structure', 'required' => [ 'DbiResourceId', ], 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DeleteDBInstanceAutomatedBackupResult' => [ 'type' => 'structure', 'members' => [ 'DBInstanceAutomatedBackup' => [ 'shape' => 'DBInstanceAutomatedBackup', ], ], ], 'DeleteDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DeleteAutomatedBackups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DeleteDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'DeleteDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'DeleteDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'DeleteGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DeleteOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'DescribeAccountAttributesMessage' => [ 'type' => 'structure', 'members' => [], ], 'DescribeCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterBacktracksMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'BacktrackIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterEndpointsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'DescribeDBClusterSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], ], ], 'DescribeDBClustersMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], 'ListSupportedCharacterSets' => [ 'shape' => 'BooleanOptional', ], 'ListSupportedTimezones' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeDBInstanceAutomatedBackupsMessage' => [ 'type' => 'structure', 'members' => [ 'DbiResourceId' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileName' => [ 'shape' => 'String', ], 'LastWritten' => [ 'shape' => 'Long', ], 'Size' => [ 'shape' => 'Long', ], ], ], 'DescribeDBLogFilesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribeDBLogFilesDetails', 'locationName' => 'DescribeDBLogFilesDetails', ], ], 'DescribeDBLogFilesMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'FilenameContains' => [ 'shape' => 'String', ], 'FileLastWritten' => [ 'shape' => 'Long', ], 'FileSize' => [ 'shape' => 'Long', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBLogFilesResponse' => [ 'type' => 'structure', 'members' => [ 'DescribeDBLogFiles' => [ 'shape' => 'DescribeDBLogFilesList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSecurityGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'DescribeDBSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], 'DbiResourceId' => [ 'shape' => 'String', ], ], ], 'DescribeDBSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEngineDefaultParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeEventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeGlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOptionGroupOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'EngineName', ], 'members' => [ 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOptionGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], ], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', ], 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Vpc' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribePendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeReservedDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedDBInstancesOfferingsMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeSourceRegionsMessage' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeValidDBInstanceModificationsResult' => [ 'type' => 'structure', 'members' => [ 'ValidDBInstanceModificationsMessage' => [ 'shape' => 'ValidDBInstanceModificationsMessage', ], ], ], 'DomainMembership' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'FQDN' => [ 'shape' => 'String', ], 'IAMRoleName' => [ 'shape' => 'String', ], ], ], 'DomainMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainMembership', 'locationName' => 'DomainMembership', ], ], 'DomainNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DomainNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'Double' => [ 'type' => 'double', ], 'DoubleOptional' => [ 'type' => 'double', ], 'DoubleRange' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Double', ], 'To' => [ 'shape' => 'Double', ], ], ], 'DoubleRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DoubleRange', 'locationName' => 'DoubleRange', ], ], 'DownloadDBLogFilePortionDetails' => [ 'type' => 'structure', 'members' => [ 'LogFileData' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'AdditionalDataPending' => [ 'shape' => 'Boolean', ], ], ], 'DownloadDBLogFilePortionMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'LogFileName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'LogFileName' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'NumberOfLines' => [ 'shape' => 'Integer', ], ], ], 'EC2SecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'EC2SecurityGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2SecurityGroup', 'locationName' => 'EC2SecurityGroup', ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'HostedZoneId' => [ 'shape' => 'String', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], 'wrapper' => true, ], 'EngineModeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Date' => [ 'shape' => 'TStamp', ], 'SourceArn' => [ 'shape' => 'String', ], ], ], 'EventCategoriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'EventCategory', ], ], 'EventCategoriesMap' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], ], 'wrapper' => true, ], 'EventCategoriesMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventCategoriesMap', 'locationName' => 'EventCategoriesMap', ], ], 'EventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'EventCategoriesMapList' => [ 'shape' => 'EventCategoriesMapList', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventSubscription' => [ 'type' => 'structure', 'members' => [ 'CustomerAwsId' => [ 'shape' => 'String', ], 'CustSubscriptionId' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SubscriptionCreationTime' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'SourceIdsList' => [ 'shape' => 'SourceIdsList', ], 'EventCategoriesList' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'EventSubscriptionArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'EventSubscriptionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'EventSubscriptionQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EventSubscriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSubscription', 'locationName' => 'EventSubscription', ], ], 'EventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'EventSubscriptionsList' => [ 'shape' => 'EventSubscriptionsList', ], ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'FailoverDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'FailoverDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'FeatureNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', 'locationName' => 'Filter', ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'Value', ], ], 'GlobalCluster' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'GlobalClusterResourceId' => [ 'shape' => 'String', ], 'GlobalClusterArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterMembers' => [ 'shape' => 'GlobalClusterMemberList', ], ], 'wrapper' => true, ], 'GlobalClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalCluster', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBClusterArn' => [ 'shape' => 'String', ], 'Readers' => [ 'shape' => 'ReadersArnList', ], 'IsWriter' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'GlobalClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalClusterMember', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalClusters' => [ 'shape' => 'GlobalClusterList', ], ], ], 'IPRange' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], ], ], 'IPRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IPRange', 'locationName' => 'IPRange', ], ], 'InstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBClusterCapacityFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBInstanceCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBInstanceCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientStorageClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientStorageClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'InvalidDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterCapacityFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterEndpointStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterEndpointStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceAutomatedBackupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidEventSubscriptionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidEventSubscriptionState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidOptionGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidOptionGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidRestoreFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidRestoreFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidS3BucketFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidS3BucketFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KMSKeyNotAccessibleFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'KMSKeyNotAccessibleFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'LogTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Long' => [ 'type' => 'long', ], 'LongOptional' => [ 'type' => 'long', ], 'MinimumEngineVersionPerAllowedValue' => [ 'type' => 'structure', 'members' => [ 'AllowedValue' => [ 'shape' => 'String', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MinimumEngineVersionPerAllowedValue', 'locationName' => 'MinimumEngineVersionPerAllowedValue', ], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Capacity' => [ 'shape' => 'IntegerOptional', ], 'SecondsBeforeTimeout' => [ 'shape' => 'IntegerOptional', ], 'TimeoutAction' => [ 'shape' => 'String', ], ], ], 'ModifyDBClusterEndpointMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterEndpointIdentifier', ], 'members' => [ 'DBClusterEndpointIdentifier' => [ 'shape' => 'String', ], 'EndpointType' => [ 'shape' => 'String', ], 'StaticMembers' => [ 'shape' => 'StringList', ], 'ExcludedMembers' => [ 'shape' => 'StringList', ], ], ], 'ModifyDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'NewDBClusterIdentifier' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'EngineVersion' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'EnableHttpEndpoint' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'Parameters', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'ModifyDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'NewDBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'Domain' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'DBPortNumber' => [ 'shape' => 'IntegerOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ModifyDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', 'Parameters', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshotAttributesResult' => [ 'shape' => 'DBSnapshotAttributesResult', ], ], ], 'ModifyDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBSnapshotIdentifier', ], 'members' => [ 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], ], ], 'ModifyDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBSnapshot' => [ 'shape' => 'DBSnapshot', ], ], ], 'ModifyDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'ModifyEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'ModifyGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'NewGlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'ModifyOptionGroupMessage' => [ 'type' => 'structure', 'required' => [ 'OptionGroupName', ], 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionsToInclude' => [ 'shape' => 'OptionConfigurationList', ], 'OptionsToRemove' => [ 'shape' => 'OptionNamesList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'ModifyOptionGroupResult' => [ 'type' => 'structure', 'members' => [ 'OptionGroup' => [ 'shape' => 'OptionGroup', ], ], ], 'Option' => [ 'type' => 'structure', 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'OptionDescription' => [ 'shape' => 'String', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'OptionSettings' => [ 'shape' => 'OptionSettingConfigurationList', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupMembershipList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], ], ], 'OptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'OptionName', ], 'members' => [ 'OptionName' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'OptionVersion' => [ 'shape' => 'String', ], 'DBSecurityGroupMemberships' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupMemberships' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'OptionSettings' => [ 'shape' => 'OptionSettingsList', ], ], ], 'OptionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionConfiguration', 'locationName' => 'OptionConfiguration', ], ], 'OptionGroup' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'OptionGroupDescription' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'Options' => [ 'shape' => 'OptionsList', ], 'AllowsVpcAndNonVpcInstanceMemberships' => [ 'shape' => 'Boolean', ], 'VpcId' => [ 'shape' => 'String', ], 'OptionGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'OptionGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupMembership' => [ 'type' => 'structure', 'members' => [ 'OptionGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'OptionGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupMembership', 'locationName' => 'OptionGroupMembership', ], ], 'OptionGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroupOption' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'EngineName' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'MinimumRequiredMinorEngineVersion' => [ 'shape' => 'String', ], 'PortRequired' => [ 'shape' => 'Boolean', ], 'DefaultPort' => [ 'shape' => 'IntegerOptional', ], 'OptionsDependedOn' => [ 'shape' => 'OptionsDependedOn', ], 'OptionsConflictsWith' => [ 'shape' => 'OptionsConflictsWith', ], 'Persistent' => [ 'shape' => 'Boolean', ], 'Permanent' => [ 'shape' => 'Boolean', ], 'RequiresAutoMinorEngineVersionUpgrade' => [ 'shape' => 'Boolean', ], 'VpcOnly' => [ 'shape' => 'Boolean', ], 'SupportsOptionVersionDowngrade' => [ 'shape' => 'BooleanOptional', ], 'OptionGroupOptionSettings' => [ 'shape' => 'OptionGroupOptionSettingsList', ], 'OptionGroupOptionVersions' => [ 'shape' => 'OptionGroupOptionVersionsList', ], ], ], 'OptionGroupOptionSetting' => [ 'type' => 'structure', 'members' => [ 'SettingName' => [ 'shape' => 'String', ], 'SettingDescription' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersionPerAllowedValue' => [ 'shape' => 'MinimumEngineVersionPerAllowedValueList', ], ], ], 'OptionGroupOptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOptionSetting', 'locationName' => 'OptionGroupOptionSetting', ], ], 'OptionGroupOptionVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionVersion', 'locationName' => 'OptionVersion', ], ], 'OptionGroupOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroupOption', 'locationName' => 'OptionGroupOption', ], ], 'OptionGroupOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OptionGroupOptions' => [ 'shape' => 'OptionGroupOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'OptionGroupQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'OptionGroups' => [ 'type' => 'structure', 'members' => [ 'OptionGroupsList' => [ 'shape' => 'OptionGroupsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'OptionGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionGroup', 'locationName' => 'OptionGroup', ], ], 'OptionNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'OptionSetting' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], 'DefaultValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'IsCollection' => [ 'shape' => 'Boolean', ], ], ], 'OptionSettingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionSettingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionSetting', 'locationName' => 'OptionSetting', ], ], 'OptionVersion' => [ 'type' => 'structure', 'members' => [ 'Version' => [ 'shape' => 'String', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'OptionsConflictsWith' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionConflictName', ], ], 'OptionsDependedOn' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OptionName', ], ], 'OptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Option', 'locationName' => 'Option', ], ], 'OrderableDBInstanceOption' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'MultiAZCapable' => [ 'shape' => 'Boolean', ], 'ReadReplicaCapable' => [ 'shape' => 'Boolean', ], 'Vpc' => [ 'shape' => 'Boolean', ], 'SupportsStorageEncryption' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], 'SupportsIops' => [ 'shape' => 'Boolean', ], 'SupportsEnhancedMonitoring' => [ 'shape' => 'Boolean', ], 'SupportsIAMDatabaseAuthentication' => [ 'shape' => 'Boolean', ], 'SupportsPerformanceInsights' => [ 'shape' => 'Boolean', ], 'MinStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MaxStorageSize' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MaxIopsPerDbInstance' => [ 'shape' => 'IntegerOptional', ], 'MinIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'MaxIopsPerGib' => [ 'shape' => 'DoubleOptional', ], 'AvailableProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], ], 'wrapper' => true, ], 'OrderableDBInstanceOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderableDBInstanceOption', 'locationName' => 'OrderableDBInstanceOption', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OrderableDBInstanceOptions' => [ 'shape' => 'OrderableDBInstanceOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ApplyMethod' => [ 'shape' => 'ApplyMethod', ], 'SupportedEngineModes' => [ 'shape' => 'EngineModeList', ], ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PendingCloudwatchLogsExports' => [ 'type' => 'structure', 'members' => [ 'LogTypesToEnable' => [ 'shape' => 'LogTypeList', ], 'LogTypesToDisable' => [ 'shape' => 'LogTypeList', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'String', ], 'AutoAppliedAfterDate' => [ 'shape' => 'TStamp', ], 'ForcedApplyDate' => [ 'shape' => 'TStamp', ], 'OptInStatus' => [ 'shape' => 'String', ], 'CurrentApplyDate' => [ 'shape' => 'TStamp', ], 'Description' => [ 'shape' => 'String', ], ], ], 'PendingMaintenanceActionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', 'locationName' => 'PendingMaintenanceAction', ], ], 'PendingMaintenanceActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePendingMaintenanceActions', 'locationName' => 'ResourcePendingMaintenanceActions', ], ], 'PendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'PendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActions', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'DBInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], ], ], 'PointInTimeRestoreNotEnabledFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'PointInTimeRestoreNotEnabled', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ProcessorFeature' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'ProcessorFeatureList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessorFeature', 'locationName' => 'ProcessorFeature', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'PromoteReadReplicaMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], ], ], 'PromoteReadReplicaResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ProvisionedIopsNotAvailableInAZFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'required' => [ 'ReservedDBInstancesOfferingId', ], 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'IntegerOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstance' => [ 'shape' => 'ReservedDBInstance', ], ], ], 'Range' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'Integer', ], 'To' => [ 'shape' => 'Integer', ], 'Step' => [ 'shape' => 'IntegerOptional', ], ], ], 'RangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Range', 'locationName' => 'Range', ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBClusterIdentifier', ], ], 'ReadReplicaDBInstanceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaDBInstanceIdentifier', ], ], 'ReadReplicaIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaIdentifier', ], ], 'ReadersArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RebootDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'ForceFailover' => [ 'shape' => 'BooleanOptional', ], ], ], 'RebootDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', 'locationName' => 'RecurringCharge', ], ], 'RemoveFromGlobalClusterMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'String', ], 'DbClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveFromGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'RemoveRoleFromDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'RoleArn', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], ], ], 'RemoveRoleFromDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'RoleArn', 'FeatureName', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'RoleArn' => [ 'shape' => 'String', ], 'FeatureName' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ReservedDBInstance' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstanceId' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'DBInstanceCount' => [ 'shape' => 'Integer', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'State' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], 'ReservedDBInstanceArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'ReservedDBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceAlreadyExists', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstance', 'locationName' => 'ReservedDBInstance', ], ], 'ReservedDBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstances' => [ 'shape' => 'ReservedDBInstanceList', ], ], ], 'ReservedDBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReservedDBInstancesOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedDBInstancesOfferingId' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], 'wrapper' => true, ], 'ReservedDBInstancesOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedDBInstancesOffering', 'locationName' => 'ReservedDBInstancesOffering', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedDBInstancesOfferings' => [ 'shape' => 'ReservedDBInstancesOfferingList', ], ], ], 'ReservedDBInstancesOfferingNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedDBInstancesOfferingNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResetDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResetDBParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupName', ], 'members' => [ 'DBParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ResourceNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourcePendingMaintenanceActions' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'PendingMaintenanceActionDetails' => [ 'shape' => 'PendingMaintenanceActionDetails', ], ], 'wrapper' => true, ], 'RestoreDBClusterFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', 'MasterUsername', 'MasterUserPassword', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'CharacterSetName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBClusterFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SnapshotIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'EngineMode' => [ 'shape' => 'String', ], 'ScalingConfiguration' => [ 'shape' => 'ScalingConfiguration', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBClusterFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SourceDBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreType' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreToTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'BacktrackWindow' => [ 'shape' => 'LongOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBClusterToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBSnapshotIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceFromS3Message' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', 'SourceEngine', 'SourceEngineVersion', 'S3BucketName', 'S3IngestionRoleArn', ], 'members' => [ 'DBName' => [ 'shape' => 'String', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'DBSecurityGroups' => [ 'shape' => 'DBSecurityGroupNameList', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'MonitoringInterval' => [ 'shape' => 'IntegerOptional', ], 'MonitoringRoleArn' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'SourceEngine' => [ 'shape' => 'String', ], 'SourceEngineVersion' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], 'S3Prefix' => [ 'shape' => 'String', ], 'S3IngestionRoleArn' => [ 'shape' => 'String', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'PerformanceInsightsRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'RestoreDBInstanceFromS3Result' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'TargetDBInstanceIdentifier', ], 'members' => [ 'SourceDBInstanceIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], 'RestoreTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'PubliclyAccessible' => [ 'shape' => 'BooleanOptional', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'LicenseModel' => [ 'shape' => 'String', ], 'DBName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'OptionGroupName' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageType' => [ 'shape' => 'String', ], 'TdeCredentialArn' => [ 'shape' => 'String', ], 'TdeCredentialPassword' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Domain' => [ 'shape' => 'String', ], 'DomainIAMRoleName' => [ 'shape' => 'String', ], 'EnableIAMDatabaseAuthentication' => [ 'shape' => 'BooleanOptional', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'ProcessorFeatures' => [ 'shape' => 'ProcessorFeatureList', ], 'UseDefaultProcessorFeatures' => [ 'shape' => 'BooleanOptional', ], 'DBParameterGroupName' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'SourceDbiResourceId' => [ 'shape' => 'String', ], ], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RestoreWindow' => [ 'type' => 'structure', 'members' => [ 'EarliestTime' => [ 'shape' => 'TStamp', ], 'LatestTime' => [ 'shape' => 'TStamp', ], ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'DBSecurityGroupName', ], 'members' => [ 'DBSecurityGroupName' => [ 'shape' => 'String', ], 'CIDRIP' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupId' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'RevokeDBSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'DBSecurityGroup' => [ 'shape' => 'DBSecurityGroup', ], ], ], 'SNSInvalidTopicFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSInvalidTopic', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSNoAuthorizationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSNoAuthorization', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSTopicArnNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSTopicArnNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], ], ], 'ScalingConfigurationInfo' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'IntegerOptional', ], 'MaxCapacity' => [ 'shape' => 'IntegerOptional', ], 'AutoPause' => [ 'shape' => 'BooleanOptional', ], 'SecondsUntilAutoPause' => [ 'shape' => 'IntegerOptional', ], ], ], 'SharedSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SharedSnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SourceId', ], ], 'SourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SourceRegion' => [ 'type' => 'structure', 'members' => [ 'RegionName' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'SourceRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceRegion', 'locationName' => 'SourceRegion', ], ], 'SourceRegionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'SourceRegions' => [ 'shape' => 'SourceRegionList', ], ], ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'db-instance', 'db-parameter-group', 'db-security-group', 'db-snapshot', 'db-cluster', 'db-cluster-snapshot', ], ], 'StartDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StartDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StopDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StopDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'StorageQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetStatus' => [ 'shape' => 'String', ], ], ], 'SubnetAlreadyInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetAlreadyInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubscriptionAlreadyExistFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionAlreadyExist', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionCategoryNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionCategoryNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SupportedCharacterSetsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CharacterSet', 'locationName' => 'CharacterSet', ], ], 'SupportedTimezonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Timezone', 'locationName' => 'Timezone', ], ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'Timezone' => [ 'type' => 'structure', 'members' => [ 'TimezoneName' => [ 'shape' => 'String', ], ], ], 'UpgradeTarget' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'AutoUpgrade' => [ 'shape' => 'Boolean', ], 'IsMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], ], ], 'ValidDBInstanceModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'Storage' => [ 'shape' => 'ValidStorageOptionsList', ], 'ValidProcessorFeatures' => [ 'shape' => 'AvailableProcessorFeatureList', ], ], 'wrapper' => true, ], 'ValidStorageOptions' => [ 'type' => 'structure', 'members' => [ 'StorageType' => [ 'shape' => 'String', ], 'StorageSize' => [ 'shape' => 'RangeList', ], 'ProvisionedIops' => [ 'shape' => 'RangeList', ], 'IopsToStorageRatio' => [ 'shape' => 'DoubleRangeList', ], ], ], 'ValidStorageOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidStorageOptions', 'locationName' => 'ValidStorageOptions', ], ], 'ValidUpgradeTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeTarget', 'locationName' => 'UpgradeTarget', ], ], 'VpcSecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'VpcSecurityGroupId', ], ], 'VpcSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'VpcSecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'VpcSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcSecurityGroupMembership', 'locationName' => 'VpcSecurityGroupMembership', ], ], ],]; diff --git a/src/data/rds/2014-10-31/docs-2.json b/src/data/rds/2014-10-31/docs-2.json index 18175362b3..935447d721 100644 --- a/src/data/rds/2014-10-31/docs-2.json +++ b/src/data/rds/2014-10-31/docs-2.json @@ -1,36 +1,36 @@ { "version": "2.0", - "service": "Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

Amazon RDS User Guide

", + "service": "Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

Amazon RDS User Guide

", "operations": { - "AddRoleToDBCluster": "

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

", + "AddRoleToDBCluster": "

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "AddRoleToDBInstance": "

Associates an AWS Identity and Access Management (IAM) role with a DB instance.

", "AddSourceIdentifierToSubscription": "

Adds a source identifier to an existing RDS event notification subscription.

", - "AddTagsToResource": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

", + "AddTagsToResource": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

", "ApplyPendingMaintenanceAction": "

Applies a pending maintenance action to a resource (for example, to a DB instance).

", "AuthorizeDBSecurityGroupIngress": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

", - "BacktrackDBCluster": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

", - "CopyDBClusterParameterGroup": "

Copies the specified DB cluster parameter group.

", - "CopyDBClusterSnapshot": "

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "BacktrackDBCluster": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "CopyDBClusterParameterGroup": "

Copies the specified DB cluster parameter group.

This action only applies to Aurora DB clusters.

", + "CopyDBClusterSnapshot": "

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "CopyDBParameterGroup": "

Copies the specified DB parameter group.

", - "CopyDBSnapshot": "

Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

", + "CopyDBSnapshot": "

Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

", "CopyOptionGroup": "

Copies the specified option group.

", - "CreateDBCluster": "

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "CreateDBClusterEndpoint": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

", - "CreateDBClusterParameterGroup": "

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "CreateDBClusterSnapshot": "

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "CreateDBCluster": "

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "CreateDBClusterEndpoint": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

", + "CreateDBClusterParameterGroup": "

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "CreateDBClusterSnapshot": "

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "CreateDBInstance": "

Creates a new DB instance.

", - "CreateDBInstanceReadReplica": "

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.

Your source DB instance must have backup retention enabled.

", + "CreateDBInstanceReadReplica": "

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.

Your source DB instance must have backup retention enabled.

", "CreateDBParameterGroup": "

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

", "CreateDBSecurityGroup": "

Creates a new DB security group. DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

", "CreateDBSnapshot": "

Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

", "CreateDBSubnetGroup": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

", "CreateEventSubscription": "

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.

", - "CreateGlobalCluster": "

Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

", + "CreateGlobalCluster": "

Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

This action only applies to Aurora DB clusters.

", "CreateOptionGroup": "

Creates a new option group. You can create up to 20 option groups.

", - "DeleteDBCluster": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "DeleteDBClusterEndpoint": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

", - "DeleteDBClusterParameterGroup": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "DeleteDBClusterSnapshot": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "DeleteDBCluster": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "DeleteDBClusterEndpoint": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

", + "DeleteDBClusterParameterGroup": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "DeleteDBClusterSnapshot": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "DeleteDBInstance": "

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

  • The DB cluster is a Read Replica of another Amazon Aurora DB cluster.

  • The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

", "DeleteDBInstanceAutomatedBackup": "

Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.

", "DeleteDBParameterGroup": "

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

", @@ -38,17 +38,17 @@ "DeleteDBSnapshot": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB snapshot must be in the available state to be deleted.

", "DeleteDBSubnetGroup": "

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

", "DeleteEventSubscription": "

Deletes an RDS event notification subscription.

", - "DeleteGlobalCluster": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

", + "DeleteGlobalCluster": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

This action only applies to Aurora DB clusters.

", "DeleteOptionGroup": "

Deletes an existing option group.

", "DescribeAccountAttributes": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command doesn't take any parameters.

", "DescribeCertificates": "

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

", - "DescribeDBClusterBacktracks": "

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "DescribeDBClusterEndpoints": "

Returns information about endpoints for an Amazon Aurora DB cluster.

", - "DescribeDBClusterParameterGroups": "

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "DescribeDBClusterParameters": "

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "DescribeDBClusterSnapshotAttributes": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

", - "DescribeDBClusterSnapshots": "

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "DescribeDBClusters": "

Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "DescribeDBClusterBacktracks": "

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "DescribeDBClusterEndpoints": "

Returns information about endpoints for an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

", + "DescribeDBClusterParameterGroups": "

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "DescribeDBClusterParameters": "

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "DescribeDBClusterSnapshotAttributes": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

This action only applies to Aurora DB clusters.

", + "DescribeDBClusterSnapshots": "

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "DescribeDBClusters": "

Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "DescribeDBEngineVersions": "

Returns a list of the available DB engines.

", "DescribeDBInstanceAutomatedBackups": "

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

", "DescribeDBInstances": "

Returns information about provisioned RDS instances. This API supports pagination.

", @@ -59,12 +59,12 @@ "DescribeDBSnapshotAttributes": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

", "DescribeDBSnapshots": "

Returns information about DB snapshots. This API action supports pagination.

", "DescribeDBSubnetGroups": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

", - "DescribeEngineDefaultClusterParameters": "

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "DescribeEngineDefaultClusterParameters": "

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", "DescribeEngineDefaultParameters": "

Returns the default engine and system parameter information for the specified database engine.

", - "DescribeEventCategories": "

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

", + "DescribeEventCategories": "

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

", "DescribeEventSubscriptions": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

", "DescribeEvents": "

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

", - "DescribeGlobalClusters": "

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "DescribeGlobalClusters": "

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "DescribeOptionGroupOptions": "

Describes all available options.

", "DescribeOptionGroups": "

Describes the available option groups.

", "DescribeOrderableDBInstanceOptions": "

Returns a list of orderable DB instance options for the specified engine.

", @@ -74,43 +74,43 @@ "DescribeSourceRegions": "

Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

", "DescribeValidDBInstanceModifications": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

", "DownloadDBLogFilePortion": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

", - "FailoverDBCluster": "

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "ListTagsForResource": "

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", - "ModifyCurrentDBClusterCapacity": "

Set the capacity of an Aurora Serverless DB cluster to a specific value.

Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

", - "ModifyDBCluster": "

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "ModifyDBClusterEndpoint": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

", - "ModifyDBClusterParameterGroup": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

", - "ModifyDBClusterSnapshotAttribute": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

", + "FailoverDBCluster": "

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "ListTagsForResource": "

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", + "ModifyCurrentDBClusterCapacity": "

Set the capacity of an Aurora Serverless DB cluster to a specific value.

Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "ModifyDBCluster": "

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "ModifyDBClusterEndpoint": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

", + "ModifyDBClusterParameterGroup": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

This action only applies to Aurora DB clusters.

", + "ModifyDBClusterSnapshotAttribute": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

This action only applies to Aurora DB clusters.

", "ModifyDBInstance": "

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

", "ModifyDBParameterGroup": "

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

", "ModifyDBSnapshot": "

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

", "ModifyDBSnapshotAttribute": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.

", "ModifyDBSubnetGroup": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

", - "ModifyEventSubscription": "

Modifies an existing RDS event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

", - "ModifyGlobalCluster": "

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "ModifyEventSubscription": "

Modifies an existing RDS event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

", + "ModifyGlobalCluster": "

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "ModifyOptionGroup": "

Modifies an existing option group.

", "PromoteReadReplica": "

Promotes a Read Replica DB instance to a standalone DB instance.

  • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion.

  • This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.

", - "PromoteReadReplicaDBCluster": "

Promotes a Read Replica DB cluster to a standalone DB cluster.

", + "PromoteReadReplicaDBCluster": "

Promotes a Read Replica DB cluster to a standalone DB cluster.

This action only applies to Aurora DB clusters.

", "PurchaseReservedDBInstancesOffering": "

Purchases a reserved DB instance offering.

", - "RebootDBInstance": "

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

", - "RemoveFromGlobalCluster": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

", - "RemoveRoleFromDBCluster": "

Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

", + "RebootDBInstance": "

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

", + "RemoveFromGlobalCluster": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

This action only applies to Aurora DB clusters.

", + "RemoveRoleFromDBCluster": "

Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "RemoveRoleFromDBInstance": "

Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

", "RemoveSourceIdentifierFromSubscription": "

Removes a source identifier from an existing RDS event notification subscription.

", - "RemoveTagsFromResource": "

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", - "ResetDBClusterParameterGroup": "

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "RemoveTagsFromResource": "

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", + "ResetDBClusterParameterGroup": "

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "ResetDBParameterGroup": "

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

", - "RestoreDBClusterFromS3": "

Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

", - "RestoreDBClusterFromSnapshot": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", - "RestoreDBClusterToPointInTime": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

", + "RestoreDBClusterFromS3": "

Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "RestoreDBClusterFromSnapshot": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "RestoreDBClusterToPointInTime": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "RestoreDBInstanceFromDBSnapshot": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

", - "RestoreDBInstanceFromS3": "

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

", + "RestoreDBInstanceFromS3": "

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

", "RestoreDBInstanceToPointInTime": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

", "RevokeDBSecurityGroupIngress": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

", - "StartDBCluster": "

Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

", - "StartDBInstance": "

Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

", - "StopDBCluster": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

", - "StopDBInstance": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

" + "StartDBCluster": "

Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "StartDBInstance": "

Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

", + "StopDBCluster": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", + "StopDBInstance": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

" }, "shapes": { "AccountAttributesMessage": { @@ -223,7 +223,7 @@ "AvailabilityZones": { "base": null, "refs": { - "CreateDBClusterMessage$AvailabilityZones": "

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

", + "CreateDBClusterMessage$AvailabilityZones": "

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

", "DBCluster$AvailabilityZones": "

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

", "DBClusterSnapshot$AvailabilityZones": "

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

", "RestoreDBClusterFromS3Message$AvailabilityZones": "

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

", @@ -231,7 +231,7 @@ } }, "AvailableProcessorFeature": { - "base": "

Contains the available processor feature information for the DB instance class of a DB instance.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

", + "base": "

Contains the available processor feature information for the DB instance class of a DB instance.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

", "refs": { "AvailableProcessorFeatureList$member": null } @@ -249,7 +249,7 @@ } }, "BackupPolicyNotFoundFault": { - "base": "

The backup policy was not found.

", + "base": null, "refs": { } }, @@ -260,7 +260,8 @@ "DBCluster$StorageEncrypted": "

Specifies whether the DB cluster is encrypted.

", "DBCluster$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

", "DBCluster$DeletionProtection": "

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

", - "DBCluster$HttpEndpointEnabled": "

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "DBCluster$HttpEndpointEnabled": "

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "DBCluster$CopyTagsToSnapshot": "

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

", "DBClusterMember$IsClusterWriter": "

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

", "DBClusterSnapshot$StorageEncrypted": "

Specifies whether the DB cluster snapshot is encrypted.

", "DBClusterSnapshot$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

", @@ -270,9 +271,9 @@ "DBInstance$AutoMinorVersionUpgrade": "

Indicates that minor version patches are applied automatically.

", "DBInstance$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

", "DBInstance$StorageEncrypted": "

Specifies whether the DB instance is encrypted.

", - "DBInstance$CopyTagsToSnapshot": "

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

", + "DBInstance$CopyTagsToSnapshot": "

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

", "DBInstance$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

", - "DBInstance$DeletionProtection": "

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.

", + "DBInstance$DeletionProtection": "

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.

", "DBInstanceAutomatedBackup$Encrypted": "

Specifies whether the automated backup is encrypted.

", "DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

", "DBInstanceStatusInfo$Normal": "

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

", @@ -289,7 +290,7 @@ "EventSubscription$Enabled": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

", "GlobalClusterMember$IsWriter": "

Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

", "ModifyDBClusterMessage$ApplyImmediately": "

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

", - "ModifyDBInstanceMessage$ApplyImmediately": "

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes are applied.

Default: false

", + "ModifyDBInstanceMessage$ApplyImmediately": "

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes are applied.

Default: false

", "ModifyDBInstanceMessage$AllowMajorVersionUpgrade": "

Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

", "ModifyOptionGroupMessage$ApplyImmediately": "

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

", "Option$Persistent": "

Indicate if this option is persistent.

", @@ -334,22 +335,23 @@ "CreateDBClusterMessage$StorageEncrypted": "

Specifies whether the DB cluster is encrypted.

", "CreateDBClusterMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", "CreateDBClusterMessage$DeletionProtection": "

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "CreateDBClusterMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.

", "CreateDBInstanceMessage$MultiAZ": "

A value that specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

", "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

", "CreateDBInstanceMessage$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies:

  • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

", "CreateDBInstanceMessage$StorageEncrypted": "

Specifies whether the DB instance is encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

Default: false

", - "CreateDBInstanceMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

", + "CreateDBInstanceMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see CreateDBCluster.

", "CreateDBInstanceMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

", - "CreateDBInstanceMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", - "CreateDBInstanceMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "CreateDBInstanceMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", + "CreateDBInstanceMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", "CreateDBInstanceReadReplicaMessage$MultiAZ": "

Specifies whether the Read Replica is in a Multi-AZ deployment.

You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

", "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "

Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

", "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", "CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot": "

True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.

", "CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora MySQL 5.6 or higher

Default: false

", - "CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the read replica, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

", + "CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the read replica, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

", "CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", - "CreateDBInstanceReadReplicaMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "CreateDBInstanceReadReplicaMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", "CreateEventSubscriptionMessage$Enabled": "

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

", "CreateGlobalClusterMessage$DeletionProtection": "

The deletion protection setting for the new global database. The global database can't be deleted when this value is set to true.

", "CreateGlobalClusterMessage$StorageEncrypted": "

The storage encryption setting for the new global database cluster.

", @@ -364,15 +366,16 @@ "GlobalCluster$DeletionProtection": "

The deletion protection setting for the new global database cluster.

", "ModifyDBClusterMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", "ModifyDBClusterMessage$DeletionProtection": "

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

", - "ModifyDBClusterMessage$EnableHttpEndpoint": "

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "ModifyDBClusterMessage$EnableHttpEndpoint": "

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "ModifyDBClusterMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.

", "ModifyDBInstanceMessage$MultiAZ": "

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

", "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

", - "ModifyDBInstanceMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

", + "ModifyDBInstanceMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.

", "ModifyDBInstanceMessage$PubliclyAccessible": "

Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Default: false

", "ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

", - "ModifyDBInstanceMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", + "ModifyDBInstanceMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", "ModifyDBInstanceMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", - "ModifyDBInstanceMessage$DeletionProtection": "

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.

", + "ModifyDBInstanceMessage$DeletionProtection": "

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.

", "ModifyEventSubscriptionMessage$Enabled": "

A Boolean value; set to true to activate the subscription.

", "ModifyGlobalClusterMessage$DeletionProtection": "

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when this value is set to true.

", "OptionGroupOption$SupportsOptionVersionDowngrade": "

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

", @@ -381,33 +384,36 @@ "RestoreDBClusterFromS3Message$StorageEncrypted": "

Specifies whether the restored DB cluster is encrypted.

", "RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", "RestoreDBClusterFromS3Message$DeletionProtection": "

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "RestoreDBClusterFromS3Message$CopyTagsToSnapshot": "

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

", "RestoreDBClusterFromSnapshotMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", "RestoreDBClusterFromSnapshotMessage$DeletionProtection": "

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

", "RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", "RestoreDBClusterToPointInTimeMessage$DeletionProtection": "

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

", "RestoreDBInstanceFromDBSnapshotMessage$MultiAZ": "

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

", "RestoreDBInstanceFromDBSnapshotMessage$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

", - "RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.

", + "RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.

", "RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

", "RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", - "RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", "RestoreDBInstanceFromS3Message$MultiAZ": "

Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter.

", "RestoreDBInstanceFromS3Message$AutoMinorVersionUpgrade": "

True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.

Default: true

", "RestoreDBInstanceFromS3Message$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", "RestoreDBInstanceFromS3Message$StorageEncrypted": "

Specifies whether the new DB instance is encrypted or not.

", - "RestoreDBInstanceFromS3Message$CopyTagsToSnapshot": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.

Default: false.

", + "RestoreDBInstanceFromS3Message$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false.

Default: false.

", "RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", - "RestoreDBInstanceFromS3Message$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", + "RestoreDBInstanceFromS3Message$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", "RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", - "RestoreDBInstanceFromS3Message$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "RestoreDBInstanceFromS3Message$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

", "RestoreDBInstanceToPointInTimeMessage$PubliclyAccessible": "

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

", - "RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.

", + "RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.

", "RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

", "RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", - "RestoreDBInstanceToPointInTimeMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "RestoreDBInstanceToPointInTimeMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", "ScalingConfiguration$AutoPause": "

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

", "ScalingConfigurationInfo$AutoPause": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

" } @@ -442,7 +448,7 @@ } }, "CloudwatchLogsExportConfiguration": { - "base": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

", + "base": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

", "refs": { "ModifyDBClusterMessage$CloudwatchLogsExportConfiguration": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

", "ModifyDBInstanceMessage$CloudwatchLogsExportConfiguration": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

" @@ -1616,12 +1622,12 @@ "EventCategoriesList": { "base": null, "refs": { - "CreateEventSubscriptionMessage$EventCategories": "

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

", + "CreateEventSubscriptionMessage$EventCategories": "

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

", "DescribeEventsMessage$EventCategories": "

A list of event categories that trigger notifications for a event notification subscription.

", "Event$EventCategories": "

Specifies the category for the event.

", "EventCategoriesMap$EventCategories": "

The event categories for the specified source type

", "EventSubscription$EventCategoriesList": "

A list of event categories for the RDS event notification subscription.

", - "ModifyEventSubscriptionMessage$EventCategories": "

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + "ModifyEventSubscriptionMessage$EventCategories": "

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" } }, "EventCategoriesMap": { @@ -1850,12 +1856,12 @@ "refs": { "CreateDBClusterMessage$BackupRetentionPeriod": "

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

", "CreateDBClusterMessage$Port": "

The port number on which the instances in the DB cluster accept connections.

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

", - "CreateDBInstanceMessage$AllocatedStorage": "

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 16384.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 16384.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 16384.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

", + "CreateDBInstanceMessage$AllocatedStorage": "

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

", "CreateDBInstanceMessage$BackupRetentionPeriod": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Can't be set to 0 if the DB instance is a source to Read Replicas

", "CreateDBInstanceMessage$Port": "

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

Type: Integer

", - "CreateDBInstanceMessage$Iops": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.

", + "CreateDBInstanceMessage$Iops": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.

", "CreateDBInstanceMessage$MonitoringInterval": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

", - "CreateDBInstanceMessage$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

", + "CreateDBInstanceMessage$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

", "CreateDBInstanceMessage$PerformanceInsightsRetentionPeriod": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

", "CreateDBInstanceReadReplicaMessage$Port": "

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

", "CreateDBInstanceReadReplicaMessage$Iops": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

", @@ -1864,14 +1870,14 @@ "DBCluster$AllocatedStorage": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

", "DBCluster$BackupRetentionPeriod": "

Specifies the number of days for which automatic DB snapshots are retained.

", "DBCluster$Port": "

Specifies the port that the database engine is listening on.

", - "DBCluster$Capacity": "

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "DBCluster$Capacity": "

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", "DBClusterCapacityInfo$PendingCapacity": "

A value that specifies the capacity that the DB cluster scales to next.

", "DBClusterCapacityInfo$CurrentCapacity": "

The current capacity of the DB cluster.

", "DBClusterCapacityInfo$SecondsBeforeTimeout": "

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

", - "DBClusterMember$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

", + "DBClusterMember$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

", "DBInstance$Iops": "

Specifies the Provisioned IOPS (I/O operations per second) value.

", "DBInstance$MonitoringInterval": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

", - "DBInstance$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

", + "DBInstance$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

", "DBInstance$PerformanceInsightsRetentionPeriod": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

", "DBInstanceAutomatedBackup$Iops": "

The IOPS (I/O operations per second) value for the automated backup.

", "DBSnapshot$Iops": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

", @@ -1913,7 +1919,7 @@ "ModifyDBInstanceMessage$Iops": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

", "ModifyDBInstanceMessage$MonitoringInterval": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

", "ModifyDBInstanceMessage$DBPortNumber": "

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid Values: 1150-65535

MariaDB

Default: 3306

Valid Values: 1150-65535

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

", - "ModifyDBInstanceMessage$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

", + "ModifyDBInstanceMessage$PromotionTier": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

", "ModifyDBInstanceMessage$PerformanceInsightsRetentionPeriod": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

", "Option$Port": "

If required, the port configured for this option to use.

", "OptionConfiguration$Port": "

The optional port for the option.

", @@ -1934,11 +1940,11 @@ "RestoreDBClusterFromSnapshotMessage$Port": "

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

", "RestoreDBClusterToPointInTimeMessage$Port": "

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

", "RestoreDBInstanceFromDBSnapshotMessage$Port": "

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

", - "RestoreDBInstanceFromDBSnapshotMessage$Iops": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

", + "RestoreDBInstanceFromDBSnapshotMessage$Iops": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

", "RestoreDBInstanceFromS3Message$AllocatedStorage": "

The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

", "RestoreDBInstanceFromS3Message$BackupRetentionPeriod": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

", "RestoreDBInstanceFromS3Message$Port": "

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

", - "RestoreDBInstanceFromS3Message$Iops": "

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

", + "RestoreDBInstanceFromS3Message$Iops": "

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

", "RestoreDBInstanceFromS3Message$MonitoringInterval": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: 0

", "RestoreDBInstanceFromS3Message$PerformanceInsightsRetentionPeriod": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

", "RestoreDBInstanceToPointInTimeMessage$Port": "

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

", @@ -2067,20 +2073,20 @@ "refs": { "CloudwatchLogsExportConfiguration$EnableLogTypes": "

The list of log types to enable.

", "CloudwatchLogsExportConfiguration$DisableLogTypes": "

The list of log types to disable.

", - "CreateDBClusterMessage$EnableCloudwatchLogsExports": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", - "CreateDBInstanceMessage$EnableCloudwatchLogsExports": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.

", - "CreateDBInstanceReadReplicaMessage$EnableCloudwatchLogsExports": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

", - "DBCluster$EnabledCloudwatchLogsExports": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

", + "CreateDBClusterMessage$EnableCloudwatchLogsExports": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", + "CreateDBInstanceMessage$EnableCloudwatchLogsExports": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.

", + "CreateDBInstanceReadReplicaMessage$EnableCloudwatchLogsExports": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

", + "DBCluster$EnabledCloudwatchLogsExports": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

", "DBEngineVersion$ExportableLogTypes": "

The types of logs that the database engine has available for export to CloudWatch Logs.

", - "DBInstance$EnabledCloudwatchLogsExports": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

", + "DBInstance$EnabledCloudwatchLogsExports": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

", "PendingCloudwatchLogsExports$LogTypesToEnable": "

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

", "PendingCloudwatchLogsExports$LogTypesToDisable": "

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

", - "RestoreDBClusterFromS3Message$EnableCloudwatchLogsExports": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", - "RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", - "RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", - "RestoreDBInstanceFromDBSnapshotMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", - "RestoreDBInstanceFromS3Message$EnableCloudwatchLogsExports": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

", - "RestoreDBInstanceToPointInTimeMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

" + "RestoreDBClusterFromS3Message$EnableCloudwatchLogsExports": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", + "RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", + "RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", + "RestoreDBInstanceFromDBSnapshotMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

", + "RestoreDBInstanceFromS3Message$EnableCloudwatchLogsExports": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

", + "RestoreDBInstanceToPointInTimeMessage$EnableCloudwatchLogsExports": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

" } }, "Long": { @@ -2453,7 +2459,7 @@ } }, "ProcessorFeature": { - "base": "

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

", + "base": "

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

", "refs": { "ProcessorFeatureList$member": null } @@ -2771,7 +2777,7 @@ } }, "ScalingConfiguration": { - "base": "

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "base": "

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", "refs": { "CreateDBClusterMessage$ScalingConfiguration": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

", "ModifyDBClusterMessage$ScalingConfiguration": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

", @@ -2779,7 +2785,7 @@ } }, "ScalingConfigurationInfo": { - "base": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "base": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", "refs": { "DBCluster$ScalingConfigurationInfo": null } @@ -2891,8 +2897,8 @@ "AddRoleToDBInstanceMessage$FeatureName": "

The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.

", "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "

The name of the RDS event notification subscription you want to add a source identifier to.

", "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "

The identifier of the event source to be added.

Constraints:

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

", - "AddTagsToResourceMessage$ResourceName": "

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

", - "ApplyPendingMaintenanceActionMessage$ResourceIdentifier": "

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

", + "AddTagsToResourceMessage$ResourceName": "

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

", + "ApplyPendingMaintenanceActionMessage$ResourceIdentifier": "

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

", "ApplyPendingMaintenanceActionMessage$ApplyAction": "

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

", "ApplyPendingMaintenanceActionMessage$OptInType": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

", "AttributeValueList$member": null, @@ -2914,22 +2920,22 @@ "CertificateMessage$Marker": "

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

", "CharacterSet$CharacterSetName": "

The name of the character set.

", "CharacterSet$CharacterSetDescription": "

The description of the character set.

", - "CopyDBClusterParameterGroupMessage$SourceDBClusterParameterGroupIdentifier": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

Constraints:

  • Must specify a valid DB cluster parameter group.

  • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

  • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

", + "CopyDBClusterParameterGroupMessage$SourceDBClusterParameterGroupIdentifier": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

Constraints:

  • Must specify a valid DB cluster parameter group.

  • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

  • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

", "CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupIdentifier": "

The identifier for the copied DB cluster parameter group.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster-param-group1

", "CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupDescription": "

A description for the copied DB cluster parameter group.

", - "CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier": "

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.

  • If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

", + "CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier": "

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.

  • If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

", "CopyDBClusterSnapshotMessage$TargetDBClusterSnapshotIdentifier": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

", "CopyDBClusterSnapshotMessage$KmsKeyId": "

The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

", - "CopyDBClusterSnapshotMessage$PreSignedUrl": "

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.

The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", - "CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier": "

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid DB parameter group.

  • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

", + "CopyDBClusterSnapshotMessage$PreSignedUrl": "

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.

The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", + "CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier": "

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid DB parameter group.

  • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

", "CopyDBParameterGroupMessage$TargetDBParameterGroupIdentifier": "

The identifier for the copied DB parameter group.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

", "CopyDBParameterGroupMessage$TargetDBParameterGroupDescription": "

A description for the copied DB parameter group.

", "CopyDBSnapshotMessage$SourceDBSnapshotIdentifier": "

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

", "CopyDBSnapshotMessage$TargetDBSnapshotIdentifier": "

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

", "CopyDBSnapshotMessage$KmsKeyId": "

The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

", - "CopyDBSnapshotMessage$PreSignedUrl": "

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", - "CopyDBSnapshotMessage$OptionGroupName": "

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

", - "CopyOptionGroupMessage$SourceOptionGroupIdentifier": "

The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid option group.

  • If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

  • If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

", + "CopyDBSnapshotMessage$PreSignedUrl": "

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", + "CopyDBSnapshotMessage$OptionGroupName": "

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

", + "CopyOptionGroupMessage$SourceOptionGroupIdentifier": "

The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid option group.

  • If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

  • If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

", "CopyOptionGroupMessage$TargetOptionGroupIdentifier": "

The identifier for the copied option group.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-option-group

", "CopyOptionGroupMessage$TargetOptionGroupDescription": "

The description for the copied option group.

", "CreateDBClusterEndpointMessage$DBClusterIdentifier": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

", @@ -2945,11 +2951,11 @@ "CreateDBClusterMessage$MasterUsername": "

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

", "CreateDBClusterMessage$MasterUserPassword": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", "CreateDBClusterMessage$OptionGroupName": "

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

", - "CreateDBClusterMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", - "CreateDBClusterMessage$PreferredMaintenanceWindow": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", + "CreateDBClusterMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", + "CreateDBClusterMessage$PreferredMaintenanceWindow": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", "CreateDBClusterMessage$ReplicationSourceIdentifier": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

", "CreateDBClusterMessage$KmsKeyId": "

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS will use your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

", - "CreateDBClusterMessage$PreSignedUrl": "

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", + "CreateDBClusterMessage$PreSignedUrl": "

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", "CreateDBClusterMessage$EngineMode": "

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.

", "CreateDBClusterMessage$GlobalClusterIdentifier": "

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

", "CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

", @@ -2959,16 +2965,16 @@ "CreateDBClusterSnapshotMessage$DBClusterIdentifier": "

The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster1

", "CreateDBInstanceMessage$DBName": "

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, the default \"postgres\" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

", "CreateDBInstanceMessage$DBInstanceIdentifier": "

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

", - "CreateDBInstanceMessage$DBInstanceClass": "

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

", + "CreateDBInstanceMessage$DBInstanceClass": "

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

", "CreateDBInstanceMessage$Engine": "

The name of the database engine to be used for this instance.

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

", "CreateDBInstanceMessage$MasterUsername": "

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

  • Can't be a reserved word for the chosen database engine.

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

  • Can't be a reserved word for the chosen database engine.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

", "CreateDBInstanceMessage$MasterUserPassword": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

", - "CreateDBInstanceMessage$AvailabilityZone": "

The EC2 Availability Zone that the DB instance is created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

", + "CreateDBInstanceMessage$AvailabilityZone": "

The EC2 Availability Zone that the DB instance is created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

", "CreateDBInstanceMessage$DBSubnetGroupName": "

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

", - "CreateDBInstanceMessage$PreferredMaintenanceWindow": "

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

Format: ddd:hh24:mi-ddd:hh24:mi

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.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", + "CreateDBInstanceMessage$PreferredMaintenanceWindow": "

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

Format: ddd:hh24:mi-ddd:hh24:mi

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.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", "CreateDBInstanceMessage$DBParameterGroupName": "

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

", - "CreateDBInstanceMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", - "CreateDBInstanceMessage$EngineVersion": "

The version number of the database engine to use.

For a list of valid engine versions, call DescribeDBEngineVersions.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

", + "CreateDBInstanceMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", + "CreateDBInstanceMessage$EngineVersion": "

The version number of the database engine to use.

For a list of valid engine versions, call DescribeDBEngineVersions.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

", "CreateDBInstanceMessage$LicenseModel": "

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

", "CreateDBInstanceMessage$OptionGroupName": "

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", "CreateDBInstanceMessage$CharacterSetName": "

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

", @@ -2978,20 +2984,20 @@ "CreateDBInstanceMessage$TdeCredentialPassword": "

The password for the given ARN from the key store in order to access the device.

", "CreateDBInstanceMessage$KmsKeyId": "

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

", "CreateDBInstanceMessage$Domain": "

Specify the Active Directory Domain to create the instance in.

", - "CreateDBInstanceMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", + "CreateDBInstanceMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "CreateDBInstanceMessage$DomainIAMRoleName": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

", - "CreateDBInstanceMessage$Timezone": "

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

", + "CreateDBInstanceMessage$Timezone": "

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

", "CreateDBInstanceMessage$PerformanceInsightsKMSKeyId": "

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

", "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "

The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

", - "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.

  • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.

  • Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.

  • If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", - "CreateDBInstanceReadReplicaMessage$DBInstanceClass": "

The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

", + "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.

  • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.

  • Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.

  • If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", + "CreateDBInstanceReadReplicaMessage$DBInstanceClass": "

The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

", "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "

The Amazon EC2 Availability Zone that the Read Replica is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

", "CreateDBInstanceReadReplicaMessage$OptionGroupName": "

The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.

", "CreateDBInstanceReadReplicaMessage$DBSubnetGroupName": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

  • If supplied, must match the name of an existing DBSubnetGroup.

  • The specified DB subnet group must be in the same AWS Region in which the operation is running.

  • All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

    • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

", "CreateDBInstanceReadReplicaMessage$StorageType": "

Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

", - "CreateDBInstanceReadReplicaMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", + "CreateDBInstanceReadReplicaMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "CreateDBInstanceReadReplicaMessage$KmsKeyId": "

The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

You can't create an encrypted Read Replica from an unencrypted DB instance.

", - "CreateDBInstanceReadReplicaMessage$PreSignedUrl": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", + "CreateDBInstanceReadReplicaMessage$PreSignedUrl": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", "CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId": "

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

", "CreateDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

", "CreateDBParameterGroupMessage$DBParameterGroupFamily": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

To list all of the available parameter group families, use the following command:

aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"

The output contains duplicates.

", @@ -3116,7 +3122,7 @@ "DBInstanceAutomatedBackup$Region": "

The AWS Region associated with the automated backup.

", "DBInstanceAutomatedBackup$DBInstanceIdentifier": "

The customer id of the instance that is/was associated with the automated backup.

", "DBInstanceAutomatedBackup$Status": "

Provides a list of status information for an automated backup:

  • active - automated backups for current instances

  • retained - automated backups for deleted instances

  • creating - automated backups that are waiting for the first automated snapshot to be available.

", - "DBInstanceAutomatedBackup$AvailabilityZone": "

The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

", + "DBInstanceAutomatedBackup$AvailabilityZone": "

The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

", "DBInstanceAutomatedBackup$VpcId": "

Provides the VPC ID associated with the DB instance

", "DBInstanceAutomatedBackup$MasterUsername": "

The license model of an automated backup.

", "DBInstanceAutomatedBackup$Engine": "

The name of the database engine for this automated backup.

", @@ -3240,7 +3246,7 @@ "DescribeDBSnapshotAttributesMessage$DBSnapshotIdentifier": "

The identifier for the DB snapshot to describe the attributes for.

", "DescribeDBSnapshotsMessage$DBInstanceIdentifier": "

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

", "DescribeDBSnapshotsMessage$DBSnapshotIdentifier": "

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

  • If supplied, must match the identifier of an existing DBSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

", - "DescribeDBSnapshotsMessage$SnapshotType": "

The type of snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public - Return all DB snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

", + "DescribeDBSnapshotsMessage$SnapshotType": "

The type of snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public - Return all DB snapshots that have been marked as public.

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

", "DescribeDBSnapshotsMessage$Marker": "

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

", "DescribeDBSnapshotsMessage$DbiResourceId": "

A specific DB resource ID to describe.

", "DescribeDBSubnetGroupsMessage$DBSubnetGroupName": "

The name of the DB subnet group to return details for.

", @@ -3335,7 +3341,7 @@ "IPRange$Status": "

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

", "IPRange$CIDRIP": "

Specifies the IP range.

", "KeyList$member": null, - "ListTagsForResourceMessage$ResourceName": "

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", + "ListTagsForResourceMessage$ResourceName": "

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", "LogTypeList$member": null, "MinimumEngineVersionPerAllowedValue$AllowedValue": "

The allowed value for an option setting.

", "MinimumEngineVersionPerAllowedValue$MinimumEngineVersion": "

The minimum DB engine version required for the allowed value.

", @@ -3348,14 +3354,14 @@ "ModifyDBClusterMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to use for the DB cluster.

", "ModifyDBClusterMessage$MasterUserPassword": "

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", "ModifyDBClusterMessage$OptionGroupName": "

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

", - "ModifyDBClusterMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", - "ModifyDBClusterMessage$PreferredMaintenanceWindow": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", + "ModifyDBClusterMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", + "ModifyDBClusterMessage$PreferredMaintenanceWindow": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", "ModifyDBClusterMessage$EngineVersion": "

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

", "ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to modify.

", "ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "

The identifier for the DB cluster snapshot to modify the attributes for.

", "ModifyDBClusterSnapshotAttributeMessage$AttributeName": "

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

", "ModifyDBInstanceMessage$DBInstanceIdentifier": "

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

", - "ModifyDBInstanceMessage$DBInstanceClass": "

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

", + "ModifyDBInstanceMessage$DBInstanceClass": "

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

", "ModifyDBInstanceMessage$DBSubnetGroupName": "

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

", "ModifyDBInstanceMessage$MasterUserPassword": "

The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

", "ModifyDBInstanceMessage$DBParameterGroupName": "

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

", @@ -3370,7 +3376,7 @@ "ModifyDBInstanceMessage$TdeCredentialPassword": "

The password for the given ARN from the key store in order to access the device.

", "ModifyDBInstanceMessage$CACertificateIdentifier": "

Indicates the certificate that needs to be associated with the instance.

", "ModifyDBInstanceMessage$Domain": "

The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain.

", - "ModifyDBInstanceMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", + "ModifyDBInstanceMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "ModifyDBInstanceMessage$DomainIAMRoleName": "

The name of the IAM role to use when making API calls to the Directory Service.

", "ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId": "

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

", "ModifyDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

", @@ -3437,7 +3443,7 @@ "Parameter$DataType": "

Specifies the valid data type for the parameter.

", "Parameter$AllowedValues": "

Specifies the valid range of values for the parameter.

", "Parameter$MinimumEngineVersion": "

The earliest engine version to which the parameter can apply.

", - "PendingMaintenanceAction$Action": "

The type of pending maintenance action that is available for the resource.

", + "PendingMaintenanceAction$Action": "

The type of pending maintenance action that is available for the resource. Valid actions are system-update and db-upgrade.

", "PendingMaintenanceAction$OptInStatus": "

Indicates the type of opt-in request that has been received for the resource.

", "PendingMaintenanceAction$Description": "

A description providing more detail about the maintenance action.

", "PendingMaintenanceActionsMessage$Marker": "

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

", @@ -3453,7 +3459,7 @@ "ProcessorFeature$Value": "

The value of a processor feature name.

", "PromoteReadReplicaDBClusterMessage$DBClusterIdentifier": "

The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster Read Replica.

Example: my-cluster-replica1

", "PromoteReadReplicaMessage$DBInstanceIdentifier": "

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing Read Replica DB instance.

Example: mydbinstance

", - "PromoteReadReplicaMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", + "PromoteReadReplicaMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferingId": "

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId": "

Customer-specified identifier to track this reservation.

Example: myreservationID

", "ReadReplicaDBClusterIdentifierList$member": null, @@ -3471,7 +3477,7 @@ "RemoveRoleFromDBInstanceMessage$FeatureName": "

The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.

", "RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName": "

The name of the RDS event notification subscription you want to remove a source identifier from.

", "RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier": "

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

", - "RemoveTagsFromResourceMessage$ResourceName": "

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", + "RemoveTagsFromResourceMessage$ResourceName": "

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", "ReservedDBInstance$ReservedDBInstanceId": "

The unique identifier for the reservation.

", "ReservedDBInstance$ReservedDBInstancesOfferingId": "

The offering identifier.

", "ReservedDBInstance$DBInstanceClass": "

The DB instance class for the reserved DB instance.

", @@ -3500,8 +3506,8 @@ "RestoreDBClusterFromS3Message$MasterUsername": "

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

", "RestoreDBClusterFromS3Message$MasterUserPassword": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", "RestoreDBClusterFromS3Message$OptionGroupName": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

", - "RestoreDBClusterFromS3Message$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", - "RestoreDBClusterFromS3Message$PreferredMaintenanceWindow": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", + "RestoreDBClusterFromS3Message$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", + "RestoreDBClusterFromS3Message$PreferredMaintenanceWindow": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", "RestoreDBClusterFromS3Message$KmsKeyId": "

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

", "RestoreDBClusterFromS3Message$SourceEngine": "

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

", "RestoreDBClusterFromS3Message$SourceEngineVersion": "

The version of the database that the backup files were created from.

MySQL version 5.5 and 5.6 are supported.

Example: 5.6.22

", @@ -3527,7 +3533,7 @@ "RestoreDBClusterToPointInTimeMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

", "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 numbers, letters, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

", "RestoreDBInstanceFromDBSnapshotMessage$DBSnapshotIdentifier": "

The identifier for the DB snapshot to restore from.

Constraints:

  • Must match the identifier of an existing DBSnapshot.

  • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

", - "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceClass": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

", + "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceClass": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

", "RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone": "

The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

", "RestoreDBInstanceFromDBSnapshotMessage$DBSubnetGroupName": "

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

", "RestoreDBInstanceFromDBSnapshotMessage$LicenseModel": "

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

", @@ -3542,21 +3548,21 @@ "RestoreDBInstanceFromDBSnapshotMessage$DBParameterGroupName": "

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

", "RestoreDBInstanceFromS3Message$DBName": "

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

", "RestoreDBInstanceFromS3Message$DBInstanceIdentifier": "

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

", - "RestoreDBInstanceFromS3Message$DBInstanceClass": "

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.

", + "RestoreDBInstanceFromS3Message$DBInstanceClass": "

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.

", "RestoreDBInstanceFromS3Message$Engine": "

The name of the database engine to be used for this instance.

Valid Values: mysql

", "RestoreDBInstanceFromS3Message$MasterUsername": "

The name for the master user.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

", "RestoreDBInstanceFromS3Message$MasterUserPassword": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", - "RestoreDBInstanceFromS3Message$AvailabilityZone": "

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

", + "RestoreDBInstanceFromS3Message$AvailabilityZone": "

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

", "RestoreDBInstanceFromS3Message$DBSubnetGroupName": "

A DB subnet group to associate with this DB instance.

", - "RestoreDBInstanceFromS3Message$PreferredMaintenanceWindow": "

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

  • Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred backup window.

  • Must be at least 30 minutes.

", + "RestoreDBInstanceFromS3Message$PreferredMaintenanceWindow": "

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

  • Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred backup window.

  • Must be at least 30 minutes.

", "RestoreDBInstanceFromS3Message$DBParameterGroupName": "

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.

", - "RestoreDBInstanceFromS3Message$PreferredBackupWindow": "

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", + "RestoreDBInstanceFromS3Message$PreferredBackupWindow": "

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

", "RestoreDBInstanceFromS3Message$EngineVersion": "

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

", "RestoreDBInstanceFromS3Message$LicenseModel": "

The license model for this DB instance. Use general-public-license.

", "RestoreDBInstanceFromS3Message$OptionGroupName": "

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

", "RestoreDBInstanceFromS3Message$StorageType": "

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

", "RestoreDBInstanceFromS3Message$KmsKeyId": "

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

", - "RestoreDBInstanceFromS3Message$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", + "RestoreDBInstanceFromS3Message$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "RestoreDBInstanceFromS3Message$SourceEngine": "

The name of the engine of your source database.

Valid Values: mysql

", "RestoreDBInstanceFromS3Message$SourceEngineVersion": "

The engine version of your source database.

Valid Values: 5.6

", "RestoreDBInstanceFromS3Message$S3BucketName": "

The name of your Amazon S3 bucket that contains your database backup file.

", @@ -3565,7 +3571,7 @@ "RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId": "

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.

", "RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier": "

The identifier of the source DB instance from which to restore.

Constraints:

  • Must match the identifier of an existing DB instance.

", "RestoreDBInstanceToPointInTimeMessage$TargetDBInstanceIdentifier": "

The name of the new DB instance to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

", - "RestoreDBInstanceToPointInTimeMessage$DBInstanceClass": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

", + "RestoreDBInstanceToPointInTimeMessage$DBInstanceClass": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

", "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "

The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

", "RestoreDBInstanceToPointInTimeMessage$DBSubnetGroupName": "

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

", "RestoreDBInstanceToPointInTimeMessage$LicenseModel": "

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

", @@ -3713,7 +3719,7 @@ } }, "TagList": { - "base": "

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", + "base": "

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", "refs": { "AddTagsToResourceMessage$Tags": "

The tags to be assigned to the Amazon RDS resource.

", "CopyDBClusterParameterGroupMessage$Tags": null, @@ -3737,7 +3743,7 @@ "RestoreDBClusterFromSnapshotMessage$Tags": "

The tags to be assigned to the restored DB cluster.

", "RestoreDBClusterToPointInTimeMessage$Tags": null, "RestoreDBInstanceFromDBSnapshotMessage$Tags": null, - "RestoreDBInstanceFromS3Message$Tags": "

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", + "RestoreDBInstanceFromS3Message$Tags": "

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

", "RestoreDBInstanceToPointInTimeMessage$Tags": null, "TagListMessage$TagList": "

List of tags returned by the ListTagsForResource operation.

" } diff --git a/src/data/rds/2014-10-31/docs-2.json.php b/src/data/rds/2014-10-31/docs-2.json.php index 88a2641441..9cc1ff601c 100644 --- a/src/data/rds/2014-10-31/docs-2.json.php +++ b/src/data/rds/2014-10-31/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance\'s compute resources and storage capacity to meet your application\'s demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

Amazon RDS User Guide

', 'operations' => [ 'AddRoleToDBCluster' => '

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

', 'AddRoleToDBInstance' => '

Associates an AWS Identity and Access Management (IAM) role with a DB instance.

', 'AddSourceIdentifierToSubscription' => '

Adds a source identifier to an existing RDS event notification subscription.

', 'AddTagsToResource' => '

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

', 'ApplyPendingMaintenanceAction' => '

Applies a pending maintenance action to a resource (for example, to a DB instance).

', 'AuthorizeDBSecurityGroupIngress' => '

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can\'t authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can\'t authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

', 'BacktrackDBCluster' => '

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

', 'CopyDBClusterParameterGroup' => '

Copies the specified DB cluster parameter group.

', 'CopyDBClusterSnapshot' => '

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'CopyDBParameterGroup' => '

Copies the specified DB parameter group.

', 'CopyDBSnapshot' => '

Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

', 'CopyOptionGroup' => '

Copies the specified option group.

', 'CreateDBCluster' => '

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'CreateDBClusterEndpoint' => '

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

', 'CreateDBClusterParameterGroup' => '

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you\'ve created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'CreateDBClusterSnapshot' => '

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'CreateDBInstance' => '

Creates a new DB instance.

', 'CreateDBInstanceReadReplica' => '

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn\'t support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.

Your source DB instance must have backup retention enabled.

', 'CreateDBParameterGroup' => '

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you\'ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

', 'CreateDBSecurityGroup' => '

Creates a new DB security group. DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

', 'CreateDBSnapshot' => '

Creates a DBSnapshot. The source DBInstance must be in "available" state.

', 'CreateDBSubnetGroup' => '

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

', 'CreateEventSubscription' => '

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.

', 'CreateGlobalCluster' => '

Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

', 'CreateOptionGroup' => '

Creates a new option group. You can create up to 20 option groups.

', 'DeleteDBCluster' => '

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can\'t be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DeleteDBClusterEndpoint' => '

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

', 'DeleteDBClusterParameterGroup' => '

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can\'t be associated with any DB clusters.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DeleteDBClusterSnapshot' => '

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DeleteDBInstance' => '

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can\'t be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can\'t be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can\'t delete the DB instance if both of the following conditions are true:

  • The DB cluster is a Read Replica of another Amazon Aurora DB cluster.

  • The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it\'s no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

', 'DeleteDBInstanceAutomatedBackup' => '

Deletes automated backups based on the source instance\'s DbiResourceId value or the restorable instance\'s resource ID.

', 'DeleteDBParameterGroup' => '

Deletes a specified DB parameter group. The DB parameter group to be deleted can\'t be associated with any DB instances.

', 'DeleteDBSecurityGroup' => '

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

', 'DeleteDBSnapshot' => '

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB snapshot must be in the available state to be deleted.

', 'DeleteDBSubnetGroup' => '

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

', 'DeleteEventSubscription' => '

Deletes an RDS event notification subscription.

', 'DeleteGlobalCluster' => '

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

', 'DeleteOptionGroup' => '

Deletes an existing option group.

', 'DescribeAccountAttributes' => '

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota\'s maximum value.

This command doesn\'t take any parameters.

', 'DescribeCertificates' => '

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

', 'DescribeDBClusterBacktracks' => '

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeDBClusterEndpoints' => '

Returns information about endpoints for an Amazon Aurora DB cluster.

', 'DescribeDBClusterParameterGroups' => '

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeDBClusterParameters' => '

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeDBClusterSnapshotAttributes' => '

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

', 'DescribeDBClusterSnapshots' => '

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeDBClusters' => '

Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeDBEngineVersions' => '

Returns a list of the available DB engines.

', 'DescribeDBInstanceAutomatedBackups' => '

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

', 'DescribeDBInstances' => '

Returns information about provisioned RDS instances. This API supports pagination.

', 'DescribeDBLogFiles' => '

Returns a list of DB log files for the DB instance.

', 'DescribeDBParameterGroups' => '

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

', 'DescribeDBParameters' => '

Returns the detailed parameter list for a particular DB parameter group.

', 'DescribeDBSecurityGroups' => '

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

', 'DescribeDBSnapshotAttributes' => '

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

', 'DescribeDBSnapshots' => '

Returns information about DB snapshots. This API action supports pagination.

', 'DescribeDBSubnetGroups' => '

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

', 'DescribeEngineDefaultClusterParameters' => '

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeEngineDefaultParameters' => '

Returns the default engine and system parameter information for the specified database engine.

', 'DescribeEventCategories' => '

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

', 'DescribeEventSubscriptions' => '

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

', 'DescribeEvents' => '

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

', 'DescribeGlobalClusters' => '

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeOptionGroupOptions' => '

Describes all available options.

', 'DescribeOptionGroups' => '

Describes the available option groups.

', 'DescribeOrderableDBInstanceOptions' => '

Returns a list of orderable DB instance options for the specified engine.

', 'DescribePendingMaintenanceActions' => '

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

', 'DescribeReservedDBInstances' => '

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

', 'DescribeReservedDBInstancesOfferings' => '

Lists available reserved DB instance offerings.

', 'DescribeSourceRegions' => '

Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

', 'DescribeValidDBInstanceModifications' => '

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

', 'DownloadDBLogFilePortion' => '

Downloads all or a portion of the specified log file, up to 1 MB in size.

', 'FailoverDBCluster' => '

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'ListTagsForResource' => '

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'ModifyCurrentDBClusterCapacity' => '

Set the capacity of an Aurora Serverless DB cluster to a specific value.

Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

', 'ModifyDBCluster' => '

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'ModifyDBClusterEndpoint' => '

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

', 'ModifyDBClusterParameterGroup' => '

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

', 'ModifyDBClusterSnapshotAttribute' => '

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

', 'ModifyDBInstance' => '

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

', 'ModifyDBParameterGroup' => '

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

', 'ModifyDBSnapshot' => '

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

', 'ModifyDBSnapshotAttribute' => '

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don\'t want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.

', 'ModifyDBSubnetGroup' => '

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

', 'ModifyEventSubscription' => '

Modifies an existing RDS event notification subscription. Note that you can\'t modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

', 'ModifyGlobalCluster' => '

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'ModifyOptionGroup' => '

Modifies an existing option group.

', 'PromoteReadReplica' => '

Promotes a Read Replica DB instance to a standalone DB instance.

  • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion.

  • This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL.

', 'PromoteReadReplicaDBCluster' => '

Promotes a Read Replica DB cluster to a standalone DB cluster.

', 'PurchaseReservedDBInstancesOffering' => '

Purchases a reserved DB instance offering.

', 'RebootDBInstance' => '

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

', 'RemoveFromGlobalCluster' => '

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

', 'RemoveRoleFromDBCluster' => '

Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

', 'RemoveRoleFromDBInstance' => '

Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

', 'RemoveSourceIdentifierFromSubscription' => '

Removes a source identifier from an existing RDS event notification subscription.

', 'RemoveTagsFromResource' => '

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'ResetDBClusterParameterGroup' => '

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'ResetDBParameterGroup' => '

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

', 'RestoreDBClusterFromS3' => '

Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

', 'RestoreDBClusterFromSnapshot' => '

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'RestoreDBClusterToPointInTime' => '

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'RestoreDBInstanceFromDBSnapshot' => '

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn\'t allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

', 'RestoreDBInstanceFromS3' => '

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

', 'RestoreDBInstanceToPointInTime' => '

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

', 'RevokeDBSecurityGroupIngress' => '

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

', 'StartDBCluster' => '

Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

', 'StartDBInstance' => '

Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

', 'StopDBCluster' => '

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster\'s metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

', 'StopDBInstance' => '

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance\'s metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

', ], 'shapes' => [ 'AccountAttributesMessage' => [ 'base' => '

Data returned by the DescribeAccountAttributes action.

', 'refs' => [], ], 'AccountQuota' => [ 'base' => '

Describes a quota for an AWS account, for example, the number of DB instances allowed.

', 'refs' => [ 'AccountQuotaList$member' => NULL, ], ], 'AccountQuotaList' => [ 'base' => NULL, 'refs' => [ 'AccountAttributesMessage$AccountQuotas' => '

A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

', ], ], 'AddRoleToDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddRoleToDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsToResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'ApplyMethod' => [ 'base' => NULL, 'refs' => [ 'Parameter$ApplyMethod' => '

Indicates when to apply parameter updates.

', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'base' => '

', 'refs' => [], ], 'ApplyPendingMaintenanceActionResult' => [ 'base' => NULL, 'refs' => [], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttribute$AttributeValues' => '

The value(s) for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

', 'DBSnapshotAttribute$AttributeValues' => '

The value or values for the manual DB snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToAdd' => '

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all AWS accounts.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToRemove' => '

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

', 'ModifyDBSnapshotAttributeMessage$ValuesToAdd' => '

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don\'t want available to all AWS accounts.

', 'ModifyDBSnapshotAttributeMessage$ValuesToRemove' => '

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

', ], ], 'AuthorizationAlreadyExistsFault' => [ 'base' => '

The specified CIDRIP or Amazon EC2 security group is already authorized for the specified DB security group.

', 'refs' => [], ], 'AuthorizationNotFoundFault' => [ 'base' => '

The specified CIDRIP or Amazon EC2 security group isn\'t authorized for the specified DB security group.

RDS also may not be authorized by using IAM to perform necessary actions on your behalf.

', 'refs' => [], ], 'AuthorizationQuotaExceededFault' => [ 'base' => '

The DB security group authorization quota has been reached.

', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'base' => '

', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'AvailabilityZone' => [ 'base' => '

Contains Availability Zone information.

This data type is used as an element in the following data type:

', 'refs' => [ 'AvailabilityZoneList$member' => NULL, 'Subnet$SubnetAvailabilityZone' => NULL, ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailabilityZones' => '

A list of Availability Zones for a DB instance.

', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$AvailabilityZones' => '

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

', 'DBCluster$AvailabilityZones' => '

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

', 'DBClusterSnapshot$AvailabilityZones' => '

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

', 'RestoreDBClusterFromS3Message$AvailabilityZones' => '

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

', 'RestoreDBClusterFromSnapshotMessage$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

', ], ], 'AvailableProcessorFeature' => [ 'base' => '

Contains the available processor feature information for the DB instance class of a DB instance.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

', 'refs' => [ 'AvailableProcessorFeatureList$member' => NULL, ], ], 'AvailableProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailableProcessorFeatures' => '

A list of the available processor features for the DB instance class of a DB instance.

', 'ValidDBInstanceModificationsMessage$ValidProcessorFeatures' => '

Valid processor features for your DB instance.

', ], ], 'BacktrackDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'BackupPolicyNotFoundFault' => [ 'base' => '

The backup policy was not found.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'DBCluster$MultiAZ' => '

Specifies whether the DB cluster has instances in multiple Availability Zones.

', 'DBCluster$StorageEncrypted' => '

Specifies whether the DB cluster is encrypted.

', 'DBCluster$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DBCluster$DeletionProtection' => '

Indicates if the DB cluster has deletion protection enabled. The database can\'t be deleted when this value is set to true.

', 'DBCluster$HttpEndpointEnabled' => '

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'DBClusterMember$IsClusterWriter' => '

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

', 'DBClusterSnapshot$StorageEncrypted' => '

Specifies whether the DB cluster snapshot is encrypted.

', 'DBClusterSnapshot$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DBEngineVersion$SupportsLogExportsToCloudwatchLogs' => '

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

', 'DBEngineVersion$SupportsReadReplica' => '

Indicates whether the database engine version supports read replicas.

', 'DBInstance$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment.

', 'DBInstance$AutoMinorVersionUpgrade' => '

Indicates that minor version patches are applied automatically.

', 'DBInstance$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

', 'DBInstance$StorageEncrypted' => '

Specifies whether the DB instance is encrypted.

', 'DBInstance$CopyTagsToSnapshot' => '

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

', 'DBInstance$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

', 'DBInstance$DeletionProtection' => '

Indicates if the DB instance has deletion protection enabled. The database can\'t be deleted when this value is set to true. For more information, see Deleting a DB Instance.

', 'DBInstanceAutomatedBackup$Encrypted' => '

Specifies whether the automated backup is encrypted.

', 'DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DBInstanceStatusInfo$Normal' => '

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

', 'DBSnapshot$Encrypted' => '

Specifies whether the DB snapshot is encrypted.

', 'DBSnapshot$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DeleteDBClusterMessage$SkipFinalSnapshot' => '

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

', 'DeleteDBInstanceMessage$SkipFinalSnapshot' => '

A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

', 'DescribeDBClusterSnapshotsMessage$IncludeShared' => '

True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

', 'DescribeDBClusterSnapshotsMessage$IncludePublic' => '

True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

', 'DescribeDBEngineVersionsMessage$DefaultOnly' => '

Indicates that only the default version of the specified engine or engine and major version combination is returned.

', 'DescribeDBSnapshotsMessage$IncludeShared' => '

True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

', 'DescribeDBSnapshotsMessage$IncludePublic' => '

True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

', 'DownloadDBLogFilePortionDetails$AdditionalDataPending' => '

Boolean value that if true, indicates there is more data to be downloaded.

', 'EventSubscription$Enabled' => '

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

', 'GlobalClusterMember$IsWriter' => '

Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

', 'ModifyDBClusterMessage$ApplyImmediately' => '

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

', 'ModifyDBInstanceMessage$ApplyImmediately' => '

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes are applied.

Default: false

', 'ModifyDBInstanceMessage$AllowMajorVersionUpgrade' => '

Indicates that major version upgrades are allowed. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance\'s current version.

', 'ModifyOptionGroupMessage$ApplyImmediately' => '

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

', 'Option$Persistent' => '

Indicate if this option is persistent.

', 'Option$Permanent' => '

Indicate if this option is permanent.

', 'OptionGroup$AllowsVpcAndNonVpcInstanceMemberships' => '

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

', 'OptionGroupOption$PortRequired' => '

Specifies whether the option requires a port.

', 'OptionGroupOption$Persistent' => '

Persistent options can\'t be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

', 'OptionGroupOption$Permanent' => '

Permanent options can never be removed from an option group. An option group containing a permanent option can\'t be removed from a DB instance.

', 'OptionGroupOption$RequiresAutoMinorEngineVersionUpgrade' => '

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

', 'OptionGroupOption$VpcOnly' => '

If true, you can only use this option with a DB instance that is in a VPC.

', 'OptionGroupOptionSetting$IsModifiable' => '

Boolean value where true indicates that this option group option can be changed from the default value.

', 'OptionGroupOptionSetting$IsRequired' => '

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

', 'OptionSetting$IsModifiable' => '

A Boolean value that, when true, indicates the option setting can be modified from the default.

', 'OptionSetting$IsCollection' => '

Indicates if the option setting is part of a collection.

', 'OptionVersion$IsDefault' => '

True if the version is the default version of the option, and otherwise false.

', 'OrderableDBInstanceOption$MultiAZCapable' => '

Indicates whether a DB instance is Multi-AZ capable.

', 'OrderableDBInstanceOption$ReadReplicaCapable' => '

Indicates whether a DB instance can have a Read Replica.

', 'OrderableDBInstanceOption$Vpc' => '

Indicates whether a DB instance is in a VPC.

', 'OrderableDBInstanceOption$SupportsStorageEncryption' => '

Indicates whether a DB instance supports encrypted storage.

', 'OrderableDBInstanceOption$SupportsIops' => '

Indicates whether a DB instance supports provisioned IOPS.

', 'OrderableDBInstanceOption$SupportsEnhancedMonitoring' => '

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

', 'OrderableDBInstanceOption$SupportsIAMDatabaseAuthentication' => '

Indicates whether a DB instance supports IAM database authentication.

', 'OrderableDBInstanceOption$SupportsPerformanceInsights' => '

True if a DB instance supports Performance Insights, otherwise false.

', 'Parameter$IsModifiable' => '

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

', 'ReservedDBInstance$MultiAZ' => '

Indicates if the reservation applies to Multi-AZ deployments.

', 'ReservedDBInstancesOffering$MultiAZ' => '

Indicates if the offering applies to Multi-AZ deployments.

', 'ResetDBClusterParameterGroupMessage$ResetAllParameters' => '

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.

', 'ResetDBParameterGroupMessage$ResetAllParameters' => '

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

', 'RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime' => '

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Can\'t be specified if RestoreToTime parameter is provided.

', 'RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime' => '

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Can\'t be specified if RestoreTime parameter is provided.

', 'UpgradeTarget$AutoUpgrade' => '

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

', 'UpgradeTarget$IsMajorVersionUpgrade' => '

A value that indicates whether a database engine is upgraded to a major version.

', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$Force' => '

A value that, if specified, forces the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

', 'BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable' => '

If BacktrackTo is set to a timestamp earlier than the earliest backtrack time, this value backtracks the DB cluster to the earliest possible backtrack time. Otherwise, an error occurs.

', 'CopyDBClusterSnapshotMessage$CopyTags' => '

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

', 'CopyDBSnapshotMessage$CopyTags' => '

True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false.

', 'CreateDBClusterMessage$StorageEncrypted' => '

Specifies whether the DB cluster is encrypted.

', 'CreateDBClusterMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'CreateDBClusterMessage$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'CreateDBInstanceMessage$MultiAZ' => '

A value that specifies whether the DB instance is a Multi-AZ deployment. You can\'t set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

', 'CreateDBInstanceMessage$AutoMinorVersionUpgrade' => '

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

', 'CreateDBInstanceMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies:

  • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

', 'CreateDBInstanceMessage$StorageEncrypted' => '

Specifies whether the DB instance is encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

Default: false

', 'CreateDBInstanceMessage$CopyTagsToSnapshot' => '

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

', 'CreateDBInstanceMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'CreateDBInstanceMessage$EnablePerformanceInsights' => '

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

', 'CreateDBInstanceMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'CreateDBInstanceReadReplicaMessage$MultiAZ' => '

Specifies whether the Read Replica is in a Multi-AZ deployment.

You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

', 'CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade' => '

Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

', 'CreateDBInstanceReadReplicaMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot' => '

True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.

', 'CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora MySQL 5.6 or higher

Default: false

', 'CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights' => '

True to enable Performance Insights for the read replica, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

', 'CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'CreateDBInstanceReadReplicaMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'CreateEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

', 'CreateGlobalClusterMessage$DeletionProtection' => '

The deletion protection setting for the new global database. The global database can\'t be deleted when this value is set to true.

', 'CreateGlobalClusterMessage$StorageEncrypted' => '

The storage encryption setting for the new global database cluster.

', 'DBInstance$PerformanceInsightsEnabled' => '

True if Performance Insights is enabled for the DB instance, and otherwise false.

', 'DeleteDBInstanceMessage$DeleteAutomatedBackups' => '

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn\'t case-sensitive. This parameter defaults to true.

', 'DescribeDBEngineVersionsMessage$ListSupportedCharacterSets' => '

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

', 'DescribeDBEngineVersionsMessage$ListSupportedTimezones' => '

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$Vpc' => '

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

', 'DescribeReservedDBInstancesMessage$MultiAZ' => '

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

', 'DescribeReservedDBInstancesOfferingsMessage$MultiAZ' => '

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

', 'GlobalCluster$StorageEncrypted' => '

The storage encryption setting for the global database cluster.

', 'GlobalCluster$DeletionProtection' => '

The deletion protection setting for the new global database cluster.

', 'ModifyDBClusterMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'ModifyDBClusterMessage$DeletionProtection' => '

Indicates if the DB cluster has deletion protection enabled. The database can\'t be deleted when this value is set to true.

', 'ModifyDBClusterMessage$EnableHttpEndpoint' => '

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'ModifyDBInstanceMessage$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn\'t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

', 'ModifyDBInstanceMessage$AutoMinorVersionUpgrade' => '

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn\'t result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

', 'ModifyDBInstanceMessage$CopyTagsToSnapshot' => '

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

', 'ModifyDBInstanceMessage$PubliclyAccessible' => '

Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Default: false

', 'ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'ModifyDBInstanceMessage$EnablePerformanceInsights' => '

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

', 'ModifyDBInstanceMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'ModifyDBInstanceMessage$DeletionProtection' => '

Indicates if the DB instance has deletion protection enabled. The database can\'t be deleted when this value is set to true. For more information, see Deleting a DB Instance.

', 'ModifyEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription.

', 'ModifyGlobalClusterMessage$DeletionProtection' => '

Indicates if the global database cluster has deletion protection enabled. The global database cluster can\'t be deleted when this value is set to true.

', 'OptionGroupOption$SupportsOptionVersionDowngrade' => '

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

', 'PendingModifiedValues$MultiAZ' => '

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

', 'RebootDBInstanceMessage$ForceFailover' => '

When true, the reboot is conducted through a MultiAZ failover.

Constraint: You can\'t specify true if the instance is not configured for MultiAZ.

', 'RestoreDBClusterFromS3Message$StorageEncrypted' => '

Specifies whether the restored DB cluster is encrypted.

', 'RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBClusterFromS3Message$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'RestoreDBClusterFromSnapshotMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBClusterFromSnapshotMessage$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBClusterToPointInTimeMessage$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'RestoreDBInstanceFromDBSnapshotMessage$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

', 'RestoreDBInstanceFromDBSnapshotMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade' => '

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

', 'RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.

', 'RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'RestoreDBInstanceFromS3Message$MultiAZ' => '

Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can\'t set the AvailabilityZone parameter.

', 'RestoreDBInstanceFromS3Message$AutoMinorVersionUpgrade' => '

True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.

Default: true

', 'RestoreDBInstanceFromS3Message$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'RestoreDBInstanceFromS3Message$StorageEncrypted' => '

Specifies whether the new DB instance is encrypted or not.

', 'RestoreDBInstanceFromS3Message$CopyTagsToSnapshot' => '

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.

Default: false.

', 'RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBInstanceFromS3Message$EnablePerformanceInsights' => '

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

', 'RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'RestoreDBInstanceFromS3Message$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'RestoreDBInstanceToPointInTimeMessage$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

', 'RestoreDBInstanceToPointInTimeMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade' => '

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

', 'RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.

', 'RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'RestoreDBInstanceToPointInTimeMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'ScalingConfiguration$AutoPause' => '

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it\'s idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

', 'ScalingConfigurationInfo$AutoPause' => '

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

', ], ], 'Certificate' => [ 'base' => '

A CA certificate for an AWS account.

', 'refs' => [ 'CertificateList$member' => NULL, ], ], 'CertificateList' => [ 'base' => NULL, 'refs' => [ 'CertificateMessage$Certificates' => '

The list of Certificate objects for the AWS account.

', ], ], 'CertificateMessage' => [ 'base' => '

Data returned by the DescribeCertificates action.

', 'refs' => [], ], 'CertificateNotFoundFault' => [ 'base' => '

CertificateIdentifier doesn\'t refer to an existing certificate.

', 'refs' => [], ], 'CharacterSet' => [ 'base' => '

This data type is used as a response element in the action DescribeDBEngineVersions.

', 'refs' => [ 'DBEngineVersion$DefaultCharacterSet' => '

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

', 'SupportedCharacterSetsList$member' => NULL, ], ], 'CloudwatchLogsExportConfiguration' => [ 'base' => '

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', 'refs' => [ 'ModifyDBClusterMessage$CloudwatchLogsExportConfiguration' => '

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

', 'ModifyDBInstanceMessage$CloudwatchLogsExportConfiguration' => '

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBInstanceReadReplicaMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSecurityGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSecurityGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DBCluster' => [ 'base' => '

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

', 'refs' => [ 'CreateDBClusterResult$DBCluster' => NULL, 'DBClusterList$member' => NULL, 'DeleteDBClusterResult$DBCluster' => NULL, 'FailoverDBClusterResult$DBCluster' => NULL, 'ModifyDBClusterResult$DBCluster' => NULL, 'PromoteReadReplicaDBClusterResult$DBCluster' => NULL, 'RestoreDBClusterFromS3Result$DBCluster' => NULL, 'RestoreDBClusterFromSnapshotResult$DBCluster' => NULL, 'RestoreDBClusterToPointInTimeResult$DBCluster' => NULL, 'StartDBClusterResult$DBCluster' => NULL, 'StopDBClusterResult$DBCluster' => NULL, ], ], 'DBClusterAlreadyExistsFault' => [ 'base' => '

The user already has a DB cluster with the given identifier.

', 'refs' => [], ], 'DBClusterBacktrack' => [ 'base' => '

This data type is used as a response element in the DescribeDBClusterBacktracks action.

', 'refs' => [ 'DBClusterBacktrackList$member' => NULL, ], ], 'DBClusterBacktrackList' => [ 'base' => NULL, 'refs' => [ 'DBClusterBacktrackMessage$DBClusterBacktracks' => '

Contains a list of backtracks for the user.

', ], ], 'DBClusterBacktrackMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

', 'refs' => [], ], 'DBClusterBacktrackNotFoundFault' => [ 'base' => '

BacktrackIdentifier doesn\'t refer to an existing backtrack.

', 'refs' => [], ], 'DBClusterCapacityInfo' => [ 'base' => NULL, 'refs' => [], ], 'DBClusterEndpoint' => [ 'base' => '

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

', 'refs' => [ 'DBClusterEndpointList$member' => NULL, ], ], 'DBClusterEndpointAlreadyExistsFault' => [ 'base' => '

The specified custom endpoint can\'t be created because it already exists.

', 'refs' => [], ], 'DBClusterEndpointList' => [ 'base' => NULL, 'refs' => [ 'DBClusterEndpointMessage$DBClusterEndpoints' => '

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

', ], ], 'DBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DBClusterEndpointNotFoundFault' => [ 'base' => '

The specified custom endpoint doesn\'t exist.

', 'refs' => [], ], 'DBClusterEndpointQuotaExceededFault' => [ 'base' => '

The cluster already has the maximum number of custom endpoints.

', 'refs' => [], ], 'DBClusterList' => [ 'base' => NULL, 'refs' => [ 'DBClusterMessage$DBClusters' => '

Contains a list of DB clusters for the user.

', ], ], 'DBClusterMember' => [ 'base' => '

Contains information about an instance that is part of a DB cluster.

', 'refs' => [ 'DBClusterMemberList$member' => NULL, ], ], 'DBClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterMembers' => '

Provides the list of instances that make up the DB cluster.

', ], ], 'DBClusterMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBClusters action.

', 'refs' => [], ], 'DBClusterNotFoundFault' => [ 'base' => '

DBClusterIdentifier doesn\'t refer to an existing DB cluster.

', 'refs' => [], ], 'DBClusterOptionGroupMemberships' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterOptionGroupMemberships' => '

Provides the list of option group memberships for this DB cluster.

', ], ], 'DBClusterOptionGroupStatus' => [ 'base' => '

Contains status information for a DB cluster option group.

', 'refs' => [ 'DBClusterOptionGroupMemberships$member' => NULL, ], ], 'DBClusterParameterGroup' => [ 'base' => '

Contains the details of an Amazon RDS DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

', 'refs' => [ 'CopyDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'CreateDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'DBClusterParameterGroupList$member' => NULL, ], ], 'DBClusterParameterGroupDetails' => [ 'base' => '

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

', 'refs' => [], ], 'DBClusterParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupsMessage$DBClusterParameterGroups' => '

A list of DB cluster parameter groups.

', ], ], 'DBClusterParameterGroupNameMessage' => [ 'base' => '

', 'refs' => [], ], 'DBClusterParameterGroupNotFoundFault' => [ 'base' => '

DBClusterParameterGroupName doesn\'t refer to an existing DB cluster parameter group.

', 'refs' => [], ], 'DBClusterParameterGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DBClusterQuotaExceededFault' => [ 'base' => '

The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

', 'refs' => [], ], 'DBClusterRole' => [ 'base' => '

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

', 'refs' => [ 'DBClusterRoles$member' => NULL, ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'base' => '

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

', 'refs' => [], ], 'DBClusterRoleNotFoundFault' => [ 'base' => '

The specified IAM role Amazon Resource Name (ARN) isn\'t associated with the specified DB cluster.

', 'refs' => [], ], 'DBClusterRoleQuotaExceededFault' => [ 'base' => '

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

', 'refs' => [], ], 'DBClusterRoles' => [ 'base' => NULL, 'refs' => [ 'DBCluster$AssociatedRoles' => '

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

', ], ], 'DBClusterSnapshot' => [ 'base' => '

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

', 'refs' => [ 'CopyDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'CreateDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'DBClusterSnapshotList$member' => NULL, 'DeleteDBClusterSnapshotResult$DBClusterSnapshot' => NULL, ], ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'base' => '

The user already has a DB cluster snapshot with the given identifier.

', 'refs' => [], ], 'DBClusterSnapshotAttribute' => [ 'base' => '

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

', 'refs' => [ 'DBClusterSnapshotAttributeList$member' => NULL, ], ], 'DBClusterSnapshotAttributeList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttributesResult$DBClusterSnapshotAttributes' => '

The list of attributes and values for the manual DB cluster snapshot.

', ], ], 'DBClusterSnapshotAttributesResult' => [ 'base' => '

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

', 'refs' => [ 'DescribeDBClusterSnapshotAttributesResult$DBClusterSnapshotAttributesResult' => NULL, 'ModifyDBClusterSnapshotAttributeResult$DBClusterSnapshotAttributesResult' => NULL, ], ], 'DBClusterSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotMessage$DBClusterSnapshots' => '

Provides a list of DB cluster snapshots for the user.

', ], ], 'DBClusterSnapshotMessage' => [ 'base' => '

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

', 'refs' => [], ], 'DBClusterSnapshotNotFoundFault' => [ 'base' => '

DBClusterSnapshotIdentifier doesn\'t refer to an existing DB cluster snapshot.

', 'refs' => [], ], 'DBEngineVersion' => [ 'base' => '

This data type is used as a response element in the action DescribeDBEngineVersions.

', 'refs' => [ 'DBEngineVersionList$member' => NULL, ], ], 'DBEngineVersionList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersionMessage$DBEngineVersions' => '

A list of DBEngineVersion elements.

', ], ], 'DBEngineVersionMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

', 'refs' => [], ], 'DBInstance' => [ 'base' => '

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

', 'refs' => [ 'CreateDBInstanceReadReplicaResult$DBInstance' => NULL, 'CreateDBInstanceResult$DBInstance' => NULL, 'DBInstanceList$member' => NULL, 'DeleteDBInstanceResult$DBInstance' => NULL, 'ModifyDBInstanceResult$DBInstance' => NULL, 'PromoteReadReplicaResult$DBInstance' => NULL, 'RebootDBInstanceResult$DBInstance' => NULL, 'RestoreDBInstanceFromDBSnapshotResult$DBInstance' => NULL, 'RestoreDBInstanceFromS3Result$DBInstance' => NULL, 'RestoreDBInstanceToPointInTimeResult$DBInstance' => NULL, 'StartDBInstanceResult$DBInstance' => NULL, 'StopDBInstanceResult$DBInstance' => NULL, ], ], 'DBInstanceAlreadyExistsFault' => [ 'base' => '

The user already has a DB instance with the given identifier.

', 'refs' => [], ], 'DBInstanceAutomatedBackup' => [ 'base' => '

An automated backup of a DB instance. It it consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

', 'refs' => [ 'DBInstanceAutomatedBackupList$member' => NULL, 'DeleteDBInstanceAutomatedBackupResult$DBInstanceAutomatedBackup' => NULL, ], ], 'DBInstanceAutomatedBackupList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceAutomatedBackupMessage$DBInstanceAutomatedBackups' => '

A list of DBInstanceAutomatedBackup instances.

', ], ], 'DBInstanceAutomatedBackupMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

', 'refs' => [], ], 'DBInstanceAutomatedBackupNotFoundFault' => [ 'base' => '

No automated backup for this DB instance was found.

', 'refs' => [], ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'base' => '

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

', 'refs' => [], ], 'DBInstanceList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceMessage$DBInstances' => '

A list of DBInstance instances.

', ], ], 'DBInstanceMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBInstances action.

', 'refs' => [], ], 'DBInstanceNotFoundFault' => [ 'base' => '

DBInstanceIdentifier doesn\'t refer to an existing DB instance.

', 'refs' => [], ], 'DBInstanceRole' => [ 'base' => '

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.

', 'refs' => [ 'DBInstanceRoles$member' => NULL, ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'base' => '

The specified RoleArn or FeatureName value is already associated with the DB instance.

', 'refs' => [], ], 'DBInstanceRoleNotFoundFault' => [ 'base' => '

The specified RoleArn value doesn\'t match the specifed feature for the DB instance.

', 'refs' => [], ], 'DBInstanceRoleQuotaExceededFault' => [ 'base' => '

You can\'t associate any more AWS Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

', 'refs' => [], ], 'DBInstanceRoles' => [ 'base' => NULL, 'refs' => [ 'DBInstance$AssociatedRoles' => '

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

', ], ], 'DBInstanceStatusInfo' => [ 'base' => '

Provides a list of status information for a DB instance.

', 'refs' => [ 'DBInstanceStatusInfoList$member' => NULL, ], ], 'DBInstanceStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$StatusInfos' => '

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

', ], ], 'DBLogFileNotFoundFault' => [ 'base' => '

LogFileName doesn\'t refer to an existing DB log file.

', 'refs' => [], ], 'DBParameterGroup' => [ 'base' => '

Contains the details of an Amazon RDS DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

', 'refs' => [ 'CopyDBParameterGroupResult$DBParameterGroup' => NULL, 'CreateDBParameterGroupResult$DBParameterGroup' => NULL, 'DBParameterGroupList$member' => NULL, ], ], 'DBParameterGroupAlreadyExistsFault' => [ 'base' => '

A DB parameter group with the same name exists.

', 'refs' => [], ], 'DBParameterGroupDetails' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBParameters action.

', 'refs' => [], ], 'DBParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBParameterGroupsMessage$DBParameterGroups' => '

A list of DBParameterGroup instances.

', ], ], 'DBParameterGroupNameMessage' => [ 'base' => '

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

', 'refs' => [], ], 'DBParameterGroupNotFoundFault' => [ 'base' => '

DBParameterGroupName doesn\'t refer to an existing DB parameter group.

', 'refs' => [], ], 'DBParameterGroupQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB parameter groups.

', 'refs' => [], ], 'DBParameterGroupStatus' => [ 'base' => '

The status of the DB parameter group.

This data type is used as a response element in the following actions:

', 'refs' => [ 'DBParameterGroupStatusList$member' => NULL, ], ], 'DBParameterGroupStatusList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$DBParameterGroups' => '

Provides the list of DB parameter groups applied to this DB instance.

', ], ], 'DBParameterGroupsMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

', 'refs' => [], ], 'DBSecurityGroup' => [ 'base' => '

Contains the details for an Amazon RDS DB security group.

This data type is used as a response element in the DescribeDBSecurityGroups action.

', 'refs' => [ 'AuthorizeDBSecurityGroupIngressResult$DBSecurityGroup' => NULL, 'CreateDBSecurityGroupResult$DBSecurityGroup' => NULL, 'DBSecurityGroups$member' => NULL, 'RevokeDBSecurityGroupIngressResult$DBSecurityGroup' => NULL, ], ], 'DBSecurityGroupAlreadyExistsFault' => [ 'base' => '

A DB security group with the name specified in DBSecurityGroupName already exists.

', 'refs' => [], ], 'DBSecurityGroupMembership' => [ 'base' => '

This data type is used as a response element in the following actions:

', 'refs' => [ 'DBSecurityGroupMembershipList$member' => NULL, ], ], 'DBSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$DBSecurityGroups' => '

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

', 'Option$DBSecurityGroupMemberships' => '

If the option requires access to a port, then this DB security group allows access to the port.

', ], ], 'DBSecurityGroupMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

', 'refs' => [], ], 'DBSecurityGroupNameList' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceMessage$DBSecurityGroups' => '

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

', 'ModifyDBInstanceMessage$DBSecurityGroups' => '

A list of DB security groups to authorize on this DB instance. Changing this setting doesn\'t result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

', 'OptionConfiguration$DBSecurityGroupMemberships' => '

A list of DBSecurityGroupMemebrship name strings used for this option.

', 'RestoreDBInstanceFromS3Message$DBSecurityGroups' => '

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

', ], ], 'DBSecurityGroupNotFoundFault' => [ 'base' => '

DBSecurityGroupName doesn\'t refer to an existing DB security group.

', 'refs' => [], ], 'DBSecurityGroupNotSupportedFault' => [ 'base' => '

A DB security group isn\'t allowed for this action.

', 'refs' => [], ], 'DBSecurityGroupQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB security groups.

', 'refs' => [], ], 'DBSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroupMessage$DBSecurityGroups' => '

A list of DBSecurityGroup instances.

', ], ], 'DBSnapshot' => [ 'base' => '

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

', 'refs' => [ 'CopyDBSnapshotResult$DBSnapshot' => NULL, 'CreateDBSnapshotResult$DBSnapshot' => NULL, 'DBSnapshotList$member' => NULL, 'DeleteDBSnapshotResult$DBSnapshot' => NULL, 'ModifyDBSnapshotResult$DBSnapshot' => NULL, ], ], 'DBSnapshotAlreadyExistsFault' => [ 'base' => '

DBSnapshotIdentifier is already used by an existing snapshot.

', 'refs' => [], ], 'DBSnapshotAttribute' => [ 'base' => '

Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other AWS accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

', 'refs' => [ 'DBSnapshotAttributeList$member' => NULL, ], ], 'DBSnapshotAttributeList' => [ 'base' => NULL, 'refs' => [ 'DBSnapshotAttributesResult$DBSnapshotAttributes' => '

The list of attributes and values for the manual DB snapshot.

', ], ], 'DBSnapshotAttributesResult' => [ 'base' => '

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

', 'refs' => [ 'DescribeDBSnapshotAttributesResult$DBSnapshotAttributesResult' => NULL, 'ModifyDBSnapshotAttributeResult$DBSnapshotAttributesResult' => NULL, ], ], 'DBSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DBSnapshotMessage$DBSnapshots' => '

A list of DBSnapshot instances.

', ], ], 'DBSnapshotMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBSnapshots action.

', 'refs' => [], ], 'DBSnapshotNotFoundFault' => [ 'base' => '

DBSnapshotIdentifier doesn\'t refer to an existing DB snapshot.

', 'refs' => [], ], 'DBSubnetGroup' => [ 'base' => '

Contains the details of an Amazon RDS DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

', 'refs' => [ 'CreateDBSubnetGroupResult$DBSubnetGroup' => NULL, 'DBInstance$DBSubnetGroup' => '

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

', 'DBSubnetGroups$member' => NULL, 'ModifyDBSubnetGroupResult$DBSubnetGroup' => NULL, ], ], 'DBSubnetGroupAlreadyExistsFault' => [ 'base' => '

DBSubnetGroupName is already used by an existing DB subnet group.

', 'refs' => [], ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'base' => '

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

', 'refs' => [], ], 'DBSubnetGroupMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

', 'refs' => [], ], 'DBSubnetGroupNotAllowedFault' => [ 'base' => '

The DBSubnetGroup shouldn\'t be specified while creating read replicas that lie in the same region as the source instance.

', 'refs' => [], ], 'DBSubnetGroupNotFoundFault' => [ 'base' => '

DBSubnetGroupName doesn\'t refer to an existing DB subnet group.

', 'refs' => [], ], 'DBSubnetGroupQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB subnet groups.

', 'refs' => [], ], 'DBSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroupMessage$DBSubnetGroups' => '

A list of DBSubnetGroup instances.

', ], ], 'DBSubnetQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

', 'refs' => [], ], 'DBUpgradeDependencyFailureFault' => [ 'base' => '

The DB upgrade failed because a resource the DB depends on can\'t be modified.

', 'refs' => [], ], 'DeleteDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'base' => '

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

', 'refs' => [], ], 'DeleteDBInstanceAutomatedBackupResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSecurityGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeAccountAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeCertificatesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterBacktracksMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterEndpointsMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterSnapshotsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClustersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBEngineVersionsMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBInstanceAutomatedBackupsMessage' => [ 'base' => '

Parameter input for DescribeDBInstanceAutomatedBackups.

', 'refs' => [], ], 'DescribeDBInstancesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBLogFilesDetails' => [ 'base' => '

This data type is used as a response element to DescribeDBLogFiles.

', 'refs' => [ 'DescribeDBLogFilesList$member' => NULL, ], ], 'DescribeDBLogFilesList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBLogFilesResponse$DescribeDBLogFiles' => '

The DB log files returned.

', ], ], 'DescribeDBLogFilesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBLogFilesResponse' => [ 'base' => '

The response from a call to DescribeDBLogFiles.

', 'refs' => [], ], 'DescribeDBParameterGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBParametersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBSecurityGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSnapshotAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBSnapshotsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSubnetGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEngineDefaultParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventCategoriesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEventSubscriptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEventsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeGlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptionGroupOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeOptionGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribePendingMaintenanceActionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeReservedDBInstancesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeReservedDBInstancesOfferingsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeSourceRegionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeValidDBInstanceModificationsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeValidDBInstanceModificationsResult' => [ 'base' => NULL, 'refs' => [], ], 'DomainMembership' => [ 'base' => '

An Active Directory Domain membership record associated with the DB instance.

', 'refs' => [ 'DomainMembershipList$member' => NULL, ], ], 'DomainMembershipList' => [ 'base' => '

List of Active Directory Domain membership records associated with a DB instance.

', 'refs' => [ 'DBInstance$DomainMemberships' => '

The Active Directory Domain membership records associated with the DB instance.

', ], ], 'DomainNotFoundFault' => [ 'base' => '

Domain doesn\'t refer to an existing Active Directory domain.

', 'refs' => [], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'DoubleRange$From' => '

The minimum value in the range.

', 'DoubleRange$To' => '

The maximum value in the range.

', 'RecurringCharge$RecurringChargeAmount' => '

The amount of the recurring charge.

', 'ReservedDBInstance$FixedPrice' => '

The fixed price charged for this reserved DB instance.

', 'ReservedDBInstance$UsagePrice' => '

The hourly price charged for this reserved DB instance.

', 'ReservedDBInstancesOffering$FixedPrice' => '

The fixed price charged for this offering.

', 'ReservedDBInstancesOffering$UsagePrice' => '

The hourly price charged for this offering.

', ], ], 'DoubleOptional' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$MinIopsPerGib' => '

Minimum provisioned IOPS per GiB for a DB instance.

', 'OrderableDBInstanceOption$MaxIopsPerGib' => '

Maximum provisioned IOPS per GiB for a DB instance.

', ], ], 'DoubleRange' => [ 'base' => '

A range of double values.

', 'refs' => [ 'DoubleRangeList$member' => NULL, ], ], 'DoubleRangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$IopsToStorageRatio' => '

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

', ], ], 'DownloadDBLogFilePortionDetails' => [ 'base' => '

This data type is used as a response element to DownloadDBLogFilePortion.

', 'refs' => [], ], 'DownloadDBLogFilePortionMessage' => [ 'base' => '

', 'refs' => [], ], 'EC2SecurityGroup' => [ 'base' => '

This data type is used as a response element in the following actions:

', 'refs' => [ 'EC2SecurityGroupList$member' => NULL, ], ], 'EC2SecurityGroupList' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroup$EC2SecurityGroups' => '

Contains a list of EC2SecurityGroup elements.

', ], ], 'Endpoint' => [ 'base' => '

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

', 'refs' => [ 'DBInstance$Endpoint' => '

Specifies the connection endpoint.

', 'DBInstance$ListenerEndpoint' => '

Specifies the listener connection endpoint for SQL Server Always On.

', ], ], 'EngineDefaults' => [ 'base' => '

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

', 'refs' => [ 'DescribeEngineDefaultClusterParametersResult$EngineDefaults' => NULL, 'DescribeEngineDefaultParametersResult$EngineDefaults' => NULL, ], ], 'EngineModeList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedEngineModes' => '

A list of the supported DB engine modes.

', 'OrderableDBInstanceOption$SupportedEngineModes' => '

A list of the supported DB engine modes.

', 'Parameter$SupportedEngineModes' => '

The valid DB engine modes.

', ], ], 'Event' => [ 'base' => '

This data type is used as a response element in the DescribeEvents action.

', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCategoriesList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

', 'DescribeEventsMessage$EventCategories' => '

A list of event categories that trigger notifications for a event notification subscription.

', 'Event$EventCategories' => '

Specifies the category for the event.

', 'EventCategoriesMap$EventCategories' => '

The event categories for the specified source type

', 'EventSubscription$EventCategoriesList' => '

A list of event categories for the RDS event notification subscription.

', 'ModifyEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

', ], ], 'EventCategoriesMap' => [ 'base' => '

Contains the results of a successful invocation of the DescribeEventCategories action.

', 'refs' => [ 'EventCategoriesMapList$member' => NULL, ], ], 'EventCategoriesMapList' => [ 'base' => NULL, 'refs' => [ 'EventCategoriesMessage$EventCategoriesMapList' => '

A list of EventCategoriesMap data types.

', ], ], 'EventCategoriesMessage' => [ 'base' => '

Data returned from the DescribeEventCategories action.

', 'refs' => [], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'EventsMessage$Events' => '

A list of Event instances.

', ], ], 'EventSubscription' => [ 'base' => '

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

', 'refs' => [ 'AddSourceIdentifierToSubscriptionResult$EventSubscription' => NULL, 'CreateEventSubscriptionResult$EventSubscription' => NULL, 'DeleteEventSubscriptionResult$EventSubscription' => NULL, 'EventSubscriptionsList$member' => NULL, 'ModifyEventSubscriptionResult$EventSubscription' => NULL, 'RemoveSourceIdentifierFromSubscriptionResult$EventSubscription' => NULL, ], ], 'EventSubscriptionQuotaExceededFault' => [ 'base' => '

You have reached the maximum number of event subscriptions.

', 'refs' => [], ], 'EventSubscriptionsList' => [ 'base' => NULL, 'refs' => [ 'EventSubscriptionsMessage$EventSubscriptionsList' => '

A list of EventSubscriptions data types.

', ], ], 'EventSubscriptionsMessage' => [ 'base' => '

Data returned by the DescribeEventSubscriptions action.

', 'refs' => [], ], 'EventsMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeEvents action.

', 'refs' => [], ], 'FailoverDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'FailoverDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FeatureNameList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedFeatureNames' => '

A list of features supported by the DB engine. Supported feature names include the following.

  • s3Import

', ], ], 'Filter' => [ 'base' => '

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeCertificatesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterBacktracksMessage$Filters' => '

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

  • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

  • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    • applying

    • completed

    • failed

    • pending

    The results list includes information about only the backtracks identified by these values. For more information about backtrack status values, see DBClusterBacktrack.

', 'DescribeDBClusterEndpointsMessage$Filters' => '

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

', 'DescribeDBClusterParameterGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterSnapshotsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClustersMessage$Filters' => '

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

', 'DescribeDBEngineVersionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBInstanceAutomatedBackupsMessage$Filters' => '

A filter that specifies which resources to return based on status.

Supported filters are the following:

  • status

    • active - automated backups for current instances

    • retained - automated backups for deleted instances

    • creating - automated backups that are waiting for the first automated snapshot to be available

  • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs.

  • dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

', 'DescribeDBInstancesMessage$Filters' => '

A filter that specifies one or more DB instances to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

', 'DescribeDBLogFilesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBParameterGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBSecurityGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBSnapshotsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBSubnetGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEngineDefaultClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEngineDefaultParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventCategoriesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventSubscriptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeGlobalClustersMessage$Filters' => '

A filter that specifies one or more global DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

', 'DescribeOptionGroupOptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeOptionGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeOrderableDBInstanceOptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribePendingMaintenanceActionsMessage$Filters' => '

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

', 'DescribeReservedDBInstancesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeReservedDBInstancesOfferingsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeSourceRegionsMessage$Filters' => '

This parameter is not currently supported.

', 'ListTagsForResourceMessage$Filters' => '

This parameter is not currently supported.

', ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more filter values. Filter values are case-sensitive.

', ], ], 'GlobalCluster' => [ 'base' => '

A data type representing an Aurora global database.

', 'refs' => [ 'CreateGlobalClusterResult$GlobalCluster' => NULL, 'DeleteGlobalClusterResult$GlobalCluster' => NULL, 'GlobalClusterList$member' => NULL, 'ModifyGlobalClusterResult$GlobalCluster' => NULL, 'RemoveFromGlobalClusterResult$GlobalCluster' => NULL, ], ], 'GlobalClusterAlreadyExistsFault' => [ 'base' => '

', 'refs' => [], ], 'GlobalClusterList' => [ 'base' => NULL, 'refs' => [ 'GlobalClustersMessage$GlobalClusters' => '

The list of global clusters returned by this request.

', ], ], 'GlobalClusterMember' => [ 'base' => '

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

', 'refs' => [ 'GlobalClusterMemberList$member' => NULL, ], ], 'GlobalClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalCluster$GlobalClusterMembers' => '

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

', ], ], 'GlobalClusterNotFoundFault' => [ 'base' => '

', 'refs' => [], ], 'GlobalClusterQuotaExceededFault' => [ 'base' => '

', 'refs' => [], ], 'GlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'IPRange' => [ 'base' => '

This data type is used as a response element in the DescribeDBSecurityGroups action.

', 'refs' => [ 'IPRangeList$member' => NULL, ], ], 'IPRangeList' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroup$IPRanges' => '

Contains a list of IPRange elements.

', ], ], 'InstanceQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB instances.

', 'refs' => [], ], 'InsufficientDBClusterCapacityFault' => [ 'base' => '

The DB cluster doesn\'t have enough capacity for the current operation.

', 'refs' => [], ], 'InsufficientDBInstanceCapacityFault' => [ 'base' => '

The specified DB instance class isn\'t available in the specified Availability Zone.

', 'refs' => [], ], 'InsufficientStorageClusterCapacityFault' => [ 'base' => '

There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshot$AllocatedStorage' => '

Specifies the allocated storage size in gibibytes (GiB).

', 'DBClusterSnapshot$Port' => '

Specifies the port that the DB cluster was listening on at the time of the snapshot.

', 'DBClusterSnapshot$PercentProgress' => '

Specifies the percentage of the estimated data that has been transferred.

', 'DBInstance$AllocatedStorage' => '

Specifies the allocated storage size specified in gibibytes.

', 'DBInstance$BackupRetentionPeriod' => '

Specifies the number of days for which automatic DB snapshots are retained.

', 'DBInstance$DbInstancePort' => '

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

', 'DBInstanceAutomatedBackup$AllocatedStorage' => '

Specifies the allocated storage size in gibibytes (GiB).

', 'DBInstanceAutomatedBackup$Port' => '

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

', 'DBSnapshot$AllocatedStorage' => '

Specifies the allocated storage size in gibibytes (GiB).

', 'DBSnapshot$Port' => '

Specifies the port that the database engine was listening on at the time of the snapshot.

', 'DBSnapshot$PercentProgress' => '

The percentage of the estimated data that has been transferred.

', 'DownloadDBLogFilePortionMessage$NumberOfLines' => '

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

  • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

  • If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.

  • If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

  • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

', 'Endpoint$Port' => '

Specifies the port that the database engine is listening on.

', 'Range$From' => '

The minimum value in the range.

', 'Range$To' => '

The maximum value in the range.

', 'ReservedDBInstance$Duration' => '

The duration of the reservation in seconds.

', 'ReservedDBInstance$DBInstanceCount' => '

The number of reserved DB instances.

', 'ReservedDBInstancesOffering$Duration' => '

The duration of the offering in seconds.

', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

', 'CreateDBClusterMessage$Port' => '

The port number on which the instances in the DB cluster accept connections.

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

', 'CreateDBInstanceMessage$AllocatedStorage' => '

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 16384.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 16384.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 16384.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

', 'CreateDBInstanceMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Can\'t be set to 0 if the DB instance is a source to Read Replicas

', 'CreateDBInstanceMessage$Port' => '

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

Type: Integer

', 'CreateDBInstanceMessage$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.

', 'CreateDBInstanceMessage$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

', 'CreateDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

', 'CreateDBInstanceMessage$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'CreateDBInstanceReadReplicaMessage$Port' => '

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

', 'CreateDBInstanceReadReplicaMessage$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

', 'CreateDBInstanceReadReplicaMessage$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

', 'CreateDBInstanceReadReplicaMessage$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'DBCluster$AllocatedStorage' => '

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

', 'DBCluster$BackupRetentionPeriod' => '

Specifies the number of days for which automatic DB snapshots are retained.

', 'DBCluster$Port' => '

Specifies the port that the database engine is listening on.

', 'DBCluster$Capacity' => '

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'DBClusterCapacityInfo$PendingCapacity' => '

A value that specifies the capacity that the DB cluster scales to next.

', 'DBClusterCapacityInfo$CurrentCapacity' => '

The current capacity of the DB cluster.

', 'DBClusterCapacityInfo$SecondsBeforeTimeout' => '

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

', 'DBClusterMember$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

', 'DBInstance$Iops' => '

Specifies the Provisioned IOPS (I/O operations per second) value.

', 'DBInstance$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

', 'DBInstance$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

', 'DBInstance$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'DBInstanceAutomatedBackup$Iops' => '

The IOPS (I/O operations per second) value for the automated backup.

', 'DBSnapshot$Iops' => '

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

', 'DescribeCertificatesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterBacktracksMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterEndpointsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterParameterGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterSnapshotsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBEngineVersionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBInstanceAutomatedBackupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

', 'DescribeDBInstancesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBLogFilesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

', 'DescribeDBParameterGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSecurityGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSnapshotsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSubnetGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEngineDefaultClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEngineDefaultParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventSubscriptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventsMessage$Duration' => '

The number of minutes to retrieve events for.

Default: 60

', 'DescribeEventsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeGlobalClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeOptionGroupOptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeOptionGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeOrderableDBInstanceOptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribePendingMaintenanceActionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeReservedDBInstancesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeReservedDBInstancesOfferingsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeSourceRegionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'ModifyCurrentDBClusterCapacityMessage$Capacity' => '

The DB cluster capacity.

Constraints:

  • Value must be 2, 4, 8, 16, 32, 64, 128, or 256.

', 'ModifyCurrentDBClusterCapacityMessage$SecondsBeforeTimeout' => '

The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

  • Value must be from 10 through 600.

', 'ModifyDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

', 'ModifyDBClusterMessage$Port' => '

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

', 'ModifyDBInstanceMessage$AllocatedStorage' => '

The new amount of storage (in gibibytes) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

', 'ModifyDBInstanceMessage$BackupRetentionPeriod' => '

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35

  • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 or later

  • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5

  • Can\'t be set to 0 if the DB instance is a source to Read Replicas

', 'ModifyDBInstanceMessage$Iops' => '

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn\'t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

', 'ModifyDBInstanceMessage$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

', 'ModifyDBInstanceMessage$DBPortNumber' => '

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid Values: 1150-65535

MariaDB

Default: 3306

Valid Values: 1150-65535

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

', 'ModifyDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

', 'ModifyDBInstanceMessage$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'Option$Port' => '

If required, the port configured for this option to use.

', 'OptionConfiguration$Port' => '

The optional port for the option.

', 'OptionGroupOption$DefaultPort' => '

If the option requires a port, specifies the default port for the option.

', 'OrderableDBInstanceOption$MinStorageSize' => '

Minimum storage size for a DB instance.

', 'OrderableDBInstanceOption$MaxStorageSize' => '

Maximum storage size for a DB instance.

', 'OrderableDBInstanceOption$MinIopsPerDbInstance' => '

Minimum total provisioned IOPS for a DB instance.

', 'OrderableDBInstanceOption$MaxIopsPerDbInstance' => '

Maximum total provisioned IOPS for a DB instance.

', 'PendingModifiedValues$AllocatedStorage' => '

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

', 'PendingModifiedValues$Port' => '

Specifies the pending port for the DB instance.

', 'PendingModifiedValues$BackupRetentionPeriod' => '

Specifies the pending number of days for which automated backups are retained.

', 'PendingModifiedValues$Iops' => '

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

', 'PromoteReadReplicaMessage$BackupRetentionPeriod' => '

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 8

', 'PurchaseReservedDBInstancesOfferingMessage$DBInstanceCount' => '

The number of instances to reserve.

Default: 1

', 'Range$Step' => '

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn\'t a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

', 'RestoreDBClusterFromS3Message$BackupRetentionPeriod' => '

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

', 'RestoreDBClusterFromS3Message$Port' => '

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

', 'RestoreDBClusterFromSnapshotMessage$Port' => '

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$Port' => '

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

', 'RestoreDBInstanceFromDBSnapshotMessage$Port' => '

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

', 'RestoreDBInstanceFromDBSnapshotMessage$Iops' => '

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

', 'RestoreDBInstanceFromS3Message$AllocatedStorage' => '

The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

', 'RestoreDBInstanceFromS3Message$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

', 'RestoreDBInstanceFromS3Message$Port' => '

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

', 'RestoreDBInstanceFromS3Message$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

', 'RestoreDBInstanceFromS3Message$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: 0

', 'RestoreDBInstanceFromS3Message$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'RestoreDBInstanceToPointInTimeMessage$Port' => '

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

', 'ScalingConfiguration$MinCapacity' => '

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

', 'ScalingConfiguration$MaxCapacity' => '

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

', 'ScalingConfiguration$SecondsUntilAutoPause' => '

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

', 'ScalingConfigurationInfo$MinCapacity' => '

The maximum capacity for the Aurora DB cluster in serverless DB engine mode.

', 'ScalingConfigurationInfo$MaxCapacity' => '

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

', 'ScalingConfigurationInfo$SecondsUntilAutoPause' => '

The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it\'s idle (it has no connections).

', ], ], 'InvalidDBClusterCapacityFault' => [ 'base' => '

Capacity isn\'t a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

', 'refs' => [], ], 'InvalidDBClusterEndpointStateFault' => [ 'base' => '

The requested operation can\'t be performed on the endpoint while the endpoint is in this state.

', 'refs' => [], ], 'InvalidDBClusterSnapshotStateFault' => [ 'base' => '

The supplied value isn\'t a valid DB cluster snapshot state.

', 'refs' => [], ], 'InvalidDBClusterStateFault' => [ 'base' => '

The requested operation can\'t be performed while the cluster is in this state.

', 'refs' => [], ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'base' => '

The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

', 'refs' => [], ], 'InvalidDBInstanceStateFault' => [ 'base' => '

The DB instance isn\'t in a valid state.

', 'refs' => [], ], 'InvalidDBParameterGroupStateFault' => [ 'base' => '

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can\'t delete it when the parameter group is in this state.

', 'refs' => [], ], 'InvalidDBSecurityGroupStateFault' => [ 'base' => '

The state of the DB security group doesn\'t allow deletion.

', 'refs' => [], ], 'InvalidDBSnapshotStateFault' => [ 'base' => '

The state of the DB snapshot doesn\'t allow deletion.

', 'refs' => [], ], 'InvalidDBSubnetGroupFault' => [ 'base' => '

The DBSubnetGroup doesn\'t belong to the same VPC as that of an existing cross-region read replica of the same source instance.

', 'refs' => [], ], 'InvalidDBSubnetGroupStateFault' => [ 'base' => '

The DB subnet group cannot be deleted because it\'s in use.

', 'refs' => [], ], 'InvalidDBSubnetStateFault' => [ 'base' => '

The DB subnet isn\'t in the available state.

', 'refs' => [], ], 'InvalidEventSubscriptionStateFault' => [ 'base' => '

This error can occur if someone else is modifying a subscription. You should retry the action.

', 'refs' => [], ], 'InvalidGlobalClusterStateFault' => [ 'base' => '

', 'refs' => [], ], 'InvalidOptionGroupStateFault' => [ 'base' => '

The option group isn\'t in the available state.

', 'refs' => [], ], 'InvalidRestoreFault' => [ 'base' => '

Cannot restore from VPC backup to non-VPC DB instance.

', 'refs' => [], ], 'InvalidS3BucketFault' => [ 'base' => '

The specified Amazon S3 bucket name can\'t be found or Amazon RDS isn\'t authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

', 'refs' => [], ], 'InvalidSubnet' => [ 'base' => '

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

', 'refs' => [], ], 'InvalidVPCNetworkStateFault' => [ 'base' => '

The DB subnet group doesn\'t cover all Availability Zones after it\'s created because of users\' change.

', 'refs' => [], ], 'KMSKeyNotAccessibleFault' => [ 'base' => '

An error occurred accessing an AWS KMS key.

', 'refs' => [], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'RemoveTagsFromResourceMessage$TagKeys' => '

The tag key (name) of the tag to be removed.

', ], ], 'ListTagsForResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'LogTypeList' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsExportConfiguration$EnableLogTypes' => '

The list of log types to enable.

', 'CloudwatchLogsExportConfiguration$DisableLogTypes' => '

The list of log types to disable.

', 'CreateDBClusterMessage$EnableCloudwatchLogsExports' => '

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'CreateDBInstanceMessage$EnableCloudwatchLogsExports' => '

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.

', 'CreateDBInstanceReadReplicaMessage$EnableCloudwatchLogsExports' => '

The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', 'DBCluster$EnabledCloudwatchLogsExports' => '

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

', 'DBEngineVersion$ExportableLogTypes' => '

The types of logs that the database engine has available for export to CloudWatch Logs.

', 'DBInstance$EnabledCloudwatchLogsExports' => '

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

', 'PendingCloudwatchLogsExports$LogTypesToEnable' => '

Log types that are in the process of being deactivated. After they are deactivated, these log types aren\'t exported to CloudWatch Logs.

', 'PendingCloudwatchLogsExports$LogTypesToDisable' => '

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

', 'RestoreDBClusterFromS3Message$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBInstanceFromDBSnapshotMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBInstanceFromS3Message$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', 'RestoreDBInstanceToPointInTimeMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AccountQuota$Used' => '

The amount currently used toward the quota maximum.

', 'AccountQuota$Max' => '

The maximum allowed value for the quota.

', 'DescribeDBLogFilesDetails$LastWritten' => '

A POSIX timestamp when the last log entry was written.

', 'DescribeDBLogFilesDetails$Size' => '

The size, in bytes, of the log file for the specified DB instance.

', 'DescribeDBLogFilesMessage$FileLastWritten' => '

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

', 'DescribeDBLogFilesMessage$FileSize' => '

Filters the available log files for files larger than the specified size.

', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'DBCluster$BacktrackWindow' => '

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

', 'DBCluster$BacktrackConsumedChangeRecords' => '

The number of change records stored for Backtrack.

', 'ModifyDBClusterMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'RestoreDBClusterFromS3Message$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'RestoreDBClusterFromSnapshotMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'RestoreDBClusterToPointInTimeMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', ], ], 'MinimumEngineVersionPerAllowedValue' => [ 'base' => '

The minimum DB engine version required for each corresponding allowed value for an option setting.

', 'refs' => [ 'MinimumEngineVersionPerAllowedValueList$member' => NULL, ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOptionSetting$MinimumEngineVersionPerAllowedValue' => '

The minimum DB engine version required for the corresponding allowed value for this option setting.

', ], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSnapshotAttributeMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'Option' => [ 'base' => '

Option details.

', 'refs' => [ 'OptionsList$member' => NULL, ], ], 'OptionConfiguration' => [ 'base' => '

A list of all available options

', 'refs' => [ 'OptionConfigurationList$member' => NULL, ], ], 'OptionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToInclude' => '

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

', ], ], 'OptionGroup' => [ 'base' => '

', 'refs' => [ 'CopyOptionGroupResult$OptionGroup' => NULL, 'CreateOptionGroupResult$OptionGroup' => NULL, 'ModifyOptionGroupResult$OptionGroup' => NULL, 'OptionGroupsList$member' => NULL, ], ], 'OptionGroupAlreadyExistsFault' => [ 'base' => '

The option group you are trying to create already exists.

', 'refs' => [], ], 'OptionGroupMembership' => [ 'base' => '

Provides information on the option groups the DB instance is a member of.

', 'refs' => [ 'OptionGroupMembershipList$member' => NULL, ], ], 'OptionGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$OptionGroupMemberships' => '

Provides the list of option group memberships for this DB instance.

', ], ], 'OptionGroupNotFoundFault' => [ 'base' => '

The specified option group could not be found.

', 'refs' => [], ], 'OptionGroupOption' => [ 'base' => '

Available option.

', 'refs' => [ 'OptionGroupOptionsList$member' => NULL, ], ], 'OptionGroupOptionSetting' => [ 'base' => '

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

', 'refs' => [ 'OptionGroupOptionSettingsList$member' => NULL, ], ], 'OptionGroupOptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionSettings' => '

The option settings that are available (and the default value) for each option in an option group.

', ], ], 'OptionGroupOptionVersionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionVersions' => '

The versions that are available for the option.

', ], ], 'OptionGroupOptionsList' => [ 'base' => '

List of available option group options.

', 'refs' => [ 'OptionGroupOptionsMessage$OptionGroupOptions' => NULL, ], ], 'OptionGroupOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'OptionGroupQuotaExceededFault' => [ 'base' => '

The quota of 20 option groups was exceeded for this AWS account.

', 'refs' => [], ], 'OptionGroups' => [ 'base' => '

List of option groups.

', 'refs' => [], ], 'OptionGroupsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroups$OptionGroupsList' => '

List of option groups.

', ], ], 'OptionNamesList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToRemove' => '

Options in this list are removed from the option group.

', ], ], 'OptionSetting' => [ 'base' => '

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

', 'refs' => [ 'OptionSettingConfigurationList$member' => NULL, 'OptionSettingsList$member' => NULL, ], ], 'OptionSettingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Option$OptionSettings' => '

The option settings for this option.

', ], ], 'OptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionConfiguration$OptionSettings' => '

The option settings to include in an option group.

', ], ], 'OptionVersion' => [ 'base' => '

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

', 'refs' => [ 'OptionGroupOptionVersionsList$member' => NULL, ], ], 'OptionsConflictsWith' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionsConflictsWith' => '

The options that conflict with this option.

', ], ], 'OptionsDependedOn' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionsDependedOn' => '

The options that are prerequisites for this option.

', ], ], 'OptionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroup$Options' => '

Indicates what options are available in the option group.

', ], ], 'OrderableDBInstanceOption' => [ 'base' => '

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

', 'refs' => [ 'OrderableDBInstanceOptionsList$member' => NULL, ], ], 'OrderableDBInstanceOptionsList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions' => '

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

', 'refs' => [], ], 'Parameter' => [ 'base' => '

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

', 'refs' => [ 'ParametersList$member' => NULL, ], ], 'ParametersList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupDetails$Parameters' => '

Provides a list of parameters for the DB cluster parameter group.

', 'DBParameterGroupDetails$Parameters' => '

A list of Parameter values.

', 'EngineDefaults$Parameters' => '

Contains a list of engine default parameters.

', 'ModifyDBClusterParameterGroupMessage$Parameters' => '

A list of parameters in the DB cluster parameter group to modify.

', 'ModifyDBParameterGroupMessage$Parameters' => '

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

', 'ResetDBClusterParameterGroupMessage$Parameters' => '

A list of parameter names in the DB cluster parameter group to reset to the default values. You can\'t use this parameter if the ResetAllParameters parameter is set to true.

', 'ResetDBParameterGroupMessage$Parameters' => '

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

', ], ], 'PendingCloudwatchLogsExports' => [ 'base' => '

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

', 'refs' => [ 'PendingModifiedValues$PendingCloudwatchLogsExports' => NULL, ], ], 'PendingMaintenanceAction' => [ 'base' => '

Provides information about a pending maintenance action for a resource.

', 'refs' => [ 'PendingMaintenanceActionDetails$member' => NULL, ], ], 'PendingMaintenanceActionDetails' => [ 'base' => NULL, 'refs' => [ 'ResourcePendingMaintenanceActions$PendingMaintenanceActionDetails' => '

A list that provides details about the pending maintenance actions for the resource.

', ], ], 'PendingMaintenanceActions' => [ 'base' => NULL, 'refs' => [ 'PendingMaintenanceActionsMessage$PendingMaintenanceActions' => '

A list of the pending maintenance actions for the resource.

', ], ], 'PendingMaintenanceActionsMessage' => [ 'base' => '

Data returned from the DescribePendingMaintenanceActions action.

', 'refs' => [], ], 'PendingModifiedValues' => [ 'base' => '

This data type is used as a response element in the ModifyDBInstance action.

', 'refs' => [ 'DBInstance$PendingModifiedValues' => '

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

', ], ], 'PointInTimeRestoreNotEnabledFault' => [ 'base' => '

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

', 'refs' => [], ], 'ProcessorFeature' => [ 'base' => '

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

', 'refs' => [ 'ProcessorFeatureList$member' => NULL, ], ], 'ProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'CreateDBInstanceReadReplicaMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'DBInstance$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'DBSnapshot$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

', 'ModifyDBInstanceMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'PendingModifiedValues$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'RestoreDBInstanceFromDBSnapshotMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'RestoreDBInstanceFromS3Message$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'PromoteReadReplicaDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'PromoteReadReplicaMessage' => [ 'base' => '

', 'refs' => [], ], 'PromoteReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'base' => '

Provisioned IOPS not available in the specified Availability Zone.

', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'base' => '

', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'base' => NULL, 'refs' => [], ], 'Range' => [ 'base' => '

A range of integer values.

', 'refs' => [ 'RangeList$member' => NULL, ], ], 'RangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$StorageSize' => '

The valid range of storage in gibibytes. For example, 100 to 16384.

', 'ValidStorageOptions$ProvisionedIops' => '

The valid range of provisioned IOPS. For example, 1000-20000.

', ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$ReadReplicaDBClusterIdentifiers' => '

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Currently, each RDS DB instance can have only one Aurora Read Replica.

', ], ], 'ReadReplicaDBInstanceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$ReadReplicaDBInstanceIdentifiers' => '

Contains one or more identifiers of the Read Replicas associated with this DB instance.

', ], ], 'ReadReplicaIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ReadReplicaIdentifiers' => '

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

', ], ], 'ReadersArnList' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$Readers' => '

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

', ], ], 'RebootDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'RebootDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RecurringCharge' => [ 'base' => '

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstance$RecurringCharges' => '

The recurring price charged to run this reserved DB instance.

', 'ReservedDBInstancesOffering$RecurringCharges' => '

The recurring price charged to run this reserved DB instance.

', ], ], 'RemoveFromGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'ReservedDBInstance' => [ 'base' => '

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

', 'refs' => [ 'PurchaseReservedDBInstancesOfferingResult$ReservedDBInstance' => NULL, 'ReservedDBInstanceList$member' => NULL, ], ], 'ReservedDBInstanceAlreadyExistsFault' => [ 'base' => '

User already has a reservation with the given identifier.

', 'refs' => [], ], 'ReservedDBInstanceList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstanceMessage$ReservedDBInstances' => '

A list of reserved DB instances.

', ], ], 'ReservedDBInstanceMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

', 'refs' => [], ], 'ReservedDBInstanceNotFoundFault' => [ 'base' => '

The specified reserved DB Instance not found.

', 'refs' => [], ], 'ReservedDBInstanceQuotaExceededFault' => [ 'base' => '

Request would exceed the user\'s DB Instance quota.

', 'refs' => [], ], 'ReservedDBInstancesOffering' => [ 'base' => '

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

', 'refs' => [ 'ReservedDBInstancesOfferingList$member' => NULL, ], ], 'ReservedDBInstancesOfferingList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferings' => '

A list of reserved DB instance offerings.

', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

', 'refs' => [], ], 'ReservedDBInstancesOfferingNotFoundFault' => [ 'base' => '

Specified offering does not exist.

', 'refs' => [], ], 'ResetDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ResetDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ResourceNotFoundFault' => [ 'base' => '

The specified resource ID was not found.

', 'refs' => [], ], 'ResourcePendingMaintenanceActions' => [ 'base' => '

Describes the pending maintenance actions for a resource.

', 'refs' => [ 'ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions' => NULL, 'PendingMaintenanceActions$member' => NULL, ], ], 'RestoreDBClusterFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBClusterFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBClusterToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreWindow' => [ 'base' => '

Earliest and latest time an instance can be restored to:

', 'refs' => [ 'DBInstanceAutomatedBackup$RestoreWindow' => '

Earliest and latest time an instance can be restored to.

', ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'base' => '

', 'refs' => [], ], 'RevokeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'SNSInvalidTopicFault' => [ 'base' => '

SNS has responded that there is a problem with the SND topic specified.

', 'refs' => [], ], 'SNSNoAuthorizationFault' => [ 'base' => '

You do not have permission to publish to the SNS topic ARN.

', 'refs' => [], ], 'SNSTopicArnNotFoundFault' => [ 'base' => '

The SNS topic ARN does not exist.

', 'refs' => [], ], 'ScalingConfiguration' => [ 'base' => '

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'refs' => [ 'CreateDBClusterMessage$ScalingConfiguration' => '

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

', 'ModifyDBClusterMessage$ScalingConfiguration' => '

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

', 'RestoreDBClusterFromSnapshotMessage$ScalingConfiguration' => '

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

', ], ], 'ScalingConfigurationInfo' => [ 'base' => '

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'refs' => [ 'DBCluster$ScalingConfigurationInfo' => NULL, ], ], 'SharedSnapshotQuotaExceededFault' => [ 'base' => '

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

', 'refs' => [], ], 'SnapshotQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB snapshots.

', 'refs' => [], ], 'SourceIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$SourceIds' => '

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are supplied, SourceType must also be provided.

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

', 'EventSubscription$SourceIdsList' => '

A list of source IDs for the RDS event notification subscription.

', ], ], 'SourceNotFoundFault' => [ 'base' => '

The requested source could not be found.

', 'refs' => [], ], 'SourceRegion' => [ 'base' => '

Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.

', 'refs' => [ 'SourceRegionList$member' => NULL, ], ], 'SourceRegionList' => [ 'base' => NULL, 'refs' => [ 'SourceRegionMessage$SourceRegions' => '

A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.

', ], ], 'SourceRegionMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeSourceRegions action.

', 'refs' => [], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'DescribeEventsMessage$SourceType' => '

The event source to retrieve events for. If no value is specified, all events are returned.

', 'Event$SourceType' => '

Specifies the source type for this event.

', ], ], 'StartDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

', 'refs' => [], ], 'StorageTypeNotSupportedFault' => [ 'base' => '

Storage of the StorageType specified can\'t be associated with the DB instance.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccountQuota$AccountQuotaName' => '

The name of the Amazon RDS quota for this AWS account.

', 'AddRoleToDBClusterMessage$DBClusterIdentifier' => '

The name of the DB cluster to associate the IAM role with.

', 'AddRoleToDBClusterMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

', 'AddRoleToDBInstanceMessage$DBInstanceIdentifier' => '

The name of the DB instance to associate the IAM role with.

', 'AddRoleToDBInstanceMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

', 'AddRoleToDBInstanceMessage$FeatureName' => '

The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.

', 'AddSourceIdentifierToSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to add a source identifier to.

', 'AddSourceIdentifierToSubscriptionMessage$SourceIdentifier' => '

The identifier of the event source to be added.

Constraints:

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

', 'AddTagsToResourceMessage$ResourceName' => '

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

', 'ApplyPendingMaintenanceActionMessage$ResourceIdentifier' => '

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

', 'ApplyPendingMaintenanceActionMessage$ApplyAction' => '

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

', 'ApplyPendingMaintenanceActionMessage$OptInType' => '

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can\'t be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

', 'AttributeValueList$member' => NULL, 'AuthorizeDBSecurityGroupIngressMessage$DBSecurityGroupName' => '

The name of the DB security group to add authorization to.

', 'AuthorizeDBSecurityGroupIngressMessage$CIDRIP' => '

The IP range to authorize.

', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName' => '

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupId' => '

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => '

AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'AvailabilityZone$Name' => '

The name of the Availability Zone.

', 'AvailabilityZones$member' => NULL, 'AvailableProcessorFeature$Name' => '

The name of the processor feature. Valid names are coreCount and threadsPerCore.

', 'AvailableProcessorFeature$DefaultValue' => '

The default value for the processor feature of the DB instance class.

', 'AvailableProcessorFeature$AllowedValues' => '

The allowed values for the processor feature of the DB instance class.

', 'BacktrackDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'Certificate$CertificateIdentifier' => '

The unique key that identifies a certificate.

', 'Certificate$CertificateType' => '

The type of the certificate.

', 'Certificate$Thumbprint' => '

The thumbprint of the certificate.

', 'Certificate$CertificateArn' => '

The Amazon Resource Name (ARN) for the certificate.

', 'CertificateMessage$Marker' => '

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'CharacterSet$CharacterSetName' => '

The name of the character set.

', 'CharacterSet$CharacterSetDescription' => '

The description of the character set.

', 'CopyDBClusterParameterGroupMessage$SourceDBClusterParameterGroupIdentifier' => '

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

Constraints:

  • Must specify a valid DB cluster parameter group.

  • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

  • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupIdentifier' => '

The identifier for the copied DB cluster parameter group.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster-param-group1

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupDescription' => '

A description for the copied DB cluster parameter group.

', 'CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier' => '

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

You can\'t copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

Constraints:

  • Must specify a valid system snapshot in the "available" state.

  • If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

', 'CopyDBClusterSnapshotMessage$TargetDBClusterSnapshotIdentifier' => '

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

', 'CopyDBClusterSnapshotMessage$KmsKeyId' => '

The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don\'t specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can\'t use encryption keys from one AWS Region in another AWS Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

', 'CopyDBClusterSnapshotMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.

The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier' => '

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid DB parameter group.

  • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

', 'CopyDBParameterGroupMessage$TargetDBParameterGroupIdentifier' => '

The identifier for the copied DB parameter group.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

', 'CopyDBParameterGroupMessage$TargetDBParameterGroupDescription' => '

A description for the copied DB parameter group.

', 'CopyDBSnapshotMessage$SourceDBSnapshotIdentifier' => '

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

  • Must specify a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

', 'CopyDBSnapshotMessage$TargetDBSnapshotIdentifier' => '

The identifier for the copy of the snapshot.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

', 'CopyDBSnapshotMessage$KmsKeyId' => '

The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don\'t specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can\'t use encryption keys from one AWS Region in another AWS Region.

', 'CopyDBSnapshotMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CopyDBSnapshotMessage$OptionGroupName' => '

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

', 'CopyOptionGroupMessage$SourceOptionGroupIdentifier' => '

The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid option group.

  • If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

  • If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

', 'CopyOptionGroupMessage$TargetOptionGroupIdentifier' => '

The identifier for the copied option group.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-option-group

', 'CopyOptionGroupMessage$TargetOptionGroupDescription' => '

The description for the copied option group.

', 'CreateDBClusterEndpointMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

', 'CreateDBClusterEndpointMessage$DBClusterEndpointIdentifier' => '

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

', 'CreateDBClusterEndpointMessage$EndpointType' => '

The type of the endpoint. One of: READER, ANY.

', 'CreateDBClusterMessage$CharacterSetName' => '

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

', 'CreateDBClusterMessage$DatabaseName' => '

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

', 'CreateDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'CreateDBClusterMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.

', 'CreateDBClusterMessage$DBSubnetGroupName' => '

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'CreateDBClusterMessage$Engine' => '

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

', 'CreateDBClusterMessage$EngineVersion' => '

The version number of the database engine to use.

Aurora MySQL

Example: 5.6.10a, 5.7.12

Aurora PostgreSQL

Example: 9.6.3

', 'CreateDBClusterMessage$MasterUsername' => '

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'CreateDBClusterMessage$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'CreateDBClusterMessage$OptionGroupName' => '

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options can\'t be removed from an option group. The option group can\'t be removed from a DB cluster once it is associated with a DB cluster.

', 'CreateDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'CreateDBClusterMessage$ReplicationSourceIdentifier' => '

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

', 'CreateDBClusterMessage$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS will use your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

', 'CreateDBClusterMessage$PreSignedUrl' => '

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CreateDBClusterMessage$EngineMode' => '

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.

', 'CreateDBClusterMessage$GlobalClusterIdentifier' => '

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

', 'CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

', 'CreateDBClusterParameterGroupMessage$DBParameterGroupFamily' => '

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7

Aurora PostgreSQL

Example: aurora-postgresql9.6

', 'CreateDBClusterParameterGroupMessage$Description' => '

The description for the DB cluster parameter group.

', 'CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

', 'CreateDBClusterSnapshotMessage$DBClusterIdentifier' => '

The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster1

', 'CreateDBInstanceMessage$DBName' => '

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can\'t be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can\'t be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can\'t be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can\'t specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can\'t be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can\'t be a word reserved by the specified database engine

', 'CreateDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'CreateDBInstanceMessage$DBInstanceClass' => '

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

', 'CreateDBInstanceMessage$Engine' => '

The name of the database engine to be used for this instance.

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

', 'CreateDBInstanceMessage$MasterUsername' => '

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

  • Can\'t be a reserved word for the chosen database engine.

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'CreateDBInstanceMessage$MasterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

', 'CreateDBInstanceMessage$AvailabilityZone' => '

The EC2 Availability Zone that the DB instance is created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint\'s AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can\'t be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

', 'CreateDBInstanceMessage$DBSubnetGroupName' => '

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

', 'CreateDBInstanceMessage$PreferredMaintenanceWindow' => '

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

Format: ddd:hh24:mi-ddd:hh24:mi

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.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'CreateDBInstanceMessage$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'CreateDBInstanceMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateDBInstanceMessage$EngineVersion' => '

The version number of the database engine to use.

For a list of valid engine versions, call DescribeDBEngineVersions.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

', 'CreateDBInstanceMessage$LicenseModel' => '

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

', 'CreateDBInstanceMessage$OptionGroupName' => '

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'CreateDBInstanceMessage$CharacterSetName' => '

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

', 'CreateDBInstanceMessage$DBClusterIdentifier' => '

The identifier of the DB cluster that the instance will belong to.

For information on creating a DB cluster, see CreateDBCluster.

Type: String

', 'CreateDBInstanceMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'CreateDBInstanceMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'CreateDBInstanceMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'CreateDBInstanceMessage$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

', 'CreateDBInstanceMessage$Domain' => '

Specify the Active Directory Domain to create the instance in.

', 'CreateDBInstanceMessage$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'CreateDBInstanceMessage$DomainIAMRoleName' => '

Specify the name of the IAM role to be used when making API calls to the Directory Service.

', 'CreateDBInstanceMessage$Timezone' => '

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

', 'CreateDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier' => '

The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

', 'CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier' => '

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.

  • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.

  • Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.

  • If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

', 'CreateDBInstanceReadReplicaMessage$DBInstanceClass' => '

The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

', 'CreateDBInstanceReadReplicaMessage$AvailabilityZone' => '

The Amazon EC2 Availability Zone that the Read Replica is created in.

Default: A random, system-chosen Availability Zone in the endpoint\'s AWS Region.

Example: us-east-1d

', 'CreateDBInstanceReadReplicaMessage$OptionGroupName' => '

The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.

', 'CreateDBInstanceReadReplicaMessage$DBSubnetGroupName' => '

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

  • If supplied, must match the name of an existing DBSubnetGroup.

  • The specified DB subnet group must be in the same AWS Region in which the operation is running.

  • All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

    • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

', 'CreateDBInstanceReadReplicaMessage$StorageType' => '

Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'CreateDBInstanceReadReplicaMessage$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'CreateDBInstanceReadReplicaMessage$KmsKeyId' => '

The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can\'t use encryption keys from one AWS Region in another AWS Region.

You can\'t create an encrypted Read Replica from an unencrypted DB instance.

', 'CreateDBInstanceReadReplicaMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'CreateDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

', 'CreateDBParameterGroupMessage$DBParameterGroupFamily' => '

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

To list all of the available parameter group families, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

The output contains duplicates.

', 'CreateDBParameterGroupMessage$Description' => '

The description for the DB parameter group.

', 'CreateDBSecurityGroupMessage$DBSecurityGroupName' => '

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

  • Must not be "Default"

Example: mysecuritygroup

', 'CreateDBSecurityGroupMessage$DBSecurityGroupDescription' => '

The description for the DB security group.

', 'CreateDBSnapshotMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

', 'CreateDBSnapshotMessage$DBInstanceIdentifier' => '

The identifier of the DB instance that you want to create the snapshot of.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'CreateDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

', 'CreateDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the DB subnet group.

', 'CreateEventSubscriptionMessage$SubscriptionName' => '

The name of the subscription.

Constraints: The name must be less than 255 characters.

', 'CreateEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

', 'CreateEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

', 'CreateGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the new global database cluster.

', 'CreateGlobalClusterMessage$SourceDBClusterIdentifier' => '

The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

', 'CreateGlobalClusterMessage$Engine' => '

Provides the name of the database engine to be used for this DB cluster.

', 'CreateGlobalClusterMessage$EngineVersion' => '

The engine version of the Aurora global database.

', 'CreateGlobalClusterMessage$DatabaseName' => '

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

', 'CreateOptionGroupMessage$OptionGroupName' => '

Specifies the name of the option group to be created.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup

', 'CreateOptionGroupMessage$EngineName' => '

Specifies the name of the engine that this option group should be associated with.

', 'CreateOptionGroupMessage$MajorEngineVersion' => '

Specifies the major version of the engine that this option group should be associated with.

', 'CreateOptionGroupMessage$OptionGroupDescription' => '

The description of the option group.

', 'DBCluster$CharacterSetName' => '

If present, specifies the name of the character set that this cluster is associated with.

', 'DBCluster$DatabaseName' => '

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

', 'DBCluster$DBClusterIdentifier' => '

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

', 'DBCluster$DBClusterParameterGroup' => '

Specifies the name of the DB cluster parameter group for the DB cluster.

', 'DBCluster$DBSubnetGroup' => '

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

', 'DBCluster$Status' => '

Specifies the current state of this DB cluster.

', 'DBCluster$PercentProgress' => '

Specifies the progress of the operation as a percentage.

', 'DBCluster$Endpoint' => '

Specifies the connection endpoint for the primary instance of the DB cluster.

', 'DBCluster$ReaderEndpoint' => '

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

', 'DBCluster$Engine' => '

Provides the name of the database engine to be used for this DB cluster.

', 'DBCluster$EngineVersion' => '

Indicates the database engine version.

', 'DBCluster$MasterUsername' => '

Contains the master username for the DB cluster.

', 'DBCluster$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBCluster$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBCluster$ReplicationSourceIdentifier' => '

Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

', 'DBCluster$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'DBCluster$KmsKeyId' => '

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

', 'DBCluster$DbClusterResourceId' => '

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

', 'DBCluster$DBClusterArn' => '

The Amazon Resource Name (ARN) for the DB cluster.

', 'DBCluster$CloneGroupId' => '

Identifies the clone group to which the DB cluster is associated.

', 'DBCluster$EngineMode' => '

The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.

', 'DBClusterBacktrack$DBClusterIdentifier' => '

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

', 'DBClusterBacktrack$BacktrackIdentifier' => '

Contains the backtrack identifier.

', 'DBClusterBacktrack$Status' => '

The status of the backtrack. This property returns one of the following values:

  • applying - The backtrack is currently being applied to or rolled back from the DB cluster.

  • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

  • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

  • pending - The backtrack is currently pending application to or rollback from the DB cluster.

', 'DBClusterBacktrackMessage$Marker' => '

A pagination token that can be used in a subsequent DescribeDBClusterBacktracks request.

', 'DBClusterCapacityInfo$DBClusterIdentifier' => '

A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

', 'DBClusterCapacityInfo$TimeoutAction' => '

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

', 'DBClusterEndpoint$DBClusterEndpointIdentifier' => '

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

', 'DBClusterEndpoint$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

', 'DBClusterEndpoint$DBClusterEndpointResourceIdentifier' => '

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

', 'DBClusterEndpoint$Endpoint' => '

The DNS address of the endpoint.

', 'DBClusterEndpoint$Status' => '

The current status of the endpoint. One of: creating, available, deleting, modifying.

', 'DBClusterEndpoint$EndpointType' => '

The type of the endpoint. One of: READER, WRITER, CUSTOM.

', 'DBClusterEndpoint$CustomEndpointType' => '

The type associated with a custom endpoint. One of: READER, ANY.

', 'DBClusterEndpoint$DBClusterEndpointArn' => '

The Amazon Resource Name (ARN) for the endpoint.

', 'DBClusterEndpointMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterMember$DBInstanceIdentifier' => '

Specifies the instance identifier for this member of the DB cluster.

', 'DBClusterMember$DBClusterParameterGroupStatus' => '

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

', 'DBClusterMessage$Marker' => '

A pagination token that can be used in a subsequent DescribeDBClusters request.

', 'DBClusterOptionGroupStatus$DBClusterOptionGroupName' => '

Specifies the name of the DB cluster option group.

', 'DBClusterOptionGroupStatus$Status' => '

Specifies the status of the DB cluster option group.

', 'DBClusterParameterGroup$DBClusterParameterGroupName' => '

Provides the name of the DB cluster parameter group.

', 'DBClusterParameterGroup$DBParameterGroupFamily' => '

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

', 'DBClusterParameterGroup$Description' => '

Provides the customer-specified description for this DB cluster parameter group.

', 'DBClusterParameterGroup$DBClusterParameterGroupArn' => '

The Amazon Resource Name (ARN) for the DB cluster parameter group.

', 'DBClusterParameterGroupDetails$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DBClusterParameterGroupNameMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

', 'DBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterRole$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

', 'DBClusterRole$Status' => '

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

  • PENDING - the IAM role ARN is being associated with the DB cluster.

  • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

', 'DBClusterRole$FeatureName' => NULL, 'DBClusterSnapshot$DBClusterSnapshotIdentifier' => '

Specifies the identifier for the DB cluster snapshot.

', 'DBClusterSnapshot$DBClusterIdentifier' => '

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

', 'DBClusterSnapshot$Engine' => '

Specifies the name of the database engine.

', 'DBClusterSnapshot$Status' => '

Specifies the status of this DB cluster snapshot.

', 'DBClusterSnapshot$VpcId' => '

Provides the VPC ID associated with the DB cluster snapshot.

', 'DBClusterSnapshot$MasterUsername' => '

Provides the master username for the DB cluster snapshot.

', 'DBClusterSnapshot$EngineVersion' => '

Provides the version of the database engine for this DB cluster snapshot.

', 'DBClusterSnapshot$LicenseModel' => '

Provides the license model information for this DB cluster snapshot.

', 'DBClusterSnapshot$SnapshotType' => '

Provides the type of the DB cluster snapshot.

', 'DBClusterSnapshot$KmsKeyId' => '

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

', 'DBClusterSnapshot$DBClusterSnapshotArn' => '

The Amazon Resource Name (ARN) for the DB cluster snapshot.

', 'DBClusterSnapshot$SourceDBClusterSnapshotArn' => '

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

', 'DBClusterSnapshotAttribute$AttributeName' => '

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

', 'DBClusterSnapshotAttributesResult$DBClusterSnapshotIdentifier' => '

The identifier of the manual DB cluster snapshot that the attributes apply to.

', 'DBClusterSnapshotMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBEngineVersion$Engine' => '

The name of the database engine.

', 'DBEngineVersion$EngineVersion' => '

The version number of the database engine.

', 'DBEngineVersion$DBParameterGroupFamily' => '

The name of the DB parameter group family for the database engine.

', 'DBEngineVersion$DBEngineDescription' => '

The description of the database engine.

', 'DBEngineVersion$DBEngineVersionDescription' => '

The description of the database engine version.

', 'DBEngineVersionMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBInstance$DBInstanceIdentifier' => '

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

', 'DBInstance$DBInstanceClass' => '

Contains the name of the compute and memory capacity class of the DB instance.

', 'DBInstance$Engine' => '

Provides the name of the database engine to be used for this DB instance.

', 'DBInstance$DBInstanceStatus' => '

Specifies the current state of this database.

', 'DBInstance$MasterUsername' => '

Contains the master username for the DB instance.

', 'DBInstance$DBName' => '

The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

', 'DBInstance$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBInstance$AvailabilityZone' => '

Specifies the name of the Availability Zone the DB instance is located in.

', 'DBInstance$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBInstance$EngineVersion' => '

Indicates the database engine version.

', 'DBInstance$ReadReplicaSourceDBInstanceIdentifier' => '

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

', 'DBInstance$LicenseModel' => '

License model information for this DB instance.

', 'DBInstance$CharacterSetName' => '

If present, specifies the name of the character set that this instance is associated with.

', 'DBInstance$SecondaryAvailabilityZone' => '

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

', 'DBInstance$StorageType' => '

Specifies the storage type associated with DB instance.

', 'DBInstance$TdeCredentialArn' => '

The ARN from the key store with which the instance is associated for TDE encryption.

', 'DBInstance$DBClusterIdentifier' => '

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

', 'DBInstance$KmsKeyId' => '

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

', 'DBInstance$DbiResourceId' => '

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

', 'DBInstance$CACertificateIdentifier' => '

The identifier of the CA certificate for this DB instance.

', 'DBInstance$EnhancedMonitoringResourceArn' => '

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

', 'DBInstance$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

', 'DBInstance$DBInstanceArn' => '

The Amazon Resource Name (ARN) for the DB instance.

', 'DBInstance$Timezone' => '

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

', 'DBInstance$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'DBInstanceAutomatedBackup$DBInstanceArn' => '

The Amazon Resource Name (ARN) for the automated backup.

', 'DBInstanceAutomatedBackup$DbiResourceId' => '

The identifier for the source DB instance, which can\'t be changed and which is unique to an AWS Region.

', 'DBInstanceAutomatedBackup$Region' => '

The AWS Region associated with the automated backup.

', 'DBInstanceAutomatedBackup$DBInstanceIdentifier' => '

The customer id of the instance that is/was associated with the automated backup.

', 'DBInstanceAutomatedBackup$Status' => '

Provides a list of status information for an automated backup:

  • active - automated backups for current instances

  • retained - automated backups for deleted instances

  • creating - automated backups that are waiting for the first automated snapshot to be available.

', 'DBInstanceAutomatedBackup$AvailabilityZone' => '

The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

', 'DBInstanceAutomatedBackup$VpcId' => '

Provides the VPC ID associated with the DB instance

', 'DBInstanceAutomatedBackup$MasterUsername' => '

The license model of an automated backup.

', 'DBInstanceAutomatedBackup$Engine' => '

The name of the database engine for this automated backup.

', 'DBInstanceAutomatedBackup$EngineVersion' => '

The version of the database engine for the automated backup.

', 'DBInstanceAutomatedBackup$LicenseModel' => '

License model information for the automated backup.

', 'DBInstanceAutomatedBackup$OptionGroupName' => '

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

', 'DBInstanceAutomatedBackup$TdeCredentialArn' => '

The ARN from the key store with which the automated backup is associated for TDE encryption.

', 'DBInstanceAutomatedBackup$StorageType' => '

Specifies the storage type associated with the automated backup.

', 'DBInstanceAutomatedBackup$KmsKeyId' => '

The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'DBInstanceAutomatedBackup$Timezone' => '

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

', 'DBInstanceAutomatedBackupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DBInstanceMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DBInstanceRole$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

', 'DBInstanceRole$FeatureName' => '

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

', 'DBInstanceRole$Status' => '

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.

  • PENDING - the IAM role ARN is being associated with the DB instance.

  • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.

', 'DBInstanceStatusInfo$StatusType' => '

This value is currently "read replication."

', 'DBInstanceStatusInfo$Status' => '

Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

', 'DBInstanceStatusInfo$Message' => '

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

', 'DBParameterGroup$DBParameterGroupName' => '

Provides the name of the DB parameter group.

', 'DBParameterGroup$DBParameterGroupFamily' => '

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

', 'DBParameterGroup$Description' => '

Provides the customer-specified description for this DB parameter group.

', 'DBParameterGroup$DBParameterGroupArn' => '

The Amazon Resource Name (ARN) for the DB parameter group.

', 'DBParameterGroupDetails$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBParameterGroupNameMessage$DBParameterGroupName' => '

Provides the name of the DB parameter group.

', 'DBParameterGroupStatus$DBParameterGroupName' => '

The name of the DP parameter group.

', 'DBParameterGroupStatus$ParameterApplyStatus' => '

The status of parameter updates.

', 'DBParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBSecurityGroup$OwnerId' => '

Provides the AWS ID of the owner of a specific DB security group.

', 'DBSecurityGroup$DBSecurityGroupName' => '

Specifies the name of the DB security group.

', 'DBSecurityGroup$DBSecurityGroupDescription' => '

Provides the description of the DB security group.

', 'DBSecurityGroup$VpcId' => '

Provides the VpcId of the DB security group.

', 'DBSecurityGroup$DBSecurityGroupArn' => '

The Amazon Resource Name (ARN) for the DB security group.

', 'DBSecurityGroupMembership$DBSecurityGroupName' => '

The name of the DB security group.

', 'DBSecurityGroupMembership$Status' => '

The status of the DB security group.

', 'DBSecurityGroupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBSecurityGroupNameList$member' => NULL, 'DBSnapshot$DBSnapshotIdentifier' => '

Specifies the identifier for the DB snapshot.

', 'DBSnapshot$DBInstanceIdentifier' => '

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

', 'DBSnapshot$Engine' => '

Specifies the name of the database engine.

', 'DBSnapshot$Status' => '

Specifies the status of this DB snapshot.

', 'DBSnapshot$AvailabilityZone' => '

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

', 'DBSnapshot$VpcId' => '

Provides the VPC ID associated with the DB snapshot.

', 'DBSnapshot$MasterUsername' => '

Provides the master username for the DB snapshot.

', 'DBSnapshot$EngineVersion' => '

Specifies the version of the database engine.

', 'DBSnapshot$LicenseModel' => '

License model information for the restored DB instance.

', 'DBSnapshot$SnapshotType' => '

Provides the type of the DB snapshot.

', 'DBSnapshot$OptionGroupName' => '

Provides the option group name for the DB snapshot.

', 'DBSnapshot$SourceRegion' => '

The AWS Region that the DB snapshot was created in or copied from.

', 'DBSnapshot$SourceDBSnapshotIdentifier' => '

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

', 'DBSnapshot$StorageType' => '

Specifies the storage type associated with DB snapshot.

', 'DBSnapshot$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'DBSnapshot$KmsKeyId' => '

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

', 'DBSnapshot$DBSnapshotArn' => '

The Amazon Resource Name (ARN) for the DB snapshot.

', 'DBSnapshot$Timezone' => '

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

', 'DBSnapshot$DbiResourceId' => '

The identifier for the source DB instance, which can\'t be changed and which is unique to an AWS Region.

', 'DBSnapshotAttribute$AttributeName' => '

The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

', 'DBSnapshotAttributesResult$DBSnapshotIdentifier' => '

The identifier of the manual DB snapshot that the attributes apply to.

', 'DBSnapshotMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBSubnetGroup$DBSubnetGroupName' => '

The name of the DB subnet group.

', 'DBSubnetGroup$DBSubnetGroupDescription' => '

Provides the description of the DB subnet group.

', 'DBSubnetGroup$VpcId' => '

Provides the VpcId of the DB subnet group.

', 'DBSubnetGroup$SubnetGroupStatus' => '

Provides the status of the DB subnet group.

', 'DBSubnetGroup$DBSubnetGroupArn' => '

The Amazon Resource Name (ARN) for the DB subnet group.

', 'DBSubnetGroupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DeleteDBClusterEndpointMessage$DBClusterEndpointIdentifier' => '

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

', 'DeleteDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier for the DB cluster to be deleted. This parameter isn\'t case-sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

', 'DeleteDBClusterMessage$FinalDBSnapshotIdentifier' => '

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'DeleteDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group.

Constraints:

  • Must be the name of an existing DB cluster parameter group.

  • You can\'t delete a default DB cluster parameter group.

  • Can\'t be associated with any DB clusters.

', 'DeleteDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

', 'DeleteDBInstanceAutomatedBackupMessage$DbiResourceId' => '

The identifier for the source DB instance, which can\'t be changed and which is unique to an AWS Region.

', 'DeleteDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier for the DB instance to be deleted. This parameter isn\'t case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

', 'DeleteDBInstanceMessage$FinalDBSnapshotIdentifier' => '

The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

  • Can\'t be specified when deleting a Read Replica.

', 'DeleteDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group

  • You can\'t delete a default DB parameter group

  • Can\'t be associated with any DB instances

', 'DeleteDBSecurityGroupMessage$DBSecurityGroupName' => '

The name of the DB security group to delete.

You can\'t delete the default DB security group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

  • Must not be "Default"

', 'DeleteDBSnapshotMessage$DBSnapshotIdentifier' => '

The DB snapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

', 'DeleteDBSubnetGroupMessage$DBSubnetGroupName' => '

The name of the database subnet group to delete.

You can\'t delete the default subnet group.

Constraints:

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'DeleteEventSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to delete.

', 'DeleteGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the global database cluster being deleted.

', 'DeleteOptionGroupMessage$OptionGroupName' => '

The name of the option group to be deleted.

You can\'t delete default option groups.

', 'DescribeCertificatesMessage$CertificateIdentifier' => '

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn\'t case-sensitive.

Constraints:

  • Must match an existing CertificateIdentifier.

', 'DescribeCertificatesMessage$Marker' => '

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterBacktracksMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'DescribeDBClusterBacktracksMessage$BacktrackIdentifier' => '

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Example: 123e4567-e89b-12d3-a456-426655440000

', 'DescribeDBClusterBacktracksMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterEndpointsMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

', 'DescribeDBClusterEndpointsMessage$DBClusterEndpointIdentifier' => '

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

', 'DescribeDBClusterEndpointsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParameterGroupsMessage$DBClusterParameterGroupName' => '

The name of a specific DB cluster parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParametersMessage$DBClusterParameterGroupName' => '

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParametersMessage$Source' => '

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

', 'DescribeDBClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterSnapshotAttributesMessage$DBClusterSnapshotIdentifier' => '

The identifier for the DB cluster snapshot to describe the attributes for.

', 'DescribeDBClusterSnapshotsMessage$DBClusterIdentifier' => '

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can\'t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBCluster.

', 'DescribeDBClusterSnapshotsMessage$DBClusterSnapshotIdentifier' => '

A specific DB cluster snapshot identifier to describe. This parameter can\'t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If supplied, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

', 'DescribeDBClusterSnapshotsMessage$SnapshotType' => '

The type of DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB cluster snapshots that have been taken by my AWS account.

  • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

  • public - Return all DB cluster snapshots that have been marked as public.

If you don\'t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

', 'DescribeDBClusterSnapshotsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClustersMessage$DBClusterIdentifier' => '

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn\'t case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

', 'DescribeDBClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBEngineVersionsMessage$Engine' => '

The database engine to return.

', 'DescribeDBEngineVersionsMessage$EngineVersion' => '

The database engine version to return.

Example: 5.1.49

', 'DescribeDBEngineVersionsMessage$DBParameterGroupFamily' => '

The name of a specific DB parameter group family to return details for.

Constraints:

  • If supplied, must match an existing DBParameterGroupFamily.

', 'DescribeDBEngineVersionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBInstanceAutomatedBackupsMessage$DbiResourceId' => '

The resource ID of the DB instance that is the source of the automated backup. This parameter isn\'t case-sensitive.

', 'DescribeDBInstanceAutomatedBackupsMessage$DBInstanceIdentifier' => '

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance\' automated backup. This parameter isn\'t case-sensitive.

', 'DescribeDBInstanceAutomatedBackupsMessage$Marker' => '

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

', 'DescribeDBInstancesMessage$DBInstanceIdentifier' => '

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn\'t case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

', 'DescribeDBInstancesMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBLogFilesDetails$LogFileName' => '

The name of the log file for the specified DB instance.

', 'DescribeDBLogFilesMessage$DBInstanceIdentifier' => '

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'DescribeDBLogFilesMessage$FilenameContains' => '

Filters the available log files for log file names that contain the specified string.

', 'DescribeDBLogFilesMessage$Marker' => '

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

', 'DescribeDBLogFilesResponse$Marker' => '

A pagination token that can be used in a subsequent DescribeDBLogFiles request.

', 'DescribeDBParameterGroupsMessage$DBParameterGroupName' => '

The name of a specific DB parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBParametersMessage$DBParameterGroupName' => '

The name of a specific DB parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

', 'DescribeDBParametersMessage$Source' => '

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

', 'DescribeDBParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSecurityGroupsMessage$DBSecurityGroupName' => '

The name of the DB security group to return details for.

', 'DescribeDBSecurityGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSnapshotAttributesMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot to describe the attributes for.

', 'DescribeDBSnapshotsMessage$DBInstanceIdentifier' => '

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can\'t be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

', 'DescribeDBSnapshotsMessage$DBSnapshotIdentifier' => '

A specific DB snapshot identifier to describe. This parameter can\'t be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

  • If supplied, must match the identifier of an existing DBSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

', 'DescribeDBSnapshotsMessage$SnapshotType' => '

The type of snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public - Return all DB snapshots that have been marked as public.

If you don\'t specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

', 'DescribeDBSnapshotsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSnapshotsMessage$DbiResourceId' => '

A specific DB resource ID to describe.

', 'DescribeDBSubnetGroupsMessage$DBSubnetGroupName' => '

The name of the DB subnet group to return details for.

', 'DescribeDBSubnetGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEngineDefaultClusterParametersMessage$DBParameterGroupFamily' => '

The name of the DB cluster parameter group family to return engine parameter information for.

', 'DescribeEngineDefaultClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEngineDefaultParametersMessage$DBParameterGroupFamily' => '

The name of the DB parameter group family.

', 'DescribeEngineDefaultParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEventCategoriesMessage$SourceType' => '

The type of source that is generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

', 'DescribeEventSubscriptionsMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to describe.

', 'DescribeEventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DescribeEventsMessage$SourceIdentifier' => '

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is supplied, SourceType must also be provided.

  • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'DescribeEventsMessage$Marker' => '

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeGlobalClustersMessage$GlobalClusterIdentifier' => '

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn\'t case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

', 'DescribeGlobalClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOptionGroupOptionsMessage$EngineName' => '

A required parameter. Options available for the given engine name are described.

', 'DescribeOptionGroupOptionsMessage$MajorEngineVersion' => '

If specified, filters the results to include only options for the specified major engine version.

', 'DescribeOptionGroupOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOptionGroupsMessage$OptionGroupName' => '

The name of the option group to describe. Can\'t be supplied together with EngineName or MajorEngineVersion.

', 'DescribeOptionGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOptionGroupsMessage$EngineName' => '

Filters the list of option groups to only include groups associated with a specific database engine.

', 'DescribeOptionGroupsMessage$MajorEngineVersion' => '

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

', 'DescribeOrderableDBInstanceOptionsMessage$Engine' => '

The name of the engine to retrieve DB instance options for.

', 'DescribeOrderableDBInstanceOptionsMessage$EngineVersion' => '

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass' => '

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

', 'DescribeOrderableDBInstanceOptionsMessage$LicenseModel' => '

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

', 'DescribeOrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DescribePendingMaintenanceActionsMessage$ResourceIdentifier' => '

The ARN of a resource to return pending maintenance actions for.

', 'DescribePendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

', 'DescribeReservedDBInstancesMessage$ReservedDBInstanceId' => '

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

', 'DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId' => '

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

', 'DescribeReservedDBInstancesMessage$DBInstanceClass' => '

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

', 'DescribeReservedDBInstancesMessage$Duration' => '

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

', 'DescribeReservedDBInstancesMessage$ProductDescription' => '

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

', 'DescribeReservedDBInstancesMessage$OfferingType' => '

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

', 'DescribeReservedDBInstancesMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeReservedDBInstancesOfferingsMessage$ReservedDBInstancesOfferingId' => '

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

', 'DescribeReservedDBInstancesOfferingsMessage$DBInstanceClass' => '

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

', 'DescribeReservedDBInstancesOfferingsMessage$Duration' => '

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

', 'DescribeReservedDBInstancesOfferingsMessage$ProductDescription' => '

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

The results show offerings that partially match the filter value.

', 'DescribeReservedDBInstancesOfferingsMessage$OfferingType' => '

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

', 'DescribeReservedDBInstancesOfferingsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeSourceRegionsMessage$RegionName' => '

The source AWS Region name. For example, us-east-1.

Constraints:

  • Must specify a valid AWS Region name.

', 'DescribeSourceRegionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeValidDBInstanceModificationsMessage$DBInstanceIdentifier' => '

The customer identifier or the ARN of your DB instance.

', 'DomainMembership$Domain' => '

The identifier of the Active Directory Domain.

', 'DomainMembership$Status' => '

The status of the DB instance\'s Active Directory Domain membership, such as joined, pending-join, failed etc).

', 'DomainMembership$FQDN' => '

The fully qualified domain name of the Active Directory Domain.

', 'DomainMembership$IAMRoleName' => '

The name of the IAM role to be used when making API calls to the Directory Service.

', 'DownloadDBLogFilePortionDetails$LogFileData' => '

Entries from the specified log file.

', 'DownloadDBLogFilePortionDetails$Marker' => '

A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

', 'DownloadDBLogFilePortionMessage$DBInstanceIdentifier' => '

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'DownloadDBLogFilePortionMessage$LogFileName' => '

The name of the log file to be downloaded.

', 'DownloadDBLogFilePortionMessage$Marker' => '

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

', 'EC2SecurityGroup$Status' => '

Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

', 'EC2SecurityGroup$EC2SecurityGroupName' => '

Specifies the name of the EC2 security group.

', 'EC2SecurityGroup$EC2SecurityGroupId' => '

Specifies the id of the EC2 security group.

', 'EC2SecurityGroup$EC2SecurityGroupOwnerId' => '

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

', 'Endpoint$Address' => '

Specifies the DNS address of the DB instance.

', 'Endpoint$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'EngineDefaults$DBParameterGroupFamily' => '

Specifies the name of the DB parameter group family that the engine default parameters apply to.

', 'EngineDefaults$Marker' => '

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'EngineModeList$member' => NULL, 'Event$SourceIdentifier' => '

Provides the identifier for the source of the event.

', 'Event$Message' => '

Provides the text of this event.

', 'Event$SourceArn' => '

The Amazon Resource Name (ARN) for the event.

', 'EventCategoriesList$member' => NULL, 'EventCategoriesMap$SourceType' => '

The source type that the returned categories belong to

', 'EventSubscription$CustomerAwsId' => '

The AWS customer account associated with the RDS event notification subscription.

', 'EventSubscription$CustSubscriptionId' => '

The RDS event notification subscription Id.

', 'EventSubscription$SnsTopicArn' => '

The topic ARN of the RDS event notification subscription.

', 'EventSubscription$Status' => '

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

', 'EventSubscription$SubscriptionCreationTime' => '

The time the RDS event notification subscription was created.

', 'EventSubscription$SourceType' => '

The source type for the RDS event notification subscription.

', 'EventSubscription$EventSubscriptionArn' => '

The Amazon Resource Name (ARN) for the event subscription.

', 'EventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'EventsMessage$Marker' => '

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'FailoverDBClusterMessage$DBClusterIdentifier' => '

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'FailoverDBClusterMessage$TargetDBInstanceIdentifier' => '

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

', 'FeatureNameList$member' => NULL, 'Filter$Name' => '

The name of the filter. Filter names are case-sensitive.

', 'FilterValueList$member' => NULL, 'GlobalCluster$GlobalClusterIdentifier' => '

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

', 'GlobalCluster$GlobalClusterResourceId' => '

The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

', 'GlobalCluster$GlobalClusterArn' => '

The Amazon Resource Name (ARN) for the global database cluster.

', 'GlobalCluster$Status' => '

Specifies the current state of this global database cluster.

', 'GlobalCluster$Engine' => '

The Aurora database engine used by the global database cluster.

', 'GlobalCluster$EngineVersion' => '

Indicates the database engine version.

', 'GlobalCluster$DatabaseName' => '

The default database name within the new global database cluster.

', 'GlobalClusterMember$DBClusterArn' => '

The Amazon Resource Name (ARN) for each Aurora cluster.

', 'GlobalClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'IPRange$Status' => '

Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

', 'IPRange$CIDRIP' => '

Specifies the IP range.

', 'KeyList$member' => NULL, 'ListTagsForResourceMessage$ResourceName' => '

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

', 'LogTypeList$member' => NULL, 'MinimumEngineVersionPerAllowedValue$AllowedValue' => '

The allowed value for an option setting.

', 'MinimumEngineVersionPerAllowedValue$MinimumEngineVersion' => '

The minimum DB engine version required for the allowed value.

', 'ModifyCurrentDBClusterCapacityMessage$DBClusterIdentifier' => '

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DB cluster.

', 'ModifyCurrentDBClusterCapacityMessage$TimeoutAction' => '

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

', 'ModifyDBClusterEndpointMessage$DBClusterEndpointIdentifier' => '

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

', 'ModifyDBClusterEndpointMessage$EndpointType' => '

The type of the endpoint. One of: READER, ANY.

', 'ModifyDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'ModifyDBClusterMessage$NewDBClusterIdentifier' => '

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • The first character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

', 'ModifyDBClusterMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to use for the DB cluster.

', 'ModifyDBClusterMessage$MasterUserPassword' => '

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'ModifyDBClusterMessage$OptionGroupName' => '

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn\'t result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can\'t be removed from an option group. The option group can\'t be removed from a DB cluster once it is associated with a DB cluster.

', 'ModifyDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'ModifyDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'ModifyDBClusterMessage$EngineVersion' => '

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

', 'ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to modify.

', 'ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier' => '

The identifier for the DB cluster snapshot to modify the attributes for.

', 'ModifyDBClusterSnapshotAttributeMessage$AttributeName' => '

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

', 'ModifyDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'ModifyDBInstanceMessage$DBInstanceClass' => '

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

', 'ModifyDBInstanceMessage$DBSubnetGroupName' => '

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

', 'ModifyDBInstanceMessage$MasterUserPassword' => '

The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

', 'ModifyDBInstanceMessage$DBParameterGroupName' => '

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn\'t result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

', 'ModifyDBInstanceMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

', 'ModifyDBInstanceMessage$PreferredMaintenanceWindow' => '

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn\'t result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

', 'ModifyDBInstanceMessage$EngineVersion' => '

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

', 'ModifyDBInstanceMessage$LicenseModel' => '

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

', 'ModifyDBInstanceMessage$OptionGroupName' => '

Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn\'t result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'ModifyDBInstanceMessage$NewDBInstanceIdentifier' => '

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'ModifyDBInstanceMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise standard

', 'ModifyDBInstanceMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'ModifyDBInstanceMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'ModifyDBInstanceMessage$CACertificateIdentifier' => '

Indicates the certificate that needs to be associated with the instance.

', 'ModifyDBInstanceMessage$Domain' => '

The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain.

', 'ModifyDBInstanceMessage$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'ModifyDBInstanceMessage$DomainIAMRoleName' => '

The name of the IAM role to use when making API calls to the Directory Service.

', 'ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'ModifyDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

', 'ModifyDBSnapshotAttributeMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot to modify the attributes for.

', 'ModifyDBSnapshotAttributeMessage$AttributeName' => '

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.

', 'ModifyDBSnapshotMessage$DBSnapshotIdentifier' => '

The identifier of the DB snapshot to modify.

', 'ModifyDBSnapshotMessage$EngineVersion' => '

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

  • 5.5.46 (supported for 5.1 DB snapshots)

Oracle

  • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

  • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

  • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

', 'ModifyDBSnapshotMessage$OptionGroupName' => '

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide.

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the DB subnet group. This value is stored as a lowercase string. You can\'t modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the DB subnet group.

', 'ModifyEventSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription.

', 'ModifyEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

', 'ModifyEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

', 'ModifyGlobalClusterMessage$GlobalClusterIdentifier' => '

The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing global database cluster.

', 'ModifyGlobalClusterMessage$NewGlobalClusterIdentifier' => '

The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • The first character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

', 'ModifyOptionGroupMessage$OptionGroupName' => '

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'Option$OptionName' => '

The name of the option.

', 'Option$OptionDescription' => '

The description of the option.

', 'Option$OptionVersion' => '

The version of the option.

', 'OptionConfiguration$OptionName' => '

The configuration of options to include in a group.

', 'OptionConfiguration$OptionVersion' => '

The version for the option.

', 'OptionGroup$OptionGroupName' => '

Specifies the name of the option group.

', 'OptionGroup$OptionGroupDescription' => '

Provides a description of the option group.

', 'OptionGroup$EngineName' => '

Indicates the name of the engine that this option group can be applied to.

', 'OptionGroup$MajorEngineVersion' => '

Indicates the major engine version associated with this option group.

', 'OptionGroup$VpcId' => '

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

', 'OptionGroup$OptionGroupArn' => '

The Amazon Resource Name (ARN) for the option group.

', 'OptionGroupMembership$OptionGroupName' => '

The name of the option group that the instance belongs to.

', 'OptionGroupMembership$Status' => '

The status of the DB instance\'s option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

', 'OptionGroupOption$Name' => '

The name of the option.

', 'OptionGroupOption$Description' => '

The description of the option.

', 'OptionGroupOption$EngineName' => '

The name of the engine that this option can be applied to.

', 'OptionGroupOption$MajorEngineVersion' => '

Indicates the major engine version that the option is available for.

', 'OptionGroupOption$MinimumRequiredMinorEngineVersion' => '

The minimum required engine version for the option to be applied.

', 'OptionGroupOptionSetting$SettingName' => '

The name of the option group option.

', 'OptionGroupOptionSetting$SettingDescription' => '

The description of the option group option.

', 'OptionGroupOptionSetting$DefaultValue' => '

The default value for the option group option.

', 'OptionGroupOptionSetting$ApplyType' => '

The DB engine specific parameter type for the option group option.

', 'OptionGroupOptionSetting$AllowedValues' => '

Indicates the acceptable values for the option group option.

', 'OptionGroupOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'OptionGroups$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'OptionNamesList$member' => NULL, 'OptionSetting$Name' => '

The name of the option that has settings that you can set.

', 'OptionSetting$Value' => '

The current value of the option setting.

', 'OptionSetting$DefaultValue' => '

The default value of the option setting.

', 'OptionSetting$Description' => '

The description of the option setting.

', 'OptionSetting$ApplyType' => '

The DB engine specific parameter type.

', 'OptionSetting$DataType' => '

The data type of the option setting.

', 'OptionSetting$AllowedValues' => '

The allowed values of the option setting.

', 'OptionVersion$Version' => '

The version of the option.

', 'OptionsConflictsWith$member' => NULL, 'OptionsDependedOn$member' => NULL, 'OrderableDBInstanceOption$Engine' => '

The engine type of a DB instance.

', 'OrderableDBInstanceOption$EngineVersion' => '

The engine version of a DB instance.

', 'OrderableDBInstanceOption$DBInstanceClass' => '

The DB instance class for a DB instance.

', 'OrderableDBInstanceOption$LicenseModel' => '

The license model for a DB instance.

', 'OrderableDBInstanceOption$StorageType' => '

Indicates the storage type for a DB instance.

', 'OrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'Parameter$ParameterName' => '

Specifies the name of the parameter.

', 'Parameter$ParameterValue' => '

Specifies the value of the parameter.

', 'Parameter$Description' => '

Provides a description of the parameter.

', 'Parameter$Source' => '

Indicates the source of the parameter value.

', 'Parameter$ApplyType' => '

Specifies the engine specific parameters type.

', 'Parameter$DataType' => '

Specifies the valid data type for the parameter.

', 'Parameter$AllowedValues' => '

Specifies the valid range of values for the parameter.

', 'Parameter$MinimumEngineVersion' => '

The earliest engine version to which the parameter can apply.

', 'PendingMaintenanceAction$Action' => '

The type of pending maintenance action that is available for the resource.

', 'PendingMaintenanceAction$OptInStatus' => '

Indicates the type of opt-in request that has been received for the resource.

', 'PendingMaintenanceAction$Description' => '

A description providing more detail about the maintenance action.

', 'PendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

', 'PendingModifiedValues$DBInstanceClass' => '

Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

', 'PendingModifiedValues$MasterUserPassword' => '

Contains the pending or currently-in-progress change of the master credentials for the DB instance.

', 'PendingModifiedValues$EngineVersion' => '

Indicates the database engine version.

', 'PendingModifiedValues$LicenseModel' => '

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

', 'PendingModifiedValues$DBInstanceIdentifier' => '

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

', 'PendingModifiedValues$StorageType' => '

Specifies the storage type to be associated with the DB instance.

', 'PendingModifiedValues$CACertificateIdentifier' => '

Specifies the identifier of the CA certificate for the DB instance.

', 'PendingModifiedValues$DBSubnetGroupName' => '

The new DB subnet group for the DB instance.

', 'ProcessorFeature$Name' => '

The name of the processor feature. Valid names are coreCount and threadsPerCore.

', 'ProcessorFeature$Value' => '

The value of a processor feature name.

', 'PromoteReadReplicaDBClusterMessage$DBClusterIdentifier' => '

The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster Read Replica.

Example: my-cluster-replica1

', 'PromoteReadReplicaMessage$DBInstanceIdentifier' => '

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing Read Replica DB instance.

Example: mydbinstance

', 'PromoteReadReplicaMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferingId' => '

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

', 'PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId' => '

Customer-specified identifier to track this reservation.

Example: myreservationID

', 'ReadReplicaDBClusterIdentifierList$member' => NULL, 'ReadReplicaDBInstanceIdentifierList$member' => NULL, 'ReadReplicaIdentifierList$member' => NULL, 'ReadersArnList$member' => NULL, 'RebootDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'RemoveFromGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier to detach from the Aurora global database cluster.

', 'RemoveFromGlobalClusterMessage$DbClusterIdentifier' => '

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

', 'RemoveRoleFromDBClusterMessage$DBClusterIdentifier' => '

The name of the DB cluster to disassociate the IAM role from.

', 'RemoveRoleFromDBClusterMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

', 'RemoveRoleFromDBInstanceMessage$DBInstanceIdentifier' => '

The name of the DB instance to disassociate the IAM role from.

', 'RemoveRoleFromDBInstanceMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

', 'RemoveRoleFromDBInstanceMessage$FeatureName' => '

The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to remove a source identifier from.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier' => '

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

', 'RemoveTagsFromResourceMessage$ResourceName' => '

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

', 'ReservedDBInstance$ReservedDBInstanceId' => '

The unique identifier for the reservation.

', 'ReservedDBInstance$ReservedDBInstancesOfferingId' => '

The offering identifier.

', 'ReservedDBInstance$DBInstanceClass' => '

The DB instance class for the reserved DB instance.

', 'ReservedDBInstance$CurrencyCode' => '

The currency code for the reserved DB instance.

', 'ReservedDBInstance$ProductDescription' => '

The description of the reserved DB instance.

', 'ReservedDBInstance$OfferingType' => '

The offering type of this reserved DB instance.

', 'ReservedDBInstance$State' => '

The state of the reserved DB instance.

', 'ReservedDBInstance$ReservedDBInstanceArn' => '

The Amazon Resource Name (ARN) for the reserved DB instance.

', 'ReservedDBInstanceMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'ReservedDBInstancesOffering$ReservedDBInstancesOfferingId' => '

The offering identifier.

', 'ReservedDBInstancesOffering$DBInstanceClass' => '

The DB instance class for the reserved DB instance.

', 'ReservedDBInstancesOffering$CurrencyCode' => '

The currency code for the reserved DB instance offering.

', 'ReservedDBInstancesOffering$ProductDescription' => '

The database engine used by the offering.

', 'ReservedDBInstancesOffering$OfferingType' => '

The offering type.

', 'ReservedDBInstancesOfferingMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'ResetDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to reset.

', 'ResetDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

', 'ResourcePendingMaintenanceActions$ResourceIdentifier' => '

The ARN of the resource that has pending maintenance actions.

', 'RestoreDBClusterFromS3Message$CharacterSetName' => '

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

', 'RestoreDBClusterFromS3Message$DatabaseName' => '

The database name for the restored DB cluster.

', 'RestoreDBClusterFromS3Message$DBClusterIdentifier' => '

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is isn\'t case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'RestoreDBClusterFromS3Message$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'RestoreDBClusterFromS3Message$DBSubnetGroupName' => '

A DB subnet group to associate with the restored DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterFromS3Message$Engine' => '

The name of the database engine to be used for the restored DB cluster.

Valid Values: aurora, aurora-postgresql

', 'RestoreDBClusterFromS3Message$EngineVersion' => '

The version number of the database engine to use.

Aurora MySQL

Example: 5.6.10a

Aurora PostgreSQL

Example: 9.6.3

', 'RestoreDBClusterFromS3Message$MasterUsername' => '

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'RestoreDBClusterFromS3Message$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'RestoreDBClusterFromS3Message$OptionGroupName' => '

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can\'t be removed from an option group. An option group can\'t be removed from a DB cluster once it is associated with a DB cluster.

', 'RestoreDBClusterFromS3Message$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'RestoreDBClusterFromS3Message$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'RestoreDBClusterFromS3Message$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

', 'RestoreDBClusterFromS3Message$SourceEngine' => '

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

', 'RestoreDBClusterFromS3Message$SourceEngineVersion' => '

The version of the database that the backup files were created from.

MySQL version 5.5 and 5.6 are supported.

Example: 5.6.22

', 'RestoreDBClusterFromS3Message$S3BucketName' => '

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

', 'RestoreDBClusterFromS3Message$S3Prefix' => '

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

', 'RestoreDBClusterFromS3Message$S3IngestionRoleArn' => '

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier' => '

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn\'t case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

', 'RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier' => '

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

', 'RestoreDBClusterFromSnapshotMessage$Engine' => '

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

', 'RestoreDBClusterFromSnapshotMessage$EngineVersion' => '

The version of the database engine to use for the new DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName' => '

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

', 'RestoreDBClusterFromSnapshotMessage$DatabaseName' => '

The database name for the restored DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$OptionGroupName' => '

The name of the option group to use for the restored DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$KmsKeyId' => '

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you don\'t specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

', 'RestoreDBClusterFromSnapshotMessage$EngineMode' => '

The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier' => '

The name of the new DB cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'RestoreDBClusterToPointInTimeMessage$RestoreType' => '

The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can\'t specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don\'t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier' => '

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName' => '

The DB subnet group name to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterToPointInTimeMessage$OptionGroupName' => '

The name of the option group for the new DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$KmsKeyId' => '

The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you don\'t specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

  • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

', 'RestoreDBClusterToPointInTimeMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier' => '

Name of the DB instance to create from the DB snapshot. This parameter isn\'t case-sensitive.

Constraints:

  • Must contain from 1 to 63 numbers, letters, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

', 'RestoreDBInstanceFromDBSnapshotMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot to restore from.

Constraints:

  • Must match the identifier of an existing DBSnapshot.

  • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

', 'RestoreDBInstanceFromDBSnapshotMessage$DBInstanceClass' => '

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

', 'RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone' => '

The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

', 'RestoreDBInstanceFromDBSnapshotMessage$DBSubnetGroupName' => '

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBInstanceFromDBSnapshotMessage$LicenseModel' => '

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

', 'RestoreDBInstanceFromDBSnapshotMessage$DBName' => '

The database name for the restored DB instance.

This parameter doesn\'t apply to the MySQL, PostgreSQL, or MariaDB engines.

', 'RestoreDBInstanceFromDBSnapshotMessage$Engine' => '

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

', 'RestoreDBInstanceFromDBSnapshotMessage$OptionGroupName' => '

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'RestoreDBInstanceFromDBSnapshotMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'RestoreDBInstanceFromDBSnapshotMessage$Domain' => '

Specify the Active Directory Domain to restore the instance in.

', 'RestoreDBInstanceFromDBSnapshotMessage$DomainIAMRoleName' => '

Specify the name of the IAM role to be used when making API calls to the Directory Service.

', 'RestoreDBInstanceFromDBSnapshotMessage$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBInstanceFromS3Message$DBName' => '

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

', 'RestoreDBInstanceFromS3Message$DBInstanceIdentifier' => '

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'RestoreDBInstanceFromS3Message$DBInstanceClass' => '

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.

', 'RestoreDBInstanceFromS3Message$Engine' => '

The name of the database engine to be used for this instance.

Valid Values: mysql

', 'RestoreDBInstanceFromS3Message$MasterUsername' => '

The name for the master user.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'RestoreDBInstanceFromS3Message$MasterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'RestoreDBInstanceFromS3Message$AvailabilityZone' => '

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

Default: A random, system-chosen Availability Zone in the endpoint\'s AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can\'t be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

', 'RestoreDBInstanceFromS3Message$DBSubnetGroupName' => '

A DB subnet group to associate with this DB instance.

', 'RestoreDBInstanceFromS3Message$PreferredMaintenanceWindow' => '

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

  • Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred backup window.

  • Must be at least 30 minutes.

', 'RestoreDBInstanceFromS3Message$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.

', 'RestoreDBInstanceFromS3Message$PreferredBackupWindow' => '

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'RestoreDBInstanceFromS3Message$EngineVersion' => '

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

', 'RestoreDBInstanceFromS3Message$LicenseModel' => '

The license model for this DB instance. Use general-public-license.

', 'RestoreDBInstanceFromS3Message$OptionGroupName' => '

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

', 'RestoreDBInstanceFromS3Message$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

', 'RestoreDBInstanceFromS3Message$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

', 'RestoreDBInstanceFromS3Message$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'RestoreDBInstanceFromS3Message$SourceEngine' => '

The name of the engine of your source database.

Valid Values: mysql

', 'RestoreDBInstanceFromS3Message$SourceEngineVersion' => '

The engine version of your source database.

Valid Values: 5.6

', 'RestoreDBInstanceFromS3Message$S3BucketName' => '

The name of your Amazon S3 bucket that contains your database backup file.

', 'RestoreDBInstanceFromS3Message$S3Prefix' => '

The prefix of your Amazon S3 bucket.

', 'RestoreDBInstanceFromS3Message$S3IngestionRoleArn' => '

An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

', 'RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier' => '

The identifier of the source DB instance from which to restore.

Constraints:

  • Must match the identifier of an existing DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$TargetDBInstanceIdentifier' => '

The name of the new DB instance to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'RestoreDBInstanceToPointInTimeMessage$DBInstanceClass' => '

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$AvailabilityZone' => '

The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

', 'RestoreDBInstanceToPointInTimeMessage$DBSubnetGroupName' => '

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBInstanceToPointInTimeMessage$LicenseModel' => '

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

', 'RestoreDBInstanceToPointInTimeMessage$DBName' => '

The database name for the restored DB instance.

This parameter is not used for the MySQL or MariaDB engines.

', 'RestoreDBInstanceToPointInTimeMessage$Engine' => '

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

', 'RestoreDBInstanceToPointInTimeMessage$OptionGroupName' => '

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'RestoreDBInstanceToPointInTimeMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'RestoreDBInstanceToPointInTimeMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'RestoreDBInstanceToPointInTimeMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'RestoreDBInstanceToPointInTimeMessage$Domain' => '

Specify the Active Directory Domain to restore the instance in.

', 'RestoreDBInstanceToPointInTimeMessage$DomainIAMRoleName' => '

Specify the name of the IAM role to be used when making API calls to the Directory Service.

', 'RestoreDBInstanceToPointInTimeMessage$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBInstanceToPointInTimeMessage$SourceDbiResourceId' => '

The resource ID of the source DB instance from which to restore.

', 'RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName' => '

The name of the DB security group to revoke ingress from.

', 'RevokeDBSecurityGroupIngressMessage$CIDRIP' => '

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can\'t be provided.

', 'RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupName' => '

The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupId' => '

The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => '

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'SourceIdsList$member' => NULL, 'SourceRegion$RegionName' => '

The name of the source AWS Region.

', 'SourceRegion$Endpoint' => '

The endpoint for the source AWS Region endpoint.

', 'SourceRegion$Status' => '

The status of the source AWS Region.

', 'SourceRegionMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'StartDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.

', 'StartDBInstanceMessage$DBInstanceIdentifier' => '

The user-supplied instance identifier.

', 'StopDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

', 'StopDBInstanceMessage$DBInstanceIdentifier' => '

The user-supplied instance identifier.

', 'StopDBInstanceMessage$DBSnapshotIdentifier' => '

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

', 'StringList$member' => NULL, 'Subnet$SubnetIdentifier' => '

Specifies the identifier of the subnet.

', 'Subnet$SubnetStatus' => '

Specifies the status of the subnet.

', 'SubnetIdentifierList$member' => NULL, 'Tag$Key' => '

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can\'t be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'Tag$Value' => '

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can\'t be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'Timezone$TimezoneName' => '

The name of the time zone.

', 'UpgradeTarget$Engine' => '

The name of the upgrade target database engine.

', 'UpgradeTarget$EngineVersion' => '

The version number of the upgrade target database engine.

', 'UpgradeTarget$Description' => '

The version of the database engine that a DB instance can be upgraded to.

', 'ValidStorageOptions$StorageType' => '

The valid storage types for your DB instance. For example, gp2, io1.

', 'VpcSecurityGroupIdList$member' => NULL, 'VpcSecurityGroupMembership$VpcSecurityGroupId' => '

The name of the VPC security group.

', 'VpcSecurityGroupMembership$Status' => '

The status of the VPC security group.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterEndpointMessage$StaticMembers' => '

List of DB instance identifiers that are part of the custom endpoint group.

', 'CreateDBClusterEndpointMessage$ExcludedMembers' => '

List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

', 'DBCluster$CustomEndpoints' => '

Identifies all custom endpoints associated with the cluster.

', 'DBClusterEndpoint$StaticMembers' => '

List of DB instance identifiers that are part of the custom endpoint group.

', 'DBClusterEndpoint$ExcludedMembers' => '

List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

', 'ModifyDBClusterEndpointMessage$StaticMembers' => '

List of DB instance identifiers that are part of the custom endpoint group.

', 'ModifyDBClusterEndpointMessage$ExcludedMembers' => '

List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

', ], ], 'Subnet' => [ 'base' => '

This data type is used as a response element in the DescribeDBSubnetGroups action.

', 'refs' => [ 'SubnetList$member' => NULL, ], ], 'SubnetAlreadyInUse' => [ 'base' => '

The DB subnet is already in use in the Availability Zone.

', 'refs' => [], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateDBSubnetGroupMessage$SubnetIds' => '

The EC2 Subnet IDs for the DB subnet group.

', 'ModifyDBSubnetGroupMessage$SubnetIds' => '

The EC2 subnet IDs for the DB subnet group.

', ], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroup$Subnets' => '

Contains a list of Subnet elements.

', ], ], 'SubscriptionAlreadyExistFault' => [ 'base' => '

The supplied subscription name already exists.

', 'refs' => [], ], 'SubscriptionCategoryNotFoundFault' => [ 'base' => '

The supplied category does not exist.

', 'refs' => [], ], 'SubscriptionNotFoundFault' => [ 'base' => '

The subscription name does not exist.

', 'refs' => [], ], 'SupportedCharacterSetsList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedCharacterSets' => '

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

', ], ], 'SupportedTimezonesList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedTimezones' => '

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

', ], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$BacktrackTo' => '

The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

If the specified time is not a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

  • Must contain a valid ISO 8601 timestamp.

  • Can\'t contain a timestamp set in the future.

Example: 2017-07-08T18:00Z

', 'Certificate$ValidFrom' => '

The starting date from which the certificate is valid.

', 'Certificate$ValidTill' => '

The final date that the certificate continues to be valid.

', 'DBCluster$EarliestRestorableTime' => '

The earliest time to which a database can be restored with point-in-time restore.

', 'DBCluster$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DBCluster$ClusterCreateTime' => '

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

', 'DBCluster$EarliestBacktrackTime' => '

The earliest time to which a DB cluster can be backtracked.

', 'DBClusterBacktrack$BacktrackTo' => '

The timestamp of the time to which the DB cluster was backtracked.

', 'DBClusterBacktrack$BacktrackedFrom' => '

The timestamp of the time from which the DB cluster was backtracked.

', 'DBClusterBacktrack$BacktrackRequestCreationTime' => '

The timestamp of the time at which the backtrack was requested.

', 'DBClusterSnapshot$SnapshotCreateTime' => '

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

', 'DBClusterSnapshot$ClusterCreateTime' => '

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

', 'DBInstance$InstanceCreateTime' => '

Provides the date and time the DB instance was created.

', 'DBInstance$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DBInstanceAutomatedBackup$InstanceCreateTime' => '

Provides the date and time that the DB instance was created.

', 'DBSnapshot$SnapshotCreateTime' => '

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

', 'DBSnapshot$InstanceCreateTime' => '

Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

', 'DescribeEventsMessage$StartTime' => '

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

', 'DescribeEventsMessage$EndTime' => '

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

', 'Event$Date' => '

Specifies the date and time of the event.

', 'PendingMaintenanceAction$AutoAppliedAfterDate' => '

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

', 'PendingMaintenanceAction$ForcedApplyDate' => '

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

', 'PendingMaintenanceAction$CurrentApplyDate' => '

The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

', 'ReservedDBInstance$StartTime' => '

The time the reservation started.

', 'RestoreDBClusterToPointInTimeMessage$RestoreToTime' => '

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Must be specified if UseLatestRestorableTime parameter is not provided

  • Can\'t be specified if UseLatestRestorableTime parameter is true

  • Can\'t be specified if RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

', 'RestoreDBInstanceToPointInTimeMessage$RestoreTime' => '

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Can\'t be specified if UseLatestRestorableTime parameter is true

Example: 2009-09-07T23:45:00Z

', 'RestoreWindow$EarliestTime' => '

The earliest time you can restore an instance to.

', 'RestoreWindow$LatestTime' => '

The latest time you can restore an instance to.

', ], ], 'Tag' => [ 'base' => '

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => '

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'refs' => [ 'AddTagsToResourceMessage$Tags' => '

The tags to be assigned to the Amazon RDS resource.

', 'CopyDBClusterParameterGroupMessage$Tags' => NULL, 'CopyDBClusterSnapshotMessage$Tags' => NULL, 'CopyDBParameterGroupMessage$Tags' => NULL, 'CopyDBSnapshotMessage$Tags' => NULL, 'CopyOptionGroupMessage$Tags' => NULL, 'CreateDBClusterMessage$Tags' => NULL, 'CreateDBClusterParameterGroupMessage$Tags' => NULL, 'CreateDBClusterSnapshotMessage$Tags' => '

The tags to be assigned to the DB cluster snapshot.

', 'CreateDBInstanceMessage$Tags' => NULL, 'CreateDBInstanceReadReplicaMessage$Tags' => NULL, 'CreateDBParameterGroupMessage$Tags' => NULL, 'CreateDBSecurityGroupMessage$Tags' => NULL, 'CreateDBSnapshotMessage$Tags' => NULL, 'CreateDBSubnetGroupMessage$Tags' => NULL, 'CreateEventSubscriptionMessage$Tags' => NULL, 'CreateOptionGroupMessage$Tags' => NULL, 'PurchaseReservedDBInstancesOfferingMessage$Tags' => NULL, 'RestoreDBClusterFromS3Message$Tags' => NULL, 'RestoreDBClusterFromSnapshotMessage$Tags' => '

The tags to be assigned to the restored DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$Tags' => NULL, 'RestoreDBInstanceFromDBSnapshotMessage$Tags' => NULL, 'RestoreDBInstanceFromS3Message$Tags' => '

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'RestoreDBInstanceToPointInTimeMessage$Tags' => NULL, 'TagListMessage$TagList' => '

List of tags returned by the ListTagsForResource operation.

', ], ], 'TagListMessage' => [ 'base' => '

', 'refs' => [], ], 'Timezone' => [ 'base' => '

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

', 'refs' => [ 'SupportedTimezonesList$member' => NULL, ], ], 'UpgradeTarget' => [ 'base' => '

The version of the database engine that a DB instance can be upgraded to.

', 'refs' => [ 'ValidUpgradeTargetList$member' => NULL, ], ], 'ValidDBInstanceModificationsMessage' => [ 'base' => '

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

', 'refs' => [ 'DescribeValidDBInstanceModificationsResult$ValidDBInstanceModificationsMessage' => NULL, ], ], 'ValidStorageOptions' => [ 'base' => '

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

', 'refs' => [ 'ValidStorageOptionsList$member' => NULL, ], ], 'ValidStorageOptionsList' => [ 'base' => NULL, 'refs' => [ 'ValidDBInstanceModificationsMessage$Storage' => '

Valid storage options for your DB instance.

', ], ], 'ValidUpgradeTargetList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$ValidUpgradeTarget' => '

A list of engine versions that this database engine version can be upgraded to.

', ], ], 'VpcSecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this DB cluster.

', 'CreateDBInstanceMessage$VpcSecurityGroupIds' => '

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', 'CreateDBInstanceReadReplicaMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with the Read Replica.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', 'ModifyDBClusterMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the DB cluster will belong to.

', 'ModifyDBInstanceMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

', 'OptionConfiguration$VpcSecurityGroupMemberships' => '

A list of VpcSecurityGroupMemebrship name strings used for this option.

', 'RestoreDBClusterFromS3Message$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with the restored DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the new DB cluster will belong to.

', 'RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the new DB cluster belongs to.

', 'RestoreDBInstanceFromDBSnapshotMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', 'RestoreDBInstanceFromS3Message$VpcSecurityGroupIds' => '

A list of VPC security groups to associate with this DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', ], ], 'VpcSecurityGroupMembership' => [ 'base' => '

This data type is used as a response element for queries on VPC security group membership.

', 'refs' => [ 'VpcSecurityGroupMembershipList$member' => NULL, ], ], 'VpcSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$VpcSecurityGroups' => '

Provides a list of VPC security groups that the DB cluster belongs to.

', 'DBInstance$VpcSecurityGroups' => '

Provides a list of VPC security group elements that the DB instance belongs to.

', 'Option$VpcSecurityGroupMemberships' => '

If the option requires access to a port, then this VPC security group allows access to the port.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance\'s compute resources and storage capacity to meet your application\'s demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

Amazon RDS User Guide

', 'operations' => [ 'AddRoleToDBCluster' => '

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'AddRoleToDBInstance' => '

Associates an AWS Identity and Access Management (IAM) role with a DB instance.

', 'AddSourceIdentifierToSubscription' => '

Adds a source identifier to an existing RDS event notification subscription.

', 'AddTagsToResource' => '

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

', 'ApplyPendingMaintenanceAction' => '

Applies a pending maintenance action to a resource (for example, to a DB instance).

', 'AuthorizeDBSecurityGroupIngress' => '

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can\'t authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can\'t authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

', 'BacktrackDBCluster' => '

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'CopyDBClusterParameterGroup' => '

Copies the specified DB cluster parameter group.

This action only applies to Aurora DB clusters.

', 'CopyDBClusterSnapshot' => '

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'CopyDBParameterGroup' => '

Copies the specified DB parameter group.

', 'CopyDBSnapshot' => '

Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

', 'CopyOptionGroup' => '

Copies the specified option group.

', 'CreateDBCluster' => '

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'CreateDBClusterEndpoint' => '

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

', 'CreateDBClusterParameterGroup' => '

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you\'ve created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'CreateDBClusterSnapshot' => '

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'CreateDBInstance' => '

Creates a new DB instance.

', 'CreateDBInstanceReadReplica' => '

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn\'t support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.

Your source DB instance must have backup retention enabled.

', 'CreateDBParameterGroup' => '

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you\'ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

', 'CreateDBSecurityGroup' => '

Creates a new DB security group. DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

', 'CreateDBSnapshot' => '

Creates a DBSnapshot. The source DBInstance must be in "available" state.

', 'CreateDBSubnetGroup' => '

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

', 'CreateEventSubscription' => '

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.

', 'CreateGlobalCluster' => '

Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

This action only applies to Aurora DB clusters.

', 'CreateOptionGroup' => '

Creates a new option group. You can create up to 20 option groups.

', 'DeleteDBCluster' => '

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can\'t be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DeleteDBClusterEndpoint' => '

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

', 'DeleteDBClusterParameterGroup' => '

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can\'t be associated with any DB clusters.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DeleteDBClusterSnapshot' => '

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DeleteDBInstance' => '

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can\'t be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can\'t be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can\'t delete the DB instance if both of the following conditions are true:

  • The DB cluster is a Read Replica of another Amazon Aurora DB cluster.

  • The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it\'s no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

', 'DeleteDBInstanceAutomatedBackup' => '

Deletes automated backups based on the source instance\'s DbiResourceId value or the restorable instance\'s resource ID.

', 'DeleteDBParameterGroup' => '

Deletes a specified DB parameter group. The DB parameter group to be deleted can\'t be associated with any DB instances.

', 'DeleteDBSecurityGroup' => '

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

', 'DeleteDBSnapshot' => '

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB snapshot must be in the available state to be deleted.

', 'DeleteDBSubnetGroup' => '

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

', 'DeleteEventSubscription' => '

Deletes an RDS event notification subscription.

', 'DeleteGlobalCluster' => '

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

This action only applies to Aurora DB clusters.

', 'DeleteOptionGroup' => '

Deletes an existing option group.

', 'DescribeAccountAttributes' => '

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota\'s maximum value.

This command doesn\'t take any parameters.

', 'DescribeCertificates' => '

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

', 'DescribeDBClusterBacktracks' => '

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DescribeDBClusterEndpoints' => '

Returns information about endpoints for an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

', 'DescribeDBClusterParameterGroups' => '

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DescribeDBClusterParameters' => '

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DescribeDBClusterSnapshotAttributes' => '

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

This action only applies to Aurora DB clusters.

', 'DescribeDBClusterSnapshots' => '

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DescribeDBClusters' => '

Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DescribeDBEngineVersions' => '

Returns a list of the available DB engines.

', 'DescribeDBInstanceAutomatedBackups' => '

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

', 'DescribeDBInstances' => '

Returns information about provisioned RDS instances. This API supports pagination.

', 'DescribeDBLogFiles' => '

Returns a list of DB log files for the DB instance.

', 'DescribeDBParameterGroups' => '

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

', 'DescribeDBParameters' => '

Returns the detailed parameter list for a particular DB parameter group.

', 'DescribeDBSecurityGroups' => '

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

', 'DescribeDBSnapshotAttributes' => '

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

', 'DescribeDBSnapshots' => '

Returns information about DB snapshots. This API action supports pagination.

', 'DescribeDBSubnetGroups' => '

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

', 'DescribeEngineDefaultClusterParameters' => '

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

', 'DescribeEngineDefaultParameters' => '

Returns the default engine and system parameter information for the specified database engine.

', 'DescribeEventCategories' => '

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

', 'DescribeEventSubscriptions' => '

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

', 'DescribeEvents' => '

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

', 'DescribeGlobalClusters' => '

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'DescribeOptionGroupOptions' => '

Describes all available options.

', 'DescribeOptionGroups' => '

Describes the available option groups.

', 'DescribeOrderableDBInstanceOptions' => '

Returns a list of orderable DB instance options for the specified engine.

', 'DescribePendingMaintenanceActions' => '

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

', 'DescribeReservedDBInstances' => '

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

', 'DescribeReservedDBInstancesOfferings' => '

Lists available reserved DB instance offerings.

', 'DescribeSourceRegions' => '

Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

', 'DescribeValidDBInstanceModifications' => '

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

', 'DownloadDBLogFilePortion' => '

Downloads all or a portion of the specified log file, up to 1 MB in size.

', 'FailoverDBCluster' => '

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'ListTagsForResource' => '

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'ModifyCurrentDBClusterCapacity' => '

Set the capacity of an Aurora Serverless DB cluster to a specific value.

Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'ModifyDBCluster' => '

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'ModifyDBClusterEndpoint' => '

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

', 'ModifyDBClusterParameterGroup' => '

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

This action only applies to Aurora DB clusters.

', 'ModifyDBClusterSnapshotAttribute' => '

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

This action only applies to Aurora DB clusters.

', 'ModifyDBInstance' => '

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

', 'ModifyDBParameterGroup' => '

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

', 'ModifyDBSnapshot' => '

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

', 'ModifyDBSnapshotAttribute' => '

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don\'t want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.

', 'ModifyDBSubnetGroup' => '

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

', 'ModifyEventSubscription' => '

Modifies an existing RDS event notification subscription. Note that you can\'t modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

', 'ModifyGlobalCluster' => '

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'ModifyOptionGroup' => '

Modifies an existing option group.

', 'PromoteReadReplica' => '

Promotes a Read Replica DB instance to a standalone DB instance.

  • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion.

  • This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL.

', 'PromoteReadReplicaDBCluster' => '

Promotes a Read Replica DB cluster to a standalone DB cluster.

This action only applies to Aurora DB clusters.

', 'PurchaseReservedDBInstancesOffering' => '

Purchases a reserved DB instance offering.

', 'RebootDBInstance' => '

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

', 'RemoveFromGlobalCluster' => '

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

This action only applies to Aurora DB clusters.

', 'RemoveRoleFromDBCluster' => '

Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'RemoveRoleFromDBInstance' => '

Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

', 'RemoveSourceIdentifierFromSubscription' => '

Removes a source identifier from an existing RDS event notification subscription.

', 'RemoveTagsFromResource' => '

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'ResetDBClusterParameterGroup' => '

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'ResetDBParameterGroup' => '

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

', 'RestoreDBClusterFromS3' => '

Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'RestoreDBClusterFromSnapshot' => '

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'RestoreDBClusterToPointInTime' => '

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'RestoreDBInstanceFromDBSnapshot' => '

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn\'t allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

', 'RestoreDBInstanceFromS3' => '

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

', 'RestoreDBInstanceToPointInTime' => '

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

', 'RevokeDBSecurityGroupIngress' => '

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

', 'StartDBCluster' => '

Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'StartDBInstance' => '

Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

', 'StopDBCluster' => '

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster\'s metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

', 'StopDBInstance' => '

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance\'s metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

This command doesn\'t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

', ], 'shapes' => [ 'AccountAttributesMessage' => [ 'base' => '

Data returned by the DescribeAccountAttributes action.

', 'refs' => [], ], 'AccountQuota' => [ 'base' => '

Describes a quota for an AWS account, for example, the number of DB instances allowed.

', 'refs' => [ 'AccountQuotaList$member' => NULL, ], ], 'AccountQuotaList' => [ 'base' => NULL, 'refs' => [ 'AccountAttributesMessage$AccountQuotas' => '

A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

', ], ], 'AddRoleToDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddRoleToDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'AddSourceIdentifierToSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsToResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'ApplyMethod' => [ 'base' => NULL, 'refs' => [ 'Parameter$ApplyMethod' => '

Indicates when to apply parameter updates.

', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'base' => '

', 'refs' => [], ], 'ApplyPendingMaintenanceActionResult' => [ 'base' => NULL, 'refs' => [], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttribute$AttributeValues' => '

The value(s) for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

', 'DBSnapshotAttribute$AttributeValues' => '

The value or values for the manual DB snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToAdd' => '

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don\'t want available to all AWS accounts.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToRemove' => '

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

', 'ModifyDBSnapshotAttributeMessage$ValuesToAdd' => '

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don\'t want available to all AWS accounts.

', 'ModifyDBSnapshotAttributeMessage$ValuesToRemove' => '

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

', ], ], 'AuthorizationAlreadyExistsFault' => [ 'base' => '

The specified CIDRIP or Amazon EC2 security group is already authorized for the specified DB security group.

', 'refs' => [], ], 'AuthorizationNotFoundFault' => [ 'base' => '

The specified CIDRIP or Amazon EC2 security group isn\'t authorized for the specified DB security group.

RDS also may not be authorized by using IAM to perform necessary actions on your behalf.

', 'refs' => [], ], 'AuthorizationQuotaExceededFault' => [ 'base' => '

The DB security group authorization quota has been reached.

', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressMessage' => [ 'base' => '

', 'refs' => [], ], 'AuthorizeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'AvailabilityZone' => [ 'base' => '

Contains Availability Zone information.

This data type is used as an element in the following data type:

', 'refs' => [ 'AvailabilityZoneList$member' => NULL, 'Subnet$SubnetAvailabilityZone' => NULL, ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailabilityZones' => '

A list of Availability Zones for a DB instance.

', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$AvailabilityZones' => '

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

', 'DBCluster$AvailabilityZones' => '

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

', 'DBClusterSnapshot$AvailabilityZones' => '

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

', 'RestoreDBClusterFromS3Message$AvailabilityZones' => '

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

', 'RestoreDBClusterFromSnapshotMessage$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

', ], ], 'AvailableProcessorFeature' => [ 'base' => '

Contains the available processor feature information for the DB instance class of a DB instance.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

', 'refs' => [ 'AvailableProcessorFeatureList$member' => NULL, ], ], 'AvailableProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailableProcessorFeatures' => '

A list of the available processor features for the DB instance class of a DB instance.

', 'ValidDBInstanceModificationsMessage$ValidProcessorFeatures' => '

Valid processor features for your DB instance.

', ], ], 'BacktrackDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'BackupPolicyNotFoundFault' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'DBCluster$MultiAZ' => '

Specifies whether the DB cluster has instances in multiple Availability Zones.

', 'DBCluster$StorageEncrypted' => '

Specifies whether the DB cluster is encrypted.

', 'DBCluster$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DBCluster$DeletionProtection' => '

Indicates if the DB cluster has deletion protection enabled. The database can\'t be deleted when this value is set to true.

', 'DBCluster$HttpEndpointEnabled' => '

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'DBCluster$CopyTagsToSnapshot' => '

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

', 'DBClusterMember$IsClusterWriter' => '

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

', 'DBClusterSnapshot$StorageEncrypted' => '

Specifies whether the DB cluster snapshot is encrypted.

', 'DBClusterSnapshot$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DBEngineVersion$SupportsLogExportsToCloudwatchLogs' => '

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

', 'DBEngineVersion$SupportsReadReplica' => '

Indicates whether the database engine version supports read replicas.

', 'DBInstance$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment.

', 'DBInstance$AutoMinorVersionUpgrade' => '

Indicates that minor version patches are applied automatically.

', 'DBInstance$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

', 'DBInstance$StorageEncrypted' => '

Specifies whether the DB instance is encrypted.

', 'DBInstance$CopyTagsToSnapshot' => '

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

', 'DBInstance$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

', 'DBInstance$DeletionProtection' => '

Indicates if the DB instance has deletion protection enabled. The database can\'t be deleted when this value is set to true. For more information, see Deleting a DB Instance.

', 'DBInstanceAutomatedBackup$Encrypted' => '

Specifies whether the automated backup is encrypted.

', 'DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DBInstanceStatusInfo$Normal' => '

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

', 'DBSnapshot$Encrypted' => '

Specifies whether the DB snapshot is encrypted.

', 'DBSnapshot$IAMDatabaseAuthenticationEnabled' => '

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

', 'DeleteDBClusterMessage$SkipFinalSnapshot' => '

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

', 'DeleteDBInstanceMessage$SkipFinalSnapshot' => '

A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

', 'DescribeDBClusterSnapshotsMessage$IncludeShared' => '

True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

', 'DescribeDBClusterSnapshotsMessage$IncludePublic' => '

True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

', 'DescribeDBEngineVersionsMessage$DefaultOnly' => '

Indicates that only the default version of the specified engine or engine and major version combination is returned.

', 'DescribeDBSnapshotsMessage$IncludeShared' => '

True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

', 'DescribeDBSnapshotsMessage$IncludePublic' => '

True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

', 'DownloadDBLogFilePortionDetails$AdditionalDataPending' => '

Boolean value that if true, indicates there is more data to be downloaded.

', 'EventSubscription$Enabled' => '

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

', 'GlobalClusterMember$IsWriter' => '

Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

', 'ModifyDBClusterMessage$ApplyImmediately' => '

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

', 'ModifyDBInstanceMessage$ApplyImmediately' => '

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes are applied.

Default: false

', 'ModifyDBInstanceMessage$AllowMajorVersionUpgrade' => '

Indicates that major version upgrades are allowed. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance\'s current version.

', 'ModifyOptionGroupMessage$ApplyImmediately' => '

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

', 'Option$Persistent' => '

Indicate if this option is persistent.

', 'Option$Permanent' => '

Indicate if this option is permanent.

', 'OptionGroup$AllowsVpcAndNonVpcInstanceMemberships' => '

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

', 'OptionGroupOption$PortRequired' => '

Specifies whether the option requires a port.

', 'OptionGroupOption$Persistent' => '

Persistent options can\'t be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

', 'OptionGroupOption$Permanent' => '

Permanent options can never be removed from an option group. An option group containing a permanent option can\'t be removed from a DB instance.

', 'OptionGroupOption$RequiresAutoMinorEngineVersionUpgrade' => '

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

', 'OptionGroupOption$VpcOnly' => '

If true, you can only use this option with a DB instance that is in a VPC.

', 'OptionGroupOptionSetting$IsModifiable' => '

Boolean value where true indicates that this option group option can be changed from the default value.

', 'OptionGroupOptionSetting$IsRequired' => '

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

', 'OptionSetting$IsModifiable' => '

A Boolean value that, when true, indicates the option setting can be modified from the default.

', 'OptionSetting$IsCollection' => '

Indicates if the option setting is part of a collection.

', 'OptionVersion$IsDefault' => '

True if the version is the default version of the option, and otherwise false.

', 'OrderableDBInstanceOption$MultiAZCapable' => '

Indicates whether a DB instance is Multi-AZ capable.

', 'OrderableDBInstanceOption$ReadReplicaCapable' => '

Indicates whether a DB instance can have a Read Replica.

', 'OrderableDBInstanceOption$Vpc' => '

Indicates whether a DB instance is in a VPC.

', 'OrderableDBInstanceOption$SupportsStorageEncryption' => '

Indicates whether a DB instance supports encrypted storage.

', 'OrderableDBInstanceOption$SupportsIops' => '

Indicates whether a DB instance supports provisioned IOPS.

', 'OrderableDBInstanceOption$SupportsEnhancedMonitoring' => '

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

', 'OrderableDBInstanceOption$SupportsIAMDatabaseAuthentication' => '

Indicates whether a DB instance supports IAM database authentication.

', 'OrderableDBInstanceOption$SupportsPerformanceInsights' => '

True if a DB instance supports Performance Insights, otherwise false.

', 'Parameter$IsModifiable' => '

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

', 'ReservedDBInstance$MultiAZ' => '

Indicates if the reservation applies to Multi-AZ deployments.

', 'ReservedDBInstancesOffering$MultiAZ' => '

Indicates if the offering applies to Multi-AZ deployments.

', 'ResetDBClusterParameterGroupMessage$ResetAllParameters' => '

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.

', 'ResetDBParameterGroupMessage$ResetAllParameters' => '

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

', 'RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime' => '

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Can\'t be specified if RestoreToTime parameter is provided.

', 'RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime' => '

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Can\'t be specified if RestoreTime parameter is provided.

', 'UpgradeTarget$AutoUpgrade' => '

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

', 'UpgradeTarget$IsMajorVersionUpgrade' => '

A value that indicates whether a database engine is upgraded to a major version.

', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$Force' => '

A value that, if specified, forces the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

', 'BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable' => '

If BacktrackTo is set to a timestamp earlier than the earliest backtrack time, this value backtracks the DB cluster to the earliest possible backtrack time. Otherwise, an error occurs.

', 'CopyDBClusterSnapshotMessage$CopyTags' => '

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

', 'CopyDBSnapshotMessage$CopyTags' => '

True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false.

', 'CreateDBClusterMessage$StorageEncrypted' => '

Specifies whether the DB cluster is encrypted.

', 'CreateDBClusterMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'CreateDBClusterMessage$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'CreateDBClusterMessage$CopyTagsToSnapshot' => '

True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.

', 'CreateDBInstanceMessage$MultiAZ' => '

A value that specifies whether the DB instance is a Multi-AZ deployment. You can\'t set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

', 'CreateDBInstanceMessage$AutoMinorVersionUpgrade' => '

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

', 'CreateDBInstanceMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies:

  • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

', 'CreateDBInstanceMessage$StorageEncrypted' => '

Specifies whether the DB instance is encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

Default: false

', 'CreateDBInstanceMessage$CopyTagsToSnapshot' => '

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see CreateDBCluster.

', 'CreateDBInstanceMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'CreateDBInstanceMessage$EnablePerformanceInsights' => '

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

', 'CreateDBInstanceMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'CreateDBInstanceReadReplicaMessage$MultiAZ' => '

Specifies whether the Read Replica is in a Multi-AZ deployment.

You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

', 'CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade' => '

Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

', 'CreateDBInstanceReadReplicaMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot' => '

True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.

', 'CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora MySQL 5.6 or higher

Default: false

', 'CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights' => '

True to enable Performance Insights for the read replica, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

', 'CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'CreateDBInstanceReadReplicaMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'CreateEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

', 'CreateGlobalClusterMessage$DeletionProtection' => '

The deletion protection setting for the new global database. The global database can\'t be deleted when this value is set to true.

', 'CreateGlobalClusterMessage$StorageEncrypted' => '

The storage encryption setting for the new global database cluster.

', 'DBInstance$PerformanceInsightsEnabled' => '

True if Performance Insights is enabled for the DB instance, and otherwise false.

', 'DeleteDBInstanceMessage$DeleteAutomatedBackups' => '

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn\'t case-sensitive. This parameter defaults to true.

', 'DescribeDBEngineVersionsMessage$ListSupportedCharacterSets' => '

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

', 'DescribeDBEngineVersionsMessage$ListSupportedTimezones' => '

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$Vpc' => '

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

', 'DescribeReservedDBInstancesMessage$MultiAZ' => '

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

', 'DescribeReservedDBInstancesOfferingsMessage$MultiAZ' => '

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

', 'GlobalCluster$StorageEncrypted' => '

The storage encryption setting for the global database cluster.

', 'GlobalCluster$DeletionProtection' => '

The deletion protection setting for the new global database cluster.

', 'ModifyDBClusterMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'ModifyDBClusterMessage$DeletionProtection' => '

Indicates if the DB cluster has deletion protection enabled. The database can\'t be deleted when this value is set to true.

', 'ModifyDBClusterMessage$EnableHttpEndpoint' => '

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'ModifyDBClusterMessage$CopyTagsToSnapshot' => '

True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.

', 'ModifyDBInstanceMessage$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn\'t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

', 'ModifyDBInstanceMessage$AutoMinorVersionUpgrade' => '

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn\'t result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

', 'ModifyDBInstanceMessage$CopyTagsToSnapshot' => '

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.

', 'ModifyDBInstanceMessage$PubliclyAccessible' => '

Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Default: false

', 'ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'ModifyDBInstanceMessage$EnablePerformanceInsights' => '

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

', 'ModifyDBInstanceMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'ModifyDBInstanceMessage$DeletionProtection' => '

Indicates if the DB instance has deletion protection enabled. The database can\'t be deleted when this value is set to true. For more information, see Deleting a DB Instance.

', 'ModifyEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription.

', 'ModifyGlobalClusterMessage$DeletionProtection' => '

Indicates if the global database cluster has deletion protection enabled. The global database cluster can\'t be deleted when this value is set to true.

', 'OptionGroupOption$SupportsOptionVersionDowngrade' => '

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

', 'PendingModifiedValues$MultiAZ' => '

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

', 'RebootDBInstanceMessage$ForceFailover' => '

When true, the reboot is conducted through a MultiAZ failover.

Constraint: You can\'t specify true if the instance is not configured for MultiAZ.

', 'RestoreDBClusterFromS3Message$StorageEncrypted' => '

Specifies whether the restored DB cluster is encrypted.

', 'RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBClusterFromS3Message$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'RestoreDBClusterFromS3Message$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

', 'RestoreDBClusterFromSnapshotMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBClusterFromSnapshotMessage$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

', 'RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBClusterToPointInTimeMessage$DeletionProtection' => '

Indicates if the DB cluster should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false.

', 'RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

', 'RestoreDBInstanceFromDBSnapshotMessage$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

', 'RestoreDBInstanceFromDBSnapshotMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade' => '

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

', 'RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.

', 'RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'RestoreDBInstanceFromS3Message$MultiAZ' => '

Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can\'t set the AvailabilityZone parameter.

', 'RestoreDBInstanceFromS3Message$AutoMinorVersionUpgrade' => '

True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.

Default: true

', 'RestoreDBInstanceFromS3Message$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'RestoreDBInstanceFromS3Message$StorageEncrypted' => '

Specifies whether the new DB instance is encrypted or not.

', 'RestoreDBInstanceFromS3Message$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false.

Default: false.

', 'RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

', 'RestoreDBInstanceFromS3Message$EnablePerformanceInsights' => '

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

', 'RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'RestoreDBInstanceFromS3Message$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'RestoreDBInstanceToPointInTimeMessage$MultiAZ' => '

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

', 'RestoreDBInstanceToPointInTimeMessage$PubliclyAccessible' => '

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

', 'RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade' => '

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

', 'RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot' => '

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.

', 'RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication' => '

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

Default: false

', 'RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures' => '

A value that specifies that the DB instance class of the DB instance uses its default processor features.

', 'RestoreDBInstanceToPointInTimeMessage$DeletionProtection' => '

Indicates if the DB instance should have deletion protection enabled. The database can\'t be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

', 'ScalingConfiguration$AutoPause' => '

A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it\'s idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

', 'ScalingConfigurationInfo$AutoPause' => '

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

', ], ], 'Certificate' => [ 'base' => '

A CA certificate for an AWS account.

', 'refs' => [ 'CertificateList$member' => NULL, ], ], 'CertificateList' => [ 'base' => NULL, 'refs' => [ 'CertificateMessage$Certificates' => '

The list of Certificate objects for the AWS account.

', ], ], 'CertificateMessage' => [ 'base' => '

Data returned by the DescribeCertificates action.

', 'refs' => [], ], 'CertificateNotFoundFault' => [ 'base' => '

CertificateIdentifier doesn\'t refer to an existing certificate.

', 'refs' => [], ], 'CharacterSet' => [ 'base' => '

This data type is used as a response element in the action DescribeDBEngineVersions.

', 'refs' => [ 'DBEngineVersion$DefaultCharacterSet' => '

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

', 'SupportedCharacterSetsList$member' => NULL, ], ], 'CloudwatchLogsExportConfiguration' => [ 'base' => '

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', 'refs' => [ 'ModifyDBClusterMessage$CloudwatchLogsExportConfiguration' => '

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

', 'ModifyDBInstanceMessage$CloudwatchLogsExportConfiguration' => '

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CopyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBInstanceReadReplicaMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSecurityGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSecurityGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'CreateOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DBCluster' => [ 'base' => '

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

', 'refs' => [ 'CreateDBClusterResult$DBCluster' => NULL, 'DBClusterList$member' => NULL, 'DeleteDBClusterResult$DBCluster' => NULL, 'FailoverDBClusterResult$DBCluster' => NULL, 'ModifyDBClusterResult$DBCluster' => NULL, 'PromoteReadReplicaDBClusterResult$DBCluster' => NULL, 'RestoreDBClusterFromS3Result$DBCluster' => NULL, 'RestoreDBClusterFromSnapshotResult$DBCluster' => NULL, 'RestoreDBClusterToPointInTimeResult$DBCluster' => NULL, 'StartDBClusterResult$DBCluster' => NULL, 'StopDBClusterResult$DBCluster' => NULL, ], ], 'DBClusterAlreadyExistsFault' => [ 'base' => '

The user already has a DB cluster with the given identifier.

', 'refs' => [], ], 'DBClusterBacktrack' => [ 'base' => '

This data type is used as a response element in the DescribeDBClusterBacktracks action.

', 'refs' => [ 'DBClusterBacktrackList$member' => NULL, ], ], 'DBClusterBacktrackList' => [ 'base' => NULL, 'refs' => [ 'DBClusterBacktrackMessage$DBClusterBacktracks' => '

Contains a list of backtracks for the user.

', ], ], 'DBClusterBacktrackMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

', 'refs' => [], ], 'DBClusterBacktrackNotFoundFault' => [ 'base' => '

BacktrackIdentifier doesn\'t refer to an existing backtrack.

', 'refs' => [], ], 'DBClusterCapacityInfo' => [ 'base' => NULL, 'refs' => [], ], 'DBClusterEndpoint' => [ 'base' => '

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

', 'refs' => [ 'DBClusterEndpointList$member' => NULL, ], ], 'DBClusterEndpointAlreadyExistsFault' => [ 'base' => '

The specified custom endpoint can\'t be created because it already exists.

', 'refs' => [], ], 'DBClusterEndpointList' => [ 'base' => NULL, 'refs' => [ 'DBClusterEndpointMessage$DBClusterEndpoints' => '

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

', ], ], 'DBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DBClusterEndpointNotFoundFault' => [ 'base' => '

The specified custom endpoint doesn\'t exist.

', 'refs' => [], ], 'DBClusterEndpointQuotaExceededFault' => [ 'base' => '

The cluster already has the maximum number of custom endpoints.

', 'refs' => [], ], 'DBClusterList' => [ 'base' => NULL, 'refs' => [ 'DBClusterMessage$DBClusters' => '

Contains a list of DB clusters for the user.

', ], ], 'DBClusterMember' => [ 'base' => '

Contains information about an instance that is part of a DB cluster.

', 'refs' => [ 'DBClusterMemberList$member' => NULL, ], ], 'DBClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterMembers' => '

Provides the list of instances that make up the DB cluster.

', ], ], 'DBClusterMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBClusters action.

', 'refs' => [], ], 'DBClusterNotFoundFault' => [ 'base' => '

DBClusterIdentifier doesn\'t refer to an existing DB cluster.

', 'refs' => [], ], 'DBClusterOptionGroupMemberships' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterOptionGroupMemberships' => '

Provides the list of option group memberships for this DB cluster.

', ], ], 'DBClusterOptionGroupStatus' => [ 'base' => '

Contains status information for a DB cluster option group.

', 'refs' => [ 'DBClusterOptionGroupMemberships$member' => NULL, ], ], 'DBClusterParameterGroup' => [ 'base' => '

Contains the details of an Amazon RDS DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

', 'refs' => [ 'CopyDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'CreateDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'DBClusterParameterGroupList$member' => NULL, ], ], 'DBClusterParameterGroupDetails' => [ 'base' => '

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

', 'refs' => [], ], 'DBClusterParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupsMessage$DBClusterParameterGroups' => '

A list of DB cluster parameter groups.

', ], ], 'DBClusterParameterGroupNameMessage' => [ 'base' => '

', 'refs' => [], ], 'DBClusterParameterGroupNotFoundFault' => [ 'base' => '

DBClusterParameterGroupName doesn\'t refer to an existing DB cluster parameter group.

', 'refs' => [], ], 'DBClusterParameterGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DBClusterQuotaExceededFault' => [ 'base' => '

The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

', 'refs' => [], ], 'DBClusterRole' => [ 'base' => '

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

', 'refs' => [ 'DBClusterRoles$member' => NULL, ], ], 'DBClusterRoleAlreadyExistsFault' => [ 'base' => '

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

', 'refs' => [], ], 'DBClusterRoleNotFoundFault' => [ 'base' => '

The specified IAM role Amazon Resource Name (ARN) isn\'t associated with the specified DB cluster.

', 'refs' => [], ], 'DBClusterRoleQuotaExceededFault' => [ 'base' => '

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

', 'refs' => [], ], 'DBClusterRoles' => [ 'base' => NULL, 'refs' => [ 'DBCluster$AssociatedRoles' => '

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

', ], ], 'DBClusterSnapshot' => [ 'base' => '

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

', 'refs' => [ 'CopyDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'CreateDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'DBClusterSnapshotList$member' => NULL, 'DeleteDBClusterSnapshotResult$DBClusterSnapshot' => NULL, ], ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'base' => '

The user already has a DB cluster snapshot with the given identifier.

', 'refs' => [], ], 'DBClusterSnapshotAttribute' => [ 'base' => '

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

', 'refs' => [ 'DBClusterSnapshotAttributeList$member' => NULL, ], ], 'DBClusterSnapshotAttributeList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttributesResult$DBClusterSnapshotAttributes' => '

The list of attributes and values for the manual DB cluster snapshot.

', ], ], 'DBClusterSnapshotAttributesResult' => [ 'base' => '

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

', 'refs' => [ 'DescribeDBClusterSnapshotAttributesResult$DBClusterSnapshotAttributesResult' => NULL, 'ModifyDBClusterSnapshotAttributeResult$DBClusterSnapshotAttributesResult' => NULL, ], ], 'DBClusterSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotMessage$DBClusterSnapshots' => '

Provides a list of DB cluster snapshots for the user.

', ], ], 'DBClusterSnapshotMessage' => [ 'base' => '

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

', 'refs' => [], ], 'DBClusterSnapshotNotFoundFault' => [ 'base' => '

DBClusterSnapshotIdentifier doesn\'t refer to an existing DB cluster snapshot.

', 'refs' => [], ], 'DBEngineVersion' => [ 'base' => '

This data type is used as a response element in the action DescribeDBEngineVersions.

', 'refs' => [ 'DBEngineVersionList$member' => NULL, ], ], 'DBEngineVersionList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersionMessage$DBEngineVersions' => '

A list of DBEngineVersion elements.

', ], ], 'DBEngineVersionMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

', 'refs' => [], ], 'DBInstance' => [ 'base' => '

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

', 'refs' => [ 'CreateDBInstanceReadReplicaResult$DBInstance' => NULL, 'CreateDBInstanceResult$DBInstance' => NULL, 'DBInstanceList$member' => NULL, 'DeleteDBInstanceResult$DBInstance' => NULL, 'ModifyDBInstanceResult$DBInstance' => NULL, 'PromoteReadReplicaResult$DBInstance' => NULL, 'RebootDBInstanceResult$DBInstance' => NULL, 'RestoreDBInstanceFromDBSnapshotResult$DBInstance' => NULL, 'RestoreDBInstanceFromS3Result$DBInstance' => NULL, 'RestoreDBInstanceToPointInTimeResult$DBInstance' => NULL, 'StartDBInstanceResult$DBInstance' => NULL, 'StopDBInstanceResult$DBInstance' => NULL, ], ], 'DBInstanceAlreadyExistsFault' => [ 'base' => '

The user already has a DB instance with the given identifier.

', 'refs' => [], ], 'DBInstanceAutomatedBackup' => [ 'base' => '

An automated backup of a DB instance. It it consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

', 'refs' => [ 'DBInstanceAutomatedBackupList$member' => NULL, 'DeleteDBInstanceAutomatedBackupResult$DBInstanceAutomatedBackup' => NULL, ], ], 'DBInstanceAutomatedBackupList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceAutomatedBackupMessage$DBInstanceAutomatedBackups' => '

A list of DBInstanceAutomatedBackup instances.

', ], ], 'DBInstanceAutomatedBackupMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

', 'refs' => [], ], 'DBInstanceAutomatedBackupNotFoundFault' => [ 'base' => '

No automated backup for this DB instance was found.

', 'refs' => [], ], 'DBInstanceAutomatedBackupQuotaExceededFault' => [ 'base' => '

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

', 'refs' => [], ], 'DBInstanceList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceMessage$DBInstances' => '

A list of DBInstance instances.

', ], ], 'DBInstanceMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBInstances action.

', 'refs' => [], ], 'DBInstanceNotFoundFault' => [ 'base' => '

DBInstanceIdentifier doesn\'t refer to an existing DB instance.

', 'refs' => [], ], 'DBInstanceRole' => [ 'base' => '

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.

', 'refs' => [ 'DBInstanceRoles$member' => NULL, ], ], 'DBInstanceRoleAlreadyExistsFault' => [ 'base' => '

The specified RoleArn or FeatureName value is already associated with the DB instance.

', 'refs' => [], ], 'DBInstanceRoleNotFoundFault' => [ 'base' => '

The specified RoleArn value doesn\'t match the specifed feature for the DB instance.

', 'refs' => [], ], 'DBInstanceRoleQuotaExceededFault' => [ 'base' => '

You can\'t associate any more AWS Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

', 'refs' => [], ], 'DBInstanceRoles' => [ 'base' => NULL, 'refs' => [ 'DBInstance$AssociatedRoles' => '

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

', ], ], 'DBInstanceStatusInfo' => [ 'base' => '

Provides a list of status information for a DB instance.

', 'refs' => [ 'DBInstanceStatusInfoList$member' => NULL, ], ], 'DBInstanceStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$StatusInfos' => '

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

', ], ], 'DBLogFileNotFoundFault' => [ 'base' => '

LogFileName doesn\'t refer to an existing DB log file.

', 'refs' => [], ], 'DBParameterGroup' => [ 'base' => '

Contains the details of an Amazon RDS DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

', 'refs' => [ 'CopyDBParameterGroupResult$DBParameterGroup' => NULL, 'CreateDBParameterGroupResult$DBParameterGroup' => NULL, 'DBParameterGroupList$member' => NULL, ], ], 'DBParameterGroupAlreadyExistsFault' => [ 'base' => '

A DB parameter group with the same name exists.

', 'refs' => [], ], 'DBParameterGroupDetails' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBParameters action.

', 'refs' => [], ], 'DBParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBParameterGroupsMessage$DBParameterGroups' => '

A list of DBParameterGroup instances.

', ], ], 'DBParameterGroupNameMessage' => [ 'base' => '

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

', 'refs' => [], ], 'DBParameterGroupNotFoundFault' => [ 'base' => '

DBParameterGroupName doesn\'t refer to an existing DB parameter group.

', 'refs' => [], ], 'DBParameterGroupQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB parameter groups.

', 'refs' => [], ], 'DBParameterGroupStatus' => [ 'base' => '

The status of the DB parameter group.

This data type is used as a response element in the following actions:

', 'refs' => [ 'DBParameterGroupStatusList$member' => NULL, ], ], 'DBParameterGroupStatusList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$DBParameterGroups' => '

Provides the list of DB parameter groups applied to this DB instance.

', ], ], 'DBParameterGroupsMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

', 'refs' => [], ], 'DBSecurityGroup' => [ 'base' => '

Contains the details for an Amazon RDS DB security group.

This data type is used as a response element in the DescribeDBSecurityGroups action.

', 'refs' => [ 'AuthorizeDBSecurityGroupIngressResult$DBSecurityGroup' => NULL, 'CreateDBSecurityGroupResult$DBSecurityGroup' => NULL, 'DBSecurityGroups$member' => NULL, 'RevokeDBSecurityGroupIngressResult$DBSecurityGroup' => NULL, ], ], 'DBSecurityGroupAlreadyExistsFault' => [ 'base' => '

A DB security group with the name specified in DBSecurityGroupName already exists.

', 'refs' => [], ], 'DBSecurityGroupMembership' => [ 'base' => '

This data type is used as a response element in the following actions:

', 'refs' => [ 'DBSecurityGroupMembershipList$member' => NULL, ], ], 'DBSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$DBSecurityGroups' => '

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

', 'Option$DBSecurityGroupMemberships' => '

If the option requires access to a port, then this DB security group allows access to the port.

', ], ], 'DBSecurityGroupMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

', 'refs' => [], ], 'DBSecurityGroupNameList' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceMessage$DBSecurityGroups' => '

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

', 'ModifyDBInstanceMessage$DBSecurityGroups' => '

A list of DB security groups to authorize on this DB instance. Changing this setting doesn\'t result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

', 'OptionConfiguration$DBSecurityGroupMemberships' => '

A list of DBSecurityGroupMemebrship name strings used for this option.

', 'RestoreDBInstanceFromS3Message$DBSecurityGroups' => '

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

', ], ], 'DBSecurityGroupNotFoundFault' => [ 'base' => '

DBSecurityGroupName doesn\'t refer to an existing DB security group.

', 'refs' => [], ], 'DBSecurityGroupNotSupportedFault' => [ 'base' => '

A DB security group isn\'t allowed for this action.

', 'refs' => [], ], 'DBSecurityGroupQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB security groups.

', 'refs' => [], ], 'DBSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroupMessage$DBSecurityGroups' => '

A list of DBSecurityGroup instances.

', ], ], 'DBSnapshot' => [ 'base' => '

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

', 'refs' => [ 'CopyDBSnapshotResult$DBSnapshot' => NULL, 'CreateDBSnapshotResult$DBSnapshot' => NULL, 'DBSnapshotList$member' => NULL, 'DeleteDBSnapshotResult$DBSnapshot' => NULL, 'ModifyDBSnapshotResult$DBSnapshot' => NULL, ], ], 'DBSnapshotAlreadyExistsFault' => [ 'base' => '

DBSnapshotIdentifier is already used by an existing snapshot.

', 'refs' => [], ], 'DBSnapshotAttribute' => [ 'base' => '

Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other AWS accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

', 'refs' => [ 'DBSnapshotAttributeList$member' => NULL, ], ], 'DBSnapshotAttributeList' => [ 'base' => NULL, 'refs' => [ 'DBSnapshotAttributesResult$DBSnapshotAttributes' => '

The list of attributes and values for the manual DB snapshot.

', ], ], 'DBSnapshotAttributesResult' => [ 'base' => '

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

', 'refs' => [ 'DescribeDBSnapshotAttributesResult$DBSnapshotAttributesResult' => NULL, 'ModifyDBSnapshotAttributeResult$DBSnapshotAttributesResult' => NULL, ], ], 'DBSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DBSnapshotMessage$DBSnapshots' => '

A list of DBSnapshot instances.

', ], ], 'DBSnapshotMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBSnapshots action.

', 'refs' => [], ], 'DBSnapshotNotFoundFault' => [ 'base' => '

DBSnapshotIdentifier doesn\'t refer to an existing DB snapshot.

', 'refs' => [], ], 'DBSubnetGroup' => [ 'base' => '

Contains the details of an Amazon RDS DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

', 'refs' => [ 'CreateDBSubnetGroupResult$DBSubnetGroup' => NULL, 'DBInstance$DBSubnetGroup' => '

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

', 'DBSubnetGroups$member' => NULL, 'ModifyDBSubnetGroupResult$DBSubnetGroup' => NULL, ], ], 'DBSubnetGroupAlreadyExistsFault' => [ 'base' => '

DBSubnetGroupName is already used by an existing DB subnet group.

', 'refs' => [], ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'base' => '

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

', 'refs' => [], ], 'DBSubnetGroupMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

', 'refs' => [], ], 'DBSubnetGroupNotAllowedFault' => [ 'base' => '

The DBSubnetGroup shouldn\'t be specified while creating read replicas that lie in the same region as the source instance.

', 'refs' => [], ], 'DBSubnetGroupNotFoundFault' => [ 'base' => '

DBSubnetGroupName doesn\'t refer to an existing DB subnet group.

', 'refs' => [], ], 'DBSubnetGroupQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB subnet groups.

', 'refs' => [], ], 'DBSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroupMessage$DBSubnetGroups' => '

A list of DBSubnetGroup instances.

', ], ], 'DBSubnetQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

', 'refs' => [], ], 'DBUpgradeDependencyFailureFault' => [ 'base' => '

The DB upgrade failed because a resource the DB depends on can\'t be modified.

', 'refs' => [], ], 'DeleteDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceAutomatedBackupMessage' => [ 'base' => '

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

', 'refs' => [], ], 'DeleteDBInstanceAutomatedBackupResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSecurityGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'DeleteEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeAccountAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeCertificatesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterBacktracksMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterEndpointsMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterSnapshotsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBClustersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBEngineVersionsMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBInstanceAutomatedBackupsMessage' => [ 'base' => '

Parameter input for DescribeDBInstanceAutomatedBackups.

', 'refs' => [], ], 'DescribeDBInstancesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBLogFilesDetails' => [ 'base' => '

This data type is used as a response element to DescribeDBLogFiles.

', 'refs' => [ 'DescribeDBLogFilesList$member' => NULL, ], ], 'DescribeDBLogFilesList' => [ 'base' => NULL, 'refs' => [ 'DescribeDBLogFilesResponse$DescribeDBLogFiles' => '

The DB log files returned.

', ], ], 'DescribeDBLogFilesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBLogFilesResponse' => [ 'base' => '

The response from a call to DescribeDBLogFiles.

', 'refs' => [], ], 'DescribeDBParameterGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBParametersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBSecurityGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSnapshotAttributesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBSnapshotsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeDBSubnetGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEngineDefaultParametersMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEngineDefaultParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventCategoriesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEventSubscriptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeEventsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeGlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOptionGroupOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeOptionGroupsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribePendingMaintenanceActionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeReservedDBInstancesMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeReservedDBInstancesOfferingsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeSourceRegionsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeValidDBInstanceModificationsMessage' => [ 'base' => '

', 'refs' => [], ], 'DescribeValidDBInstanceModificationsResult' => [ 'base' => NULL, 'refs' => [], ], 'DomainMembership' => [ 'base' => '

An Active Directory Domain membership record associated with the DB instance.

', 'refs' => [ 'DomainMembershipList$member' => NULL, ], ], 'DomainMembershipList' => [ 'base' => '

List of Active Directory Domain membership records associated with a DB instance.

', 'refs' => [ 'DBInstance$DomainMemberships' => '

The Active Directory Domain membership records associated with the DB instance.

', ], ], 'DomainNotFoundFault' => [ 'base' => '

Domain doesn\'t refer to an existing Active Directory domain.

', 'refs' => [], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'DoubleRange$From' => '

The minimum value in the range.

', 'DoubleRange$To' => '

The maximum value in the range.

', 'RecurringCharge$RecurringChargeAmount' => '

The amount of the recurring charge.

', 'ReservedDBInstance$FixedPrice' => '

The fixed price charged for this reserved DB instance.

', 'ReservedDBInstance$UsagePrice' => '

The hourly price charged for this reserved DB instance.

', 'ReservedDBInstancesOffering$FixedPrice' => '

The fixed price charged for this offering.

', 'ReservedDBInstancesOffering$UsagePrice' => '

The hourly price charged for this offering.

', ], ], 'DoubleOptional' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$MinIopsPerGib' => '

Minimum provisioned IOPS per GiB for a DB instance.

', 'OrderableDBInstanceOption$MaxIopsPerGib' => '

Maximum provisioned IOPS per GiB for a DB instance.

', ], ], 'DoubleRange' => [ 'base' => '

A range of double values.

', 'refs' => [ 'DoubleRangeList$member' => NULL, ], ], 'DoubleRangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$IopsToStorageRatio' => '

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

', ], ], 'DownloadDBLogFilePortionDetails' => [ 'base' => '

This data type is used as a response element to DownloadDBLogFilePortion.

', 'refs' => [], ], 'DownloadDBLogFilePortionMessage' => [ 'base' => '

', 'refs' => [], ], 'EC2SecurityGroup' => [ 'base' => '

This data type is used as a response element in the following actions:

', 'refs' => [ 'EC2SecurityGroupList$member' => NULL, ], ], 'EC2SecurityGroupList' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroup$EC2SecurityGroups' => '

Contains a list of EC2SecurityGroup elements.

', ], ], 'Endpoint' => [ 'base' => '

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

', 'refs' => [ 'DBInstance$Endpoint' => '

Specifies the connection endpoint.

', 'DBInstance$ListenerEndpoint' => '

Specifies the listener connection endpoint for SQL Server Always On.

', ], ], 'EngineDefaults' => [ 'base' => '

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

', 'refs' => [ 'DescribeEngineDefaultClusterParametersResult$EngineDefaults' => NULL, 'DescribeEngineDefaultParametersResult$EngineDefaults' => NULL, ], ], 'EngineModeList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedEngineModes' => '

A list of the supported DB engine modes.

', 'OrderableDBInstanceOption$SupportedEngineModes' => '

A list of the supported DB engine modes.

', 'Parameter$SupportedEngineModes' => '

The valid DB engine modes.

', ], ], 'Event' => [ 'base' => '

This data type is used as a response element in the DescribeEvents action.

', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCategoriesList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

', 'DescribeEventsMessage$EventCategories' => '

A list of event categories that trigger notifications for a event notification subscription.

', 'Event$EventCategories' => '

Specifies the category for the event.

', 'EventCategoriesMap$EventCategories' => '

The event categories for the specified source type

', 'EventSubscription$EventCategoriesList' => '

A list of event categories for the RDS event notification subscription.

', 'ModifyEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

', ], ], 'EventCategoriesMap' => [ 'base' => '

Contains the results of a successful invocation of the DescribeEventCategories action.

', 'refs' => [ 'EventCategoriesMapList$member' => NULL, ], ], 'EventCategoriesMapList' => [ 'base' => NULL, 'refs' => [ 'EventCategoriesMessage$EventCategoriesMapList' => '

A list of EventCategoriesMap data types.

', ], ], 'EventCategoriesMessage' => [ 'base' => '

Data returned from the DescribeEventCategories action.

', 'refs' => [], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'EventsMessage$Events' => '

A list of Event instances.

', ], ], 'EventSubscription' => [ 'base' => '

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

', 'refs' => [ 'AddSourceIdentifierToSubscriptionResult$EventSubscription' => NULL, 'CreateEventSubscriptionResult$EventSubscription' => NULL, 'DeleteEventSubscriptionResult$EventSubscription' => NULL, 'EventSubscriptionsList$member' => NULL, 'ModifyEventSubscriptionResult$EventSubscription' => NULL, 'RemoveSourceIdentifierFromSubscriptionResult$EventSubscription' => NULL, ], ], 'EventSubscriptionQuotaExceededFault' => [ 'base' => '

You have reached the maximum number of event subscriptions.

', 'refs' => [], ], 'EventSubscriptionsList' => [ 'base' => NULL, 'refs' => [ 'EventSubscriptionsMessage$EventSubscriptionsList' => '

A list of EventSubscriptions data types.

', ], ], 'EventSubscriptionsMessage' => [ 'base' => '

Data returned by the DescribeEventSubscriptions action.

', 'refs' => [], ], 'EventsMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeEvents action.

', 'refs' => [], ], 'FailoverDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'FailoverDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'FeatureNameList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedFeatureNames' => '

A list of features supported by the DB engine. Supported feature names include the following.

  • s3Import

', ], ], 'Filter' => [ 'base' => '

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeCertificatesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterBacktracksMessage$Filters' => '

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

  • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

  • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    • applying

    • completed

    • failed

    • pending

    The results list includes information about only the backtracks identified by these values. For more information about backtrack status values, see DBClusterBacktrack.

', 'DescribeDBClusterEndpointsMessage$Filters' => '

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

', 'DescribeDBClusterParameterGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterSnapshotsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClustersMessage$Filters' => '

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

', 'DescribeDBEngineVersionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBInstanceAutomatedBackupsMessage$Filters' => '

A filter that specifies which resources to return based on status.

Supported filters are the following:

  • status

    • active - automated backups for current instances

    • retained - automated backups for deleted instances

    • creating - automated backups that are waiting for the first automated snapshot to be available

  • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs.

  • dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

', 'DescribeDBInstancesMessage$Filters' => '

A filter that specifies one or more DB instances to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

', 'DescribeDBLogFilesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBParameterGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBSecurityGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBSnapshotsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBSubnetGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEngineDefaultClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEngineDefaultParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventCategoriesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventSubscriptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeGlobalClustersMessage$Filters' => '

A filter that specifies one or more global DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

', 'DescribeOptionGroupOptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeOptionGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeOrderableDBInstanceOptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribePendingMaintenanceActionsMessage$Filters' => '

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

', 'DescribeReservedDBInstancesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeReservedDBInstancesOfferingsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeSourceRegionsMessage$Filters' => '

This parameter is not currently supported.

', 'ListTagsForResourceMessage$Filters' => '

This parameter is not currently supported.

', ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more filter values. Filter values are case-sensitive.

', ], ], 'GlobalCluster' => [ 'base' => '

A data type representing an Aurora global database.

', 'refs' => [ 'CreateGlobalClusterResult$GlobalCluster' => NULL, 'DeleteGlobalClusterResult$GlobalCluster' => NULL, 'GlobalClusterList$member' => NULL, 'ModifyGlobalClusterResult$GlobalCluster' => NULL, 'RemoveFromGlobalClusterResult$GlobalCluster' => NULL, ], ], 'GlobalClusterAlreadyExistsFault' => [ 'base' => '

', 'refs' => [], ], 'GlobalClusterList' => [ 'base' => NULL, 'refs' => [ 'GlobalClustersMessage$GlobalClusters' => '

The list of global clusters returned by this request.

', ], ], 'GlobalClusterMember' => [ 'base' => '

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

', 'refs' => [ 'GlobalClusterMemberList$member' => NULL, ], ], 'GlobalClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalCluster$GlobalClusterMembers' => '

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

', ], ], 'GlobalClusterNotFoundFault' => [ 'base' => '

', 'refs' => [], ], 'GlobalClusterQuotaExceededFault' => [ 'base' => '

', 'refs' => [], ], 'GlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'IPRange' => [ 'base' => '

This data type is used as a response element in the DescribeDBSecurityGroups action.

', 'refs' => [ 'IPRangeList$member' => NULL, ], ], 'IPRangeList' => [ 'base' => NULL, 'refs' => [ 'DBSecurityGroup$IPRanges' => '

Contains a list of IPRange elements.

', ], ], 'InstanceQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB instances.

', 'refs' => [], ], 'InsufficientDBClusterCapacityFault' => [ 'base' => '

The DB cluster doesn\'t have enough capacity for the current operation.

', 'refs' => [], ], 'InsufficientDBInstanceCapacityFault' => [ 'base' => '

The specified DB instance class isn\'t available in the specified Availability Zone.

', 'refs' => [], ], 'InsufficientStorageClusterCapacityFault' => [ 'base' => '

There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshot$AllocatedStorage' => '

Specifies the allocated storage size in gibibytes (GiB).

', 'DBClusterSnapshot$Port' => '

Specifies the port that the DB cluster was listening on at the time of the snapshot.

', 'DBClusterSnapshot$PercentProgress' => '

Specifies the percentage of the estimated data that has been transferred.

', 'DBInstance$AllocatedStorage' => '

Specifies the allocated storage size specified in gibibytes.

', 'DBInstance$BackupRetentionPeriod' => '

Specifies the number of days for which automatic DB snapshots are retained.

', 'DBInstance$DbInstancePort' => '

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

', 'DBInstanceAutomatedBackup$AllocatedStorage' => '

Specifies the allocated storage size in gibibytes (GiB).

', 'DBInstanceAutomatedBackup$Port' => '

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

', 'DBSnapshot$AllocatedStorage' => '

Specifies the allocated storage size in gibibytes (GiB).

', 'DBSnapshot$Port' => '

Specifies the port that the database engine was listening on at the time of the snapshot.

', 'DBSnapshot$PercentProgress' => '

The percentage of the estimated data that has been transferred.

', 'DownloadDBLogFilePortionMessage$NumberOfLines' => '

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

  • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

  • If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.

  • If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

  • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

', 'Endpoint$Port' => '

Specifies the port that the database engine is listening on.

', 'Range$From' => '

The minimum value in the range.

', 'Range$To' => '

The maximum value in the range.

', 'ReservedDBInstance$Duration' => '

The duration of the reservation in seconds.

', 'ReservedDBInstance$DBInstanceCount' => '

The number of reserved DB instances.

', 'ReservedDBInstancesOffering$Duration' => '

The duration of the offering in seconds.

', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

', 'CreateDBClusterMessage$Port' => '

The port number on which the instances in the DB cluster accept connections.

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

', 'CreateDBInstanceMessage$AllocatedStorage' => '

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 32768.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

', 'CreateDBInstanceMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Can\'t be set to 0 if the DB instance is a source to Read Replicas

', 'CreateDBInstanceMessage$Port' => '

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

Type: Integer

', 'CreateDBInstanceMessage$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.

', 'CreateDBInstanceMessage$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

', 'CreateDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

', 'CreateDBInstanceMessage$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'CreateDBInstanceReadReplicaMessage$Port' => '

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

', 'CreateDBInstanceReadReplicaMessage$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

', 'CreateDBInstanceReadReplicaMessage$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

', 'CreateDBInstanceReadReplicaMessage$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'DBCluster$AllocatedStorage' => '

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

', 'DBCluster$BackupRetentionPeriod' => '

Specifies the number of days for which automatic DB snapshots are retained.

', 'DBCluster$Port' => '

Specifies the port that the database engine is listening on.

', 'DBCluster$Capacity' => '

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'DBClusterCapacityInfo$PendingCapacity' => '

A value that specifies the capacity that the DB cluster scales to next.

', 'DBClusterCapacityInfo$CurrentCapacity' => '

The current capacity of the DB cluster.

', 'DBClusterCapacityInfo$SecondsBeforeTimeout' => '

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

', 'DBClusterMember$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

', 'DBInstance$Iops' => '

Specifies the Provisioned IOPS (I/O operations per second) value.

', 'DBInstance$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

', 'DBInstance$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

', 'DBInstance$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'DBInstanceAutomatedBackup$Iops' => '

The IOPS (I/O operations per second) value for the automated backup.

', 'DBSnapshot$Iops' => '

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

', 'DescribeCertificatesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterBacktracksMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterEndpointsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterParameterGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterSnapshotsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBEngineVersionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBInstanceAutomatedBackupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

', 'DescribeDBInstancesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBLogFilesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

', 'DescribeDBParameterGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSecurityGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSnapshotsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSubnetGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEngineDefaultClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEngineDefaultParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventSubscriptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventsMessage$Duration' => '

The number of minutes to retrieve events for.

Default: 60

', 'DescribeEventsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeGlobalClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeOptionGroupOptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeOptionGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeOrderableDBInstanceOptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribePendingMaintenanceActionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeReservedDBInstancesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeReservedDBInstancesOfferingsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeSourceRegionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'ModifyCurrentDBClusterCapacityMessage$Capacity' => '

The DB cluster capacity.

Constraints:

  • Value must be 2, 4, 8, 16, 32, 64, 128, or 256.

', 'ModifyCurrentDBClusterCapacityMessage$SecondsBeforeTimeout' => '

The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

  • Value must be from 10 through 600.

', 'ModifyDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

', 'ModifyDBClusterMessage$Port' => '

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

', 'ModifyDBInstanceMessage$AllocatedStorage' => '

The new amount of storage (in gibibytes) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

', 'ModifyDBInstanceMessage$BackupRetentionPeriod' => '

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35

  • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 or later

  • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5

  • Can\'t be set to 0 if the DB instance is a source to Read Replicas

', 'ModifyDBInstanceMessage$Iops' => '

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn\'t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

', 'ModifyDBInstanceMessage$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

', 'ModifyDBInstanceMessage$DBPortNumber' => '

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid Values: 1150-65535

MariaDB

Default: 3306

Valid Values: 1150-65535

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

', 'ModifyDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

', 'ModifyDBInstanceMessage$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'Option$Port' => '

If required, the port configured for this option to use.

', 'OptionConfiguration$Port' => '

The optional port for the option.

', 'OptionGroupOption$DefaultPort' => '

If the option requires a port, specifies the default port for the option.

', 'OrderableDBInstanceOption$MinStorageSize' => '

Minimum storage size for a DB instance.

', 'OrderableDBInstanceOption$MaxStorageSize' => '

Maximum storage size for a DB instance.

', 'OrderableDBInstanceOption$MinIopsPerDbInstance' => '

Minimum total provisioned IOPS for a DB instance.

', 'OrderableDBInstanceOption$MaxIopsPerDbInstance' => '

Maximum total provisioned IOPS for a DB instance.

', 'PendingModifiedValues$AllocatedStorage' => '

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

', 'PendingModifiedValues$Port' => '

Specifies the pending port for the DB instance.

', 'PendingModifiedValues$BackupRetentionPeriod' => '

Specifies the pending number of days for which automated backups are retained.

', 'PendingModifiedValues$Iops' => '

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

', 'PromoteReadReplicaMessage$BackupRetentionPeriod' => '

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 8

', 'PurchaseReservedDBInstancesOfferingMessage$DBInstanceCount' => '

The number of instances to reserve.

Default: 1

', 'Range$Step' => '

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn\'t a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

', 'RestoreDBClusterFromS3Message$BackupRetentionPeriod' => '

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

', 'RestoreDBClusterFromS3Message$Port' => '

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

', 'RestoreDBClusterFromSnapshotMessage$Port' => '

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$Port' => '

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

', 'RestoreDBInstanceFromDBSnapshotMessage$Port' => '

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

', 'RestoreDBInstanceFromDBSnapshotMessage$Iops' => '

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

', 'RestoreDBInstanceFromS3Message$AllocatedStorage' => '

The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

', 'RestoreDBInstanceFromS3Message$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

', 'RestoreDBInstanceFromS3Message$Port' => '

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

', 'RestoreDBInstanceFromS3Message$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

', 'RestoreDBInstanceFromS3Message$MonitoringInterval' => '

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: 0

', 'RestoreDBInstanceFromS3Message$PerformanceInsightsRetentionPeriod' => '

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

', 'RestoreDBInstanceToPointInTimeMessage$Port' => '

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$Iops' => '

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

', 'ScalingConfiguration$MinCapacity' => '

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

', 'ScalingConfiguration$MaxCapacity' => '

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

', 'ScalingConfiguration$SecondsUntilAutoPause' => '

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

', 'ScalingConfigurationInfo$MinCapacity' => '

The maximum capacity for the Aurora DB cluster in serverless DB engine mode.

', 'ScalingConfigurationInfo$MaxCapacity' => '

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

', 'ScalingConfigurationInfo$SecondsUntilAutoPause' => '

The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it\'s idle (it has no connections).

', ], ], 'InvalidDBClusterCapacityFault' => [ 'base' => '

Capacity isn\'t a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

', 'refs' => [], ], 'InvalidDBClusterEndpointStateFault' => [ 'base' => '

The requested operation can\'t be performed on the endpoint while the endpoint is in this state.

', 'refs' => [], ], 'InvalidDBClusterSnapshotStateFault' => [ 'base' => '

The supplied value isn\'t a valid DB cluster snapshot state.

', 'refs' => [], ], 'InvalidDBClusterStateFault' => [ 'base' => '

The requested operation can\'t be performed while the cluster is in this state.

', 'refs' => [], ], 'InvalidDBInstanceAutomatedBackupStateFault' => [ 'base' => '

The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

', 'refs' => [], ], 'InvalidDBInstanceStateFault' => [ 'base' => '

The DB instance isn\'t in a valid state.

', 'refs' => [], ], 'InvalidDBParameterGroupStateFault' => [ 'base' => '

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can\'t delete it when the parameter group is in this state.

', 'refs' => [], ], 'InvalidDBSecurityGroupStateFault' => [ 'base' => '

The state of the DB security group doesn\'t allow deletion.

', 'refs' => [], ], 'InvalidDBSnapshotStateFault' => [ 'base' => '

The state of the DB snapshot doesn\'t allow deletion.

', 'refs' => [], ], 'InvalidDBSubnetGroupFault' => [ 'base' => '

The DBSubnetGroup doesn\'t belong to the same VPC as that of an existing cross-region read replica of the same source instance.

', 'refs' => [], ], 'InvalidDBSubnetGroupStateFault' => [ 'base' => '

The DB subnet group cannot be deleted because it\'s in use.

', 'refs' => [], ], 'InvalidDBSubnetStateFault' => [ 'base' => '

The DB subnet isn\'t in the available state.

', 'refs' => [], ], 'InvalidEventSubscriptionStateFault' => [ 'base' => '

This error can occur if someone else is modifying a subscription. You should retry the action.

', 'refs' => [], ], 'InvalidGlobalClusterStateFault' => [ 'base' => '

', 'refs' => [], ], 'InvalidOptionGroupStateFault' => [ 'base' => '

The option group isn\'t in the available state.

', 'refs' => [], ], 'InvalidRestoreFault' => [ 'base' => '

Cannot restore from VPC backup to non-VPC DB instance.

', 'refs' => [], ], 'InvalidS3BucketFault' => [ 'base' => '

The specified Amazon S3 bucket name can\'t be found or Amazon RDS isn\'t authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

', 'refs' => [], ], 'InvalidSubnet' => [ 'base' => '

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

', 'refs' => [], ], 'InvalidVPCNetworkStateFault' => [ 'base' => '

The DB subnet group doesn\'t cover all Availability Zones after it\'s created because of users\' change.

', 'refs' => [], ], 'KMSKeyNotAccessibleFault' => [ 'base' => '

An error occurred accessing an AWS KMS key.

', 'refs' => [], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'RemoveTagsFromResourceMessage$TagKeys' => '

The tag key (name) of the tag to be removed.

', ], ], 'ListTagsForResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'LogTypeList' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsExportConfiguration$EnableLogTypes' => '

The list of log types to enable.

', 'CloudwatchLogsExportConfiguration$DisableLogTypes' => '

The list of log types to disable.

', 'CreateDBClusterMessage$EnableCloudwatchLogsExports' => '

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'CreateDBInstanceMessage$EnableCloudwatchLogsExports' => '

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.

', 'CreateDBInstanceReadReplicaMessage$EnableCloudwatchLogsExports' => '

The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', 'DBCluster$EnabledCloudwatchLogsExports' => '

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

', 'DBEngineVersion$ExportableLogTypes' => '

The types of logs that the database engine has available for export to CloudWatch Logs.

', 'DBInstance$EnabledCloudwatchLogsExports' => '

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

', 'PendingCloudwatchLogsExports$LogTypesToEnable' => '

Log types that are in the process of being deactivated. After they are deactivated, these log types aren\'t exported to CloudWatch Logs.

', 'PendingCloudwatchLogsExports$LogTypesToDisable' => '

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

', 'RestoreDBClusterFromS3Message$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBInstanceFromDBSnapshotMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

', 'RestoreDBInstanceFromS3Message$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', 'RestoreDBInstanceToPointInTimeMessage$EnableCloudwatchLogsExports' => '

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AccountQuota$Used' => '

The amount currently used toward the quota maximum.

', 'AccountQuota$Max' => '

The maximum allowed value for the quota.

', 'DescribeDBLogFilesDetails$LastWritten' => '

A POSIX timestamp when the last log entry was written.

', 'DescribeDBLogFilesDetails$Size' => '

The size, in bytes, of the log file for the specified DB instance.

', 'DescribeDBLogFilesMessage$FileLastWritten' => '

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

', 'DescribeDBLogFilesMessage$FileSize' => '

Filters the available log files for files larger than the specified size.

', ], ], 'LongOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'DBCluster$BacktrackWindow' => '

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

', 'DBCluster$BacktrackConsumedChangeRecords' => '

The number of change records stored for Backtrack.

', 'ModifyDBClusterMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'RestoreDBClusterFromS3Message$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'RestoreDBClusterFromSnapshotMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', 'RestoreDBClusterToPointInTimeMessage$BacktrackWindow' => '

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

', ], ], 'MinimumEngineVersionPerAllowedValue' => [ 'base' => '

The minimum DB engine version required for each corresponding allowed value for an option setting.

', 'refs' => [ 'MinimumEngineVersionPerAllowedValueList$member' => NULL, ], ], 'MinimumEngineVersionPerAllowedValueList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOptionSetting$MinimumEngineVersionPerAllowedValue' => '

The minimum DB engine version required for the corresponding allowed value for this option setting.

', ], ], 'ModifyCurrentDBClusterCapacityMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterEndpointMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSnapshotAttributeMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSubnetGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyEventSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyOptionGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ModifyOptionGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'Option' => [ 'base' => '

Option details.

', 'refs' => [ 'OptionsList$member' => NULL, ], ], 'OptionConfiguration' => [ 'base' => '

A list of all available options

', 'refs' => [ 'OptionConfigurationList$member' => NULL, ], ], 'OptionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToInclude' => '

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

', ], ], 'OptionGroup' => [ 'base' => '

', 'refs' => [ 'CopyOptionGroupResult$OptionGroup' => NULL, 'CreateOptionGroupResult$OptionGroup' => NULL, 'ModifyOptionGroupResult$OptionGroup' => NULL, 'OptionGroupsList$member' => NULL, ], ], 'OptionGroupAlreadyExistsFault' => [ 'base' => '

The option group you are trying to create already exists.

', 'refs' => [], ], 'OptionGroupMembership' => [ 'base' => '

Provides information on the option groups the DB instance is a member of.

', 'refs' => [ 'OptionGroupMembershipList$member' => NULL, ], ], 'OptionGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$OptionGroupMemberships' => '

Provides the list of option group memberships for this DB instance.

', ], ], 'OptionGroupNotFoundFault' => [ 'base' => '

The specified option group could not be found.

', 'refs' => [], ], 'OptionGroupOption' => [ 'base' => '

Available option.

', 'refs' => [ 'OptionGroupOptionsList$member' => NULL, ], ], 'OptionGroupOptionSetting' => [ 'base' => '

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

', 'refs' => [ 'OptionGroupOptionSettingsList$member' => NULL, ], ], 'OptionGroupOptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionSettings' => '

The option settings that are available (and the default value) for each option in an option group.

', ], ], 'OptionGroupOptionVersionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionGroupOptionVersions' => '

The versions that are available for the option.

', ], ], 'OptionGroupOptionsList' => [ 'base' => '

List of available option group options.

', 'refs' => [ 'OptionGroupOptionsMessage$OptionGroupOptions' => NULL, ], ], 'OptionGroupOptionsMessage' => [ 'base' => '

', 'refs' => [], ], 'OptionGroupQuotaExceededFault' => [ 'base' => '

The quota of 20 option groups was exceeded for this AWS account.

', 'refs' => [], ], 'OptionGroups' => [ 'base' => '

List of option groups.

', 'refs' => [], ], 'OptionGroupsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroups$OptionGroupsList' => '

List of option groups.

', ], ], 'OptionNamesList' => [ 'base' => NULL, 'refs' => [ 'ModifyOptionGroupMessage$OptionsToRemove' => '

Options in this list are removed from the option group.

', ], ], 'OptionSetting' => [ 'base' => '

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

', 'refs' => [ 'OptionSettingConfigurationList$member' => NULL, 'OptionSettingsList$member' => NULL, ], ], 'OptionSettingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Option$OptionSettings' => '

The option settings for this option.

', ], ], 'OptionSettingsList' => [ 'base' => NULL, 'refs' => [ 'OptionConfiguration$OptionSettings' => '

The option settings to include in an option group.

', ], ], 'OptionVersion' => [ 'base' => '

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

', 'refs' => [ 'OptionGroupOptionVersionsList$member' => NULL, ], ], 'OptionsConflictsWith' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionsConflictsWith' => '

The options that conflict with this option.

', ], ], 'OptionsDependedOn' => [ 'base' => NULL, 'refs' => [ 'OptionGroupOption$OptionsDependedOn' => '

The options that are prerequisites for this option.

', ], ], 'OptionsList' => [ 'base' => NULL, 'refs' => [ 'OptionGroup$Options' => '

Indicates what options are available in the option group.

', ], ], 'OrderableDBInstanceOption' => [ 'base' => '

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

', 'refs' => [ 'OrderableDBInstanceOptionsList$member' => NULL, ], ], 'OrderableDBInstanceOptionsList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions' => '

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

', 'refs' => [], ], 'Parameter' => [ 'base' => '

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

', 'refs' => [ 'ParametersList$member' => NULL, ], ], 'ParametersList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupDetails$Parameters' => '

Provides a list of parameters for the DB cluster parameter group.

', 'DBParameterGroupDetails$Parameters' => '

A list of Parameter values.

', 'EngineDefaults$Parameters' => '

Contains a list of engine default parameters.

', 'ModifyDBClusterParameterGroupMessage$Parameters' => '

A list of parameters in the DB cluster parameter group to modify.

', 'ModifyDBParameterGroupMessage$Parameters' => '

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

', 'ResetDBClusterParameterGroupMessage$Parameters' => '

A list of parameter names in the DB cluster parameter group to reset to the default values. You can\'t use this parameter if the ResetAllParameters parameter is set to true.

', 'ResetDBParameterGroupMessage$Parameters' => '

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

', ], ], 'PendingCloudwatchLogsExports' => [ 'base' => '

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

', 'refs' => [ 'PendingModifiedValues$PendingCloudwatchLogsExports' => NULL, ], ], 'PendingMaintenanceAction' => [ 'base' => '

Provides information about a pending maintenance action for a resource.

', 'refs' => [ 'PendingMaintenanceActionDetails$member' => NULL, ], ], 'PendingMaintenanceActionDetails' => [ 'base' => NULL, 'refs' => [ 'ResourcePendingMaintenanceActions$PendingMaintenanceActionDetails' => '

A list that provides details about the pending maintenance actions for the resource.

', ], ], 'PendingMaintenanceActions' => [ 'base' => NULL, 'refs' => [ 'PendingMaintenanceActionsMessage$PendingMaintenanceActions' => '

A list of the pending maintenance actions for the resource.

', ], ], 'PendingMaintenanceActionsMessage' => [ 'base' => '

Data returned from the DescribePendingMaintenanceActions action.

', 'refs' => [], ], 'PendingModifiedValues' => [ 'base' => '

This data type is used as a response element in the ModifyDBInstance action.

', 'refs' => [ 'DBInstance$PendingModifiedValues' => '

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

', ], ], 'PointInTimeRestoreNotEnabledFault' => [ 'base' => '

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

', 'refs' => [], ], 'ProcessorFeature' => [ 'base' => '

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

', 'refs' => [ 'ProcessorFeatureList$member' => NULL, ], ], 'ProcessorFeatureList' => [ 'base' => NULL, 'refs' => [ 'CreateDBInstanceMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'CreateDBInstanceReadReplicaMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'DBInstance$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'DBSnapshot$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

', 'ModifyDBInstanceMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'PendingModifiedValues$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'RestoreDBInstanceFromDBSnapshotMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'RestoreDBInstanceFromS3Message$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$ProcessorFeatures' => '

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

', ], ], 'PromoteReadReplicaDBClusterMessage' => [ 'base' => '

', 'refs' => [], ], 'PromoteReadReplicaDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'PromoteReadReplicaMessage' => [ 'base' => '

', 'refs' => [], ], 'PromoteReadReplicaResult' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionedIopsNotAvailableInAZFault' => [ 'base' => '

Provisioned IOPS not available in the specified Availability Zone.

', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingMessage' => [ 'base' => '

', 'refs' => [], ], 'PurchaseReservedDBInstancesOfferingResult' => [ 'base' => NULL, 'refs' => [], ], 'Range' => [ 'base' => '

A range of integer values.

', 'refs' => [ 'RangeList$member' => NULL, ], ], 'RangeList' => [ 'base' => NULL, 'refs' => [ 'ValidStorageOptions$StorageSize' => '

The valid range of storage in gibibytes. For example, 100 to 16384.

', 'ValidStorageOptions$ProvisionedIops' => '

The valid range of provisioned IOPS. For example, 1000-20000.

', ], ], 'ReadReplicaDBClusterIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$ReadReplicaDBClusterIdentifiers' => '

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Currently, each RDS DB instance can have only one Aurora Read Replica.

', ], ], 'ReadReplicaDBInstanceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$ReadReplicaDBInstanceIdentifiers' => '

Contains one or more identifiers of the Read Replicas associated with this DB instance.

', ], ], 'ReadReplicaIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ReadReplicaIdentifiers' => '

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

', ], ], 'ReadersArnList' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$Readers' => '

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

', ], ], 'RebootDBInstanceMessage' => [ 'base' => '

', 'refs' => [], ], 'RebootDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RecurringCharge' => [ 'base' => '

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstance$RecurringCharges' => '

The recurring price charged to run this reserved DB instance.

', 'ReservedDBInstancesOffering$RecurringCharges' => '

The recurring price charged to run this reserved DB instance.

', ], ], 'RemoveFromGlobalClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRoleFromDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'base' => '

', 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceMessage' => [ 'base' => '

', 'refs' => [], ], 'ReservedDBInstance' => [ 'base' => '

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

', 'refs' => [ 'PurchaseReservedDBInstancesOfferingResult$ReservedDBInstance' => NULL, 'ReservedDBInstanceList$member' => NULL, ], ], 'ReservedDBInstanceAlreadyExistsFault' => [ 'base' => '

User already has a reservation with the given identifier.

', 'refs' => [], ], 'ReservedDBInstanceList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstanceMessage$ReservedDBInstances' => '

A list of reserved DB instances.

', ], ], 'ReservedDBInstanceMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

', 'refs' => [], ], 'ReservedDBInstanceNotFoundFault' => [ 'base' => '

The specified reserved DB Instance not found.

', 'refs' => [], ], 'ReservedDBInstanceQuotaExceededFault' => [ 'base' => '

Request would exceed the user\'s DB Instance quota.

', 'refs' => [], ], 'ReservedDBInstancesOffering' => [ 'base' => '

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

', 'refs' => [ 'ReservedDBInstancesOfferingList$member' => NULL, ], ], 'ReservedDBInstancesOfferingList' => [ 'base' => NULL, 'refs' => [ 'ReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferings' => '

A list of reserved DB instance offerings.

', ], ], 'ReservedDBInstancesOfferingMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

', 'refs' => [], ], 'ReservedDBInstancesOfferingNotFoundFault' => [ 'base' => '

Specified offering does not exist.

', 'refs' => [], ], 'ResetDBClusterParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ResetDBParameterGroupMessage' => [ 'base' => '

', 'refs' => [], ], 'ResourceNotFoundFault' => [ 'base' => '

The specified resource ID was not found.

', 'refs' => [], ], 'ResourcePendingMaintenanceActions' => [ 'base' => '

Describes the pending maintenance actions for a resource.

', 'refs' => [ 'ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions' => NULL, 'PendingMaintenanceActions$member' => NULL, ], ], 'RestoreDBClusterFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBClusterFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBClusterToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBInstanceFromDBSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Message' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceFromS3Result' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBInstanceToPointInTimeMessage' => [ 'base' => '

', 'refs' => [], ], 'RestoreDBInstanceToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreWindow' => [ 'base' => '

Earliest and latest time an instance can be restored to:

', 'refs' => [ 'DBInstanceAutomatedBackup$RestoreWindow' => '

Earliest and latest time an instance can be restored to.

', ], ], 'RevokeDBSecurityGroupIngressMessage' => [ 'base' => '

', 'refs' => [], ], 'RevokeDBSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'SNSInvalidTopicFault' => [ 'base' => '

SNS has responded that there is a problem with the SND topic specified.

', 'refs' => [], ], 'SNSNoAuthorizationFault' => [ 'base' => '

You do not have permission to publish to the SNS topic ARN.

', 'refs' => [], ], 'SNSTopicArnNotFoundFault' => [ 'base' => '

The SNS topic ARN does not exist.

', 'refs' => [], ], 'ScalingConfiguration' => [ 'base' => '

Contains the scaling configuration of an Aurora Serverless DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'refs' => [ 'CreateDBClusterMessage$ScalingConfiguration' => '

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

', 'ModifyDBClusterMessage$ScalingConfiguration' => '

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

', 'RestoreDBClusterFromSnapshotMessage$ScalingConfiguration' => '

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

', ], ], 'ScalingConfigurationInfo' => [ 'base' => '

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

', 'refs' => [ 'DBCluster$ScalingConfigurationInfo' => NULL, ], ], 'SharedSnapshotQuotaExceededFault' => [ 'base' => '

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

', 'refs' => [], ], 'SnapshotQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed number of DB snapshots.

', 'refs' => [], ], 'SourceIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$SourceIds' => '

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are supplied, SourceType must also be provided.

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

', 'EventSubscription$SourceIdsList' => '

A list of source IDs for the RDS event notification subscription.

', ], ], 'SourceNotFoundFault' => [ 'base' => '

The requested source could not be found.

', 'refs' => [], ], 'SourceRegion' => [ 'base' => '

Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.

', 'refs' => [ 'SourceRegionList$member' => NULL, ], ], 'SourceRegionList' => [ 'base' => NULL, 'refs' => [ 'SourceRegionMessage$SourceRegions' => '

A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.

', ], ], 'SourceRegionMessage' => [ 'base' => '

Contains the result of a successful invocation of the DescribeSourceRegions action.

', 'refs' => [], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'DescribeEventsMessage$SourceType' => '

The event source to retrieve events for. If no value is specified, all events are returned.

', 'Event$SourceType' => '

Specifies the source type for this event.

', ], ], 'StartDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageQuotaExceededFault' => [ 'base' => '

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

', 'refs' => [], ], 'StorageTypeNotSupportedFault' => [ 'base' => '

Storage of the StorageType specified can\'t be associated with the DB instance.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccountQuota$AccountQuotaName' => '

The name of the Amazon RDS quota for this AWS account.

', 'AddRoleToDBClusterMessage$DBClusterIdentifier' => '

The name of the DB cluster to associate the IAM role with.

', 'AddRoleToDBClusterMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

', 'AddRoleToDBInstanceMessage$DBInstanceIdentifier' => '

The name of the DB instance to associate the IAM role with.

', 'AddRoleToDBInstanceMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

', 'AddRoleToDBInstanceMessage$FeatureName' => '

The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.

', 'AddSourceIdentifierToSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to add a source identifier to.

', 'AddSourceIdentifierToSubscriptionMessage$SourceIdentifier' => '

The identifier of the event source to be added.

Constraints:

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

', 'AddTagsToResourceMessage$ResourceName' => '

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

', 'ApplyPendingMaintenanceActionMessage$ResourceIdentifier' => '

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

', 'ApplyPendingMaintenanceActionMessage$ApplyAction' => '

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

', 'ApplyPendingMaintenanceActionMessage$OptInType' => '

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can\'t be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

', 'AttributeValueList$member' => NULL, 'AuthorizeDBSecurityGroupIngressMessage$DBSecurityGroupName' => '

The name of the DB security group to add authorization to.

', 'AuthorizeDBSecurityGroupIngressMessage$CIDRIP' => '

The IP range to authorize.

', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName' => '

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupId' => '

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => '

AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'AvailabilityZone$Name' => '

The name of the Availability Zone.

', 'AvailabilityZones$member' => NULL, 'AvailableProcessorFeature$Name' => '

The name of the processor feature. Valid names are coreCount and threadsPerCore.

', 'AvailableProcessorFeature$DefaultValue' => '

The default value for the processor feature of the DB instance class.

', 'AvailableProcessorFeature$AllowedValues' => '

The allowed values for the processor feature of the DB instance class.

', 'BacktrackDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'Certificate$CertificateIdentifier' => '

The unique key that identifies a certificate.

', 'Certificate$CertificateType' => '

The type of the certificate.

', 'Certificate$Thumbprint' => '

The thumbprint of the certificate.

', 'Certificate$CertificateArn' => '

The Amazon Resource Name (ARN) for the certificate.

', 'CertificateMessage$Marker' => '

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'CharacterSet$CharacterSetName' => '

The name of the character set.

', 'CharacterSet$CharacterSetDescription' => '

The description of the character set.

', 'CopyDBClusterParameterGroupMessage$SourceDBClusterParameterGroupIdentifier' => '

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

Constraints:

  • Must specify a valid DB cluster parameter group.

  • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

  • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupIdentifier' => '

The identifier for the copied DB cluster parameter group.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster-param-group1

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupDescription' => '

A description for the copied DB cluster parameter group.

', 'CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier' => '

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

You can\'t copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

Constraints:

  • Must specify a valid system snapshot in the "available" state.

  • If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

', 'CopyDBClusterSnapshotMessage$TargetDBClusterSnapshotIdentifier' => '

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

', 'CopyDBClusterSnapshotMessage$KmsKeyId' => '

The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don\'t specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can\'t use encryption keys from one AWS Region in another AWS Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

', 'CopyDBClusterSnapshotMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.

The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier' => '

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid DB parameter group.

  • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

', 'CopyDBParameterGroupMessage$TargetDBParameterGroupIdentifier' => '

The identifier for the copied DB parameter group.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

', 'CopyDBParameterGroupMessage$TargetDBParameterGroupDescription' => '

A description for the copied DB parameter group.

', 'CopyDBSnapshotMessage$SourceDBSnapshotIdentifier' => '

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

  • Must specify a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

', 'CopyDBSnapshotMessage$TargetDBSnapshotIdentifier' => '

The identifier for the copy of the snapshot.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

', 'CopyDBSnapshotMessage$KmsKeyId' => '

The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don\'t specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can\'t use encryption keys from one AWS Region in another AWS Region.

', 'CopyDBSnapshotMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CopyDBSnapshotMessage$OptionGroupName' => '

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

', 'CopyOptionGroupMessage$SourceOptionGroupIdentifier' => '

The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid option group.

  • If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

  • If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

', 'CopyOptionGroupMessage$TargetOptionGroupIdentifier' => '

The identifier for the copied option group.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-option-group

', 'CopyOptionGroupMessage$TargetOptionGroupDescription' => '

The description for the copied option group.

', 'CreateDBClusterEndpointMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

', 'CreateDBClusterEndpointMessage$DBClusterEndpointIdentifier' => '

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

', 'CreateDBClusterEndpointMessage$EndpointType' => '

The type of the endpoint. One of: READER, ANY.

', 'CreateDBClusterMessage$CharacterSetName' => '

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

', 'CreateDBClusterMessage$DatabaseName' => '

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

', 'CreateDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'CreateDBClusterMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.

', 'CreateDBClusterMessage$DBSubnetGroupName' => '

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'CreateDBClusterMessage$Engine' => '

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

', 'CreateDBClusterMessage$EngineVersion' => '

The version number of the database engine to use.

Aurora MySQL

Example: 5.6.10a, 5.7.12

Aurora PostgreSQL

Example: 9.6.3

', 'CreateDBClusterMessage$MasterUsername' => '

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'CreateDBClusterMessage$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'CreateDBClusterMessage$OptionGroupName' => '

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options can\'t be removed from an option group. The option group can\'t be removed from a DB cluster once it is associated with a DB cluster.

', 'CreateDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'CreateDBClusterMessage$ReplicationSourceIdentifier' => '

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

', 'CreateDBClusterMessage$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS will use your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

', 'CreateDBClusterMessage$PreSignedUrl' => '

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CreateDBClusterMessage$EngineMode' => '

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.

', 'CreateDBClusterMessage$GlobalClusterIdentifier' => '

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

', 'CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

', 'CreateDBClusterParameterGroupMessage$DBParameterGroupFamily' => '

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7

Aurora PostgreSQL

Example: aurora-postgresql9.6

', 'CreateDBClusterParameterGroupMessage$Description' => '

The description for the DB cluster parameter group.

', 'CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

', 'CreateDBClusterSnapshotMessage$DBClusterIdentifier' => '

The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster1

', 'CreateDBInstanceMessage$DBName' => '

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can\'t be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can\'t be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can\'t be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can\'t specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can\'t be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can\'t be a word reserved by the specified database engine

', 'CreateDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'CreateDBInstanceMessage$DBInstanceClass' => '

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

', 'CreateDBInstanceMessage$Engine' => '

The name of the database engine to be used for this instance.

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

', 'CreateDBInstanceMessage$MasterUsername' => '

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

  • Can\'t be a reserved word for the chosen database engine.

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'CreateDBInstanceMessage$MasterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

', 'CreateDBInstanceMessage$AvailabilityZone' => '

The EC2 Availability Zone that the DB instance is created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint\'s AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can\'t be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

', 'CreateDBInstanceMessage$DBSubnetGroupName' => '

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

', 'CreateDBInstanceMessage$PreferredMaintenanceWindow' => '

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

Format: ddd:hh24:mi-ddd:hh24:mi

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.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'CreateDBInstanceMessage$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'CreateDBInstanceMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateDBInstanceMessage$EngineVersion' => '

The version number of the database engine to use.

For a list of valid engine versions, call DescribeDBEngineVersions.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

', 'CreateDBInstanceMessage$LicenseModel' => '

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

', 'CreateDBInstanceMessage$OptionGroupName' => '

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'CreateDBInstanceMessage$CharacterSetName' => '

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

', 'CreateDBInstanceMessage$DBClusterIdentifier' => '

The identifier of the DB cluster that the instance will belong to.

For information on creating a DB cluster, see CreateDBCluster.

Type: String

', 'CreateDBInstanceMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'CreateDBInstanceMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'CreateDBInstanceMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'CreateDBInstanceMessage$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

', 'CreateDBInstanceMessage$Domain' => '

Specify the Active Directory Domain to create the instance in.

', 'CreateDBInstanceMessage$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'CreateDBInstanceMessage$DomainIAMRoleName' => '

Specify the name of the IAM role to be used when making API calls to the Directory Service.

', 'CreateDBInstanceMessage$Timezone' => '

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

', 'CreateDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier' => '

The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

', 'CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier' => '

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.

  • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.

  • Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.

  • If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

', 'CreateDBInstanceReadReplicaMessage$DBInstanceClass' => '

The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

', 'CreateDBInstanceReadReplicaMessage$AvailabilityZone' => '

The Amazon EC2 Availability Zone that the Read Replica is created in.

Default: A random, system-chosen Availability Zone in the endpoint\'s AWS Region.

Example: us-east-1d

', 'CreateDBInstanceReadReplicaMessage$OptionGroupName' => '

The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.

', 'CreateDBInstanceReadReplicaMessage$DBSubnetGroupName' => '

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

  • If supplied, must match the name of an existing DBSubnetGroup.

  • The specified DB subnet group must be in the same AWS Region in which the operation is running.

  • All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

    • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

', 'CreateDBInstanceReadReplicaMessage$StorageType' => '

Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'CreateDBInstanceReadReplicaMessage$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'CreateDBInstanceReadReplicaMessage$KmsKeyId' => '

The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can\'t use encryption keys from one AWS Region in another AWS Region.

You can\'t create an encrypted Read Replica from an unencrypted DB instance.

', 'CreateDBInstanceReadReplicaMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

', 'CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'CreateDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

', 'CreateDBParameterGroupMessage$DBParameterGroupFamily' => '

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

To list all of the available parameter group families, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

The output contains duplicates.

', 'CreateDBParameterGroupMessage$Description' => '

The description for the DB parameter group.

', 'CreateDBSecurityGroupMessage$DBSecurityGroupName' => '

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

  • Must not be "Default"

Example: mysecuritygroup

', 'CreateDBSecurityGroupMessage$DBSecurityGroupDescription' => '

The description for the DB security group.

', 'CreateDBSnapshotMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot.

Constraints:

  • Can\'t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

', 'CreateDBSnapshotMessage$DBInstanceIdentifier' => '

The identifier of the DB instance that you want to create the snapshot of.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'CreateDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

', 'CreateDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the DB subnet group.

', 'CreateEventSubscriptionMessage$SubscriptionName' => '

The name of the subscription.

Constraints: The name must be less than 255 characters.

', 'CreateEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

', 'CreateEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

', 'CreateGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the new global database cluster.

', 'CreateGlobalClusterMessage$SourceDBClusterIdentifier' => '

The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

', 'CreateGlobalClusterMessage$Engine' => '

Provides the name of the database engine to be used for this DB cluster.

', 'CreateGlobalClusterMessage$EngineVersion' => '

The engine version of the Aurora global database.

', 'CreateGlobalClusterMessage$DatabaseName' => '

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

', 'CreateOptionGroupMessage$OptionGroupName' => '

Specifies the name of the option group to be created.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup

', 'CreateOptionGroupMessage$EngineName' => '

Specifies the name of the engine that this option group should be associated with.

', 'CreateOptionGroupMessage$MajorEngineVersion' => '

Specifies the major version of the engine that this option group should be associated with.

', 'CreateOptionGroupMessage$OptionGroupDescription' => '

The description of the option group.

', 'DBCluster$CharacterSetName' => '

If present, specifies the name of the character set that this cluster is associated with.

', 'DBCluster$DatabaseName' => '

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

', 'DBCluster$DBClusterIdentifier' => '

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

', 'DBCluster$DBClusterParameterGroup' => '

Specifies the name of the DB cluster parameter group for the DB cluster.

', 'DBCluster$DBSubnetGroup' => '

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

', 'DBCluster$Status' => '

Specifies the current state of this DB cluster.

', 'DBCluster$PercentProgress' => '

Specifies the progress of the operation as a percentage.

', 'DBCluster$Endpoint' => '

Specifies the connection endpoint for the primary instance of the DB cluster.

', 'DBCluster$ReaderEndpoint' => '

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

', 'DBCluster$Engine' => '

Provides the name of the database engine to be used for this DB cluster.

', 'DBCluster$EngineVersion' => '

Indicates the database engine version.

', 'DBCluster$MasterUsername' => '

Contains the master username for the DB cluster.

', 'DBCluster$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBCluster$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBCluster$ReplicationSourceIdentifier' => '

Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

', 'DBCluster$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'DBCluster$KmsKeyId' => '

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

', 'DBCluster$DbClusterResourceId' => '

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

', 'DBCluster$DBClusterArn' => '

The Amazon Resource Name (ARN) for the DB cluster.

', 'DBCluster$CloneGroupId' => '

Identifies the clone group to which the DB cluster is associated.

', 'DBCluster$EngineMode' => '

The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.

', 'DBClusterBacktrack$DBClusterIdentifier' => '

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

', 'DBClusterBacktrack$BacktrackIdentifier' => '

Contains the backtrack identifier.

', 'DBClusterBacktrack$Status' => '

The status of the backtrack. This property returns one of the following values:

  • applying - The backtrack is currently being applied to or rolled back from the DB cluster.

  • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

  • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

  • pending - The backtrack is currently pending application to or rollback from the DB cluster.

', 'DBClusterBacktrackMessage$Marker' => '

A pagination token that can be used in a subsequent DescribeDBClusterBacktracks request.

', 'DBClusterCapacityInfo$DBClusterIdentifier' => '

A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

', 'DBClusterCapacityInfo$TimeoutAction' => '

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

', 'DBClusterEndpoint$DBClusterEndpointIdentifier' => '

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

', 'DBClusterEndpoint$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

', 'DBClusterEndpoint$DBClusterEndpointResourceIdentifier' => '

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

', 'DBClusterEndpoint$Endpoint' => '

The DNS address of the endpoint.

', 'DBClusterEndpoint$Status' => '

The current status of the endpoint. One of: creating, available, deleting, modifying.

', 'DBClusterEndpoint$EndpointType' => '

The type of the endpoint. One of: READER, WRITER, CUSTOM.

', 'DBClusterEndpoint$CustomEndpointType' => '

The type associated with a custom endpoint. One of: READER, ANY.

', 'DBClusterEndpoint$DBClusterEndpointArn' => '

The Amazon Resource Name (ARN) for the endpoint.

', 'DBClusterEndpointMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterMember$DBInstanceIdentifier' => '

Specifies the instance identifier for this member of the DB cluster.

', 'DBClusterMember$DBClusterParameterGroupStatus' => '

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

', 'DBClusterMessage$Marker' => '

A pagination token that can be used in a subsequent DescribeDBClusters request.

', 'DBClusterOptionGroupStatus$DBClusterOptionGroupName' => '

Specifies the name of the DB cluster option group.

', 'DBClusterOptionGroupStatus$Status' => '

Specifies the status of the DB cluster option group.

', 'DBClusterParameterGroup$DBClusterParameterGroupName' => '

Provides the name of the DB cluster parameter group.

', 'DBClusterParameterGroup$DBParameterGroupFamily' => '

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

', 'DBClusterParameterGroup$Description' => '

Provides the customer-specified description for this DB cluster parameter group.

', 'DBClusterParameterGroup$DBClusterParameterGroupArn' => '

The Amazon Resource Name (ARN) for the DB cluster parameter group.

', 'DBClusterParameterGroupDetails$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DBClusterParameterGroupNameMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

', 'DBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterRole$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

', 'DBClusterRole$Status' => '

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

  • PENDING - the IAM role ARN is being associated with the DB cluster.

  • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

', 'DBClusterRole$FeatureName' => NULL, 'DBClusterSnapshot$DBClusterSnapshotIdentifier' => '

Specifies the identifier for the DB cluster snapshot.

', 'DBClusterSnapshot$DBClusterIdentifier' => '

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

', 'DBClusterSnapshot$Engine' => '

Specifies the name of the database engine.

', 'DBClusterSnapshot$Status' => '

Specifies the status of this DB cluster snapshot.

', 'DBClusterSnapshot$VpcId' => '

Provides the VPC ID associated with the DB cluster snapshot.

', 'DBClusterSnapshot$MasterUsername' => '

Provides the master username for the DB cluster snapshot.

', 'DBClusterSnapshot$EngineVersion' => '

Provides the version of the database engine for this DB cluster snapshot.

', 'DBClusterSnapshot$LicenseModel' => '

Provides the license model information for this DB cluster snapshot.

', 'DBClusterSnapshot$SnapshotType' => '

Provides the type of the DB cluster snapshot.

', 'DBClusterSnapshot$KmsKeyId' => '

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

', 'DBClusterSnapshot$DBClusterSnapshotArn' => '

The Amazon Resource Name (ARN) for the DB cluster snapshot.

', 'DBClusterSnapshot$SourceDBClusterSnapshotArn' => '

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

', 'DBClusterSnapshotAttribute$AttributeName' => '

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

', 'DBClusterSnapshotAttributesResult$DBClusterSnapshotIdentifier' => '

The identifier of the manual DB cluster snapshot that the attributes apply to.

', 'DBClusterSnapshotMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBEngineVersion$Engine' => '

The name of the database engine.

', 'DBEngineVersion$EngineVersion' => '

The version number of the database engine.

', 'DBEngineVersion$DBParameterGroupFamily' => '

The name of the DB parameter group family for the database engine.

', 'DBEngineVersion$DBEngineDescription' => '

The description of the database engine.

', 'DBEngineVersion$DBEngineVersionDescription' => '

The description of the database engine version.

', 'DBEngineVersionMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBInstance$DBInstanceIdentifier' => '

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

', 'DBInstance$DBInstanceClass' => '

Contains the name of the compute and memory capacity class of the DB instance.

', 'DBInstance$Engine' => '

Provides the name of the database engine to be used for this DB instance.

', 'DBInstance$DBInstanceStatus' => '

Specifies the current state of this database.

', 'DBInstance$MasterUsername' => '

Contains the master username for the DB instance.

', 'DBInstance$DBName' => '

The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

', 'DBInstance$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBInstance$AvailabilityZone' => '

Specifies the name of the Availability Zone the DB instance is located in.

', 'DBInstance$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBInstance$EngineVersion' => '

Indicates the database engine version.

', 'DBInstance$ReadReplicaSourceDBInstanceIdentifier' => '

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

', 'DBInstance$LicenseModel' => '

License model information for this DB instance.

', 'DBInstance$CharacterSetName' => '

If present, specifies the name of the character set that this instance is associated with.

', 'DBInstance$SecondaryAvailabilityZone' => '

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

', 'DBInstance$StorageType' => '

Specifies the storage type associated with DB instance.

', 'DBInstance$TdeCredentialArn' => '

The ARN from the key store with which the instance is associated for TDE encryption.

', 'DBInstance$DBClusterIdentifier' => '

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

', 'DBInstance$KmsKeyId' => '

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

', 'DBInstance$DbiResourceId' => '

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

', 'DBInstance$CACertificateIdentifier' => '

The identifier of the CA certificate for this DB instance.

', 'DBInstance$EnhancedMonitoringResourceArn' => '

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

', 'DBInstance$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

', 'DBInstance$DBInstanceArn' => '

The Amazon Resource Name (ARN) for the DB instance.

', 'DBInstance$Timezone' => '

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

', 'DBInstance$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'DBInstanceAutomatedBackup$DBInstanceArn' => '

The Amazon Resource Name (ARN) for the automated backup.

', 'DBInstanceAutomatedBackup$DbiResourceId' => '

The identifier for the source DB instance, which can\'t be changed and which is unique to an AWS Region.

', 'DBInstanceAutomatedBackup$Region' => '

The AWS Region associated with the automated backup.

', 'DBInstanceAutomatedBackup$DBInstanceIdentifier' => '

The customer id of the instance that is/was associated with the automated backup.

', 'DBInstanceAutomatedBackup$Status' => '

Provides a list of status information for an automated backup:

  • active - automated backups for current instances

  • retained - automated backups for deleted instances

  • creating - automated backups that are waiting for the first automated snapshot to be available.

', 'DBInstanceAutomatedBackup$AvailabilityZone' => '

The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

', 'DBInstanceAutomatedBackup$VpcId' => '

Provides the VPC ID associated with the DB instance

', 'DBInstanceAutomatedBackup$MasterUsername' => '

The license model of an automated backup.

', 'DBInstanceAutomatedBackup$Engine' => '

The name of the database engine for this automated backup.

', 'DBInstanceAutomatedBackup$EngineVersion' => '

The version of the database engine for the automated backup.

', 'DBInstanceAutomatedBackup$LicenseModel' => '

License model information for the automated backup.

', 'DBInstanceAutomatedBackup$OptionGroupName' => '

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

', 'DBInstanceAutomatedBackup$TdeCredentialArn' => '

The ARN from the key store with which the automated backup is associated for TDE encryption.

', 'DBInstanceAutomatedBackup$StorageType' => '

Specifies the storage type associated with the automated backup.

', 'DBInstanceAutomatedBackup$KmsKeyId' => '

The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'DBInstanceAutomatedBackup$Timezone' => '

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

', 'DBInstanceAutomatedBackupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DBInstanceMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DBInstanceRole$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

', 'DBInstanceRole$FeatureName' => '

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

', 'DBInstanceRole$Status' => '

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.

  • PENDING - the IAM role ARN is being associated with the DB instance.

  • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.

', 'DBInstanceStatusInfo$StatusType' => '

This value is currently "read replication."

', 'DBInstanceStatusInfo$Status' => '

Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

', 'DBInstanceStatusInfo$Message' => '

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

', 'DBParameterGroup$DBParameterGroupName' => '

Provides the name of the DB parameter group.

', 'DBParameterGroup$DBParameterGroupFamily' => '

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

', 'DBParameterGroup$Description' => '

Provides the customer-specified description for this DB parameter group.

', 'DBParameterGroup$DBParameterGroupArn' => '

The Amazon Resource Name (ARN) for the DB parameter group.

', 'DBParameterGroupDetails$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBParameterGroupNameMessage$DBParameterGroupName' => '

Provides the name of the DB parameter group.

', 'DBParameterGroupStatus$DBParameterGroupName' => '

The name of the DP parameter group.

', 'DBParameterGroupStatus$ParameterApplyStatus' => '

The status of parameter updates.

', 'DBParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBSecurityGroup$OwnerId' => '

Provides the AWS ID of the owner of a specific DB security group.

', 'DBSecurityGroup$DBSecurityGroupName' => '

Specifies the name of the DB security group.

', 'DBSecurityGroup$DBSecurityGroupDescription' => '

Provides the description of the DB security group.

', 'DBSecurityGroup$VpcId' => '

Provides the VpcId of the DB security group.

', 'DBSecurityGroup$DBSecurityGroupArn' => '

The Amazon Resource Name (ARN) for the DB security group.

', 'DBSecurityGroupMembership$DBSecurityGroupName' => '

The name of the DB security group.

', 'DBSecurityGroupMembership$Status' => '

The status of the DB security group.

', 'DBSecurityGroupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBSecurityGroupNameList$member' => NULL, 'DBSnapshot$DBSnapshotIdentifier' => '

Specifies the identifier for the DB snapshot.

', 'DBSnapshot$DBInstanceIdentifier' => '

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

', 'DBSnapshot$Engine' => '

Specifies the name of the database engine.

', 'DBSnapshot$Status' => '

Specifies the status of this DB snapshot.

', 'DBSnapshot$AvailabilityZone' => '

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

', 'DBSnapshot$VpcId' => '

Provides the VPC ID associated with the DB snapshot.

', 'DBSnapshot$MasterUsername' => '

Provides the master username for the DB snapshot.

', 'DBSnapshot$EngineVersion' => '

Specifies the version of the database engine.

', 'DBSnapshot$LicenseModel' => '

License model information for the restored DB instance.

', 'DBSnapshot$SnapshotType' => '

Provides the type of the DB snapshot.

', 'DBSnapshot$OptionGroupName' => '

Provides the option group name for the DB snapshot.

', 'DBSnapshot$SourceRegion' => '

The AWS Region that the DB snapshot was created in or copied from.

', 'DBSnapshot$SourceDBSnapshotIdentifier' => '

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

', 'DBSnapshot$StorageType' => '

Specifies the storage type associated with DB snapshot.

', 'DBSnapshot$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'DBSnapshot$KmsKeyId' => '

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

', 'DBSnapshot$DBSnapshotArn' => '

The Amazon Resource Name (ARN) for the DB snapshot.

', 'DBSnapshot$Timezone' => '

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

', 'DBSnapshot$DbiResourceId' => '

The identifier for the source DB instance, which can\'t be changed and which is unique to an AWS Region.

', 'DBSnapshotAttribute$AttributeName' => '

The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

', 'DBSnapshotAttributesResult$DBSnapshotIdentifier' => '

The identifier of the manual DB snapshot that the attributes apply to.

', 'DBSnapshotMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBSubnetGroup$DBSubnetGroupName' => '

The name of the DB subnet group.

', 'DBSubnetGroup$DBSubnetGroupDescription' => '

Provides the description of the DB subnet group.

', 'DBSubnetGroup$VpcId' => '

Provides the VpcId of the DB subnet group.

', 'DBSubnetGroup$SubnetGroupStatus' => '

Provides the status of the DB subnet group.

', 'DBSubnetGroup$DBSubnetGroupArn' => '

The Amazon Resource Name (ARN) for the DB subnet group.

', 'DBSubnetGroupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DeleteDBClusterEndpointMessage$DBClusterEndpointIdentifier' => '

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

', 'DeleteDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier for the DB cluster to be deleted. This parameter isn\'t case-sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

', 'DeleteDBClusterMessage$FinalDBSnapshotIdentifier' => '

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'DeleteDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group.

Constraints:

  • Must be the name of an existing DB cluster parameter group.

  • You can\'t delete a default DB cluster parameter group.

  • Can\'t be associated with any DB clusters.

', 'DeleteDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

', 'DeleteDBInstanceAutomatedBackupMessage$DbiResourceId' => '

The identifier for the source DB instance, which can\'t be changed and which is unique to an AWS Region.

', 'DeleteDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier for the DB instance to be deleted. This parameter isn\'t case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

', 'DeleteDBInstanceMessage$FinalDBSnapshotIdentifier' => '

The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

  • Can\'t be specified when deleting a Read Replica.

', 'DeleteDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group

  • You can\'t delete a default DB parameter group

  • Can\'t be associated with any DB instances

', 'DeleteDBSecurityGroupMessage$DBSecurityGroupName' => '

The name of the DB security group to delete.

You can\'t delete the default DB security group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

  • Must not be "Default"

', 'DeleteDBSnapshotMessage$DBSnapshotIdentifier' => '

The DB snapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

', 'DeleteDBSubnetGroupMessage$DBSubnetGroupName' => '

The name of the database subnet group to delete.

You can\'t delete the default subnet group.

Constraints:

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'DeleteEventSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to delete.

', 'DeleteGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the global database cluster being deleted.

', 'DeleteOptionGroupMessage$OptionGroupName' => '

The name of the option group to be deleted.

You can\'t delete default option groups.

', 'DescribeCertificatesMessage$CertificateIdentifier' => '

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn\'t case-sensitive.

Constraints:

  • Must match an existing CertificateIdentifier.

', 'DescribeCertificatesMessage$Marker' => '

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterBacktracksMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'DescribeDBClusterBacktracksMessage$BacktrackIdentifier' => '

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Example: 123e4567-e89b-12d3-a456-426655440000

', 'DescribeDBClusterBacktracksMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterEndpointsMessage$DBClusterIdentifier' => '

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

', 'DescribeDBClusterEndpointsMessage$DBClusterEndpointIdentifier' => '

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

', 'DescribeDBClusterEndpointsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParameterGroupsMessage$DBClusterParameterGroupName' => '

The name of a specific DB cluster parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParametersMessage$DBClusterParameterGroupName' => '

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParametersMessage$Source' => '

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

', 'DescribeDBClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterSnapshotAttributesMessage$DBClusterSnapshotIdentifier' => '

The identifier for the DB cluster snapshot to describe the attributes for.

', 'DescribeDBClusterSnapshotsMessage$DBClusterIdentifier' => '

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can\'t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBCluster.

', 'DescribeDBClusterSnapshotsMessage$DBClusterSnapshotIdentifier' => '

A specific DB cluster snapshot identifier to describe. This parameter can\'t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If supplied, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

', 'DescribeDBClusterSnapshotsMessage$SnapshotType' => '

The type of DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB cluster snapshots that have been taken by my AWS account.

  • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

  • public - Return all DB cluster snapshots that have been marked as public.

If you don\'t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

', 'DescribeDBClusterSnapshotsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClustersMessage$DBClusterIdentifier' => '

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn\'t case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

', 'DescribeDBClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBEngineVersionsMessage$Engine' => '

The database engine to return.

', 'DescribeDBEngineVersionsMessage$EngineVersion' => '

The database engine version to return.

Example: 5.1.49

', 'DescribeDBEngineVersionsMessage$DBParameterGroupFamily' => '

The name of a specific DB parameter group family to return details for.

Constraints:

  • If supplied, must match an existing DBParameterGroupFamily.

', 'DescribeDBEngineVersionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBInstanceAutomatedBackupsMessage$DbiResourceId' => '

The resource ID of the DB instance that is the source of the automated backup. This parameter isn\'t case-sensitive.

', 'DescribeDBInstanceAutomatedBackupsMessage$DBInstanceIdentifier' => '

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance\' automated backup. This parameter isn\'t case-sensitive.

', 'DescribeDBInstanceAutomatedBackupsMessage$Marker' => '

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

', 'DescribeDBInstancesMessage$DBInstanceIdentifier' => '

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn\'t case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

', 'DescribeDBInstancesMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBLogFilesDetails$LogFileName' => '

The name of the log file for the specified DB instance.

', 'DescribeDBLogFilesMessage$DBInstanceIdentifier' => '

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'DescribeDBLogFilesMessage$FilenameContains' => '

Filters the available log files for log file names that contain the specified string.

', 'DescribeDBLogFilesMessage$Marker' => '

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

', 'DescribeDBLogFilesResponse$Marker' => '

A pagination token that can be used in a subsequent DescribeDBLogFiles request.

', 'DescribeDBParameterGroupsMessage$DBParameterGroupName' => '

The name of a specific DB parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBParametersMessage$DBParameterGroupName' => '

The name of a specific DB parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

', 'DescribeDBParametersMessage$Source' => '

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

', 'DescribeDBParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSecurityGroupsMessage$DBSecurityGroupName' => '

The name of the DB security group to return details for.

', 'DescribeDBSecurityGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSnapshotAttributesMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot to describe the attributes for.

', 'DescribeDBSnapshotsMessage$DBInstanceIdentifier' => '

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can\'t be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

', 'DescribeDBSnapshotsMessage$DBSnapshotIdentifier' => '

A specific DB snapshot identifier to describe. This parameter can\'t be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

  • If supplied, must match the identifier of an existing DBSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

', 'DescribeDBSnapshotsMessage$SnapshotType' => '

The type of snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public - Return all DB snapshots that have been marked as public.

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don\'t specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

', 'DescribeDBSnapshotsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSnapshotsMessage$DbiResourceId' => '

A specific DB resource ID to describe.

', 'DescribeDBSubnetGroupsMessage$DBSubnetGroupName' => '

The name of the DB subnet group to return details for.

', 'DescribeDBSubnetGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEngineDefaultClusterParametersMessage$DBParameterGroupFamily' => '

The name of the DB cluster parameter group family to return engine parameter information for.

', 'DescribeEngineDefaultClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEngineDefaultParametersMessage$DBParameterGroupFamily' => '

The name of the DB parameter group family.

', 'DescribeEngineDefaultParametersMessage$Marker' => '

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEventCategoriesMessage$SourceType' => '

The type of source that is generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

', 'DescribeEventSubscriptionsMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to describe.

', 'DescribeEventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DescribeEventsMessage$SourceIdentifier' => '

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is supplied, SourceType must also be provided.

  • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'DescribeEventsMessage$Marker' => '

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeGlobalClustersMessage$GlobalClusterIdentifier' => '

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn\'t case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

', 'DescribeGlobalClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOptionGroupOptionsMessage$EngineName' => '

A required parameter. Options available for the given engine name are described.

', 'DescribeOptionGroupOptionsMessage$MajorEngineVersion' => '

If specified, filters the results to include only options for the specified major engine version.

', 'DescribeOptionGroupOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOptionGroupsMessage$OptionGroupName' => '

The name of the option group to describe. Can\'t be supplied together with EngineName or MajorEngineVersion.

', 'DescribeOptionGroupsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOptionGroupsMessage$EngineName' => '

Filters the list of option groups to only include groups associated with a specific database engine.

', 'DescribeOptionGroupsMessage$MajorEngineVersion' => '

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

', 'DescribeOrderableDBInstanceOptionsMessage$Engine' => '

The name of the engine to retrieve DB instance options for.

', 'DescribeOrderableDBInstanceOptionsMessage$EngineVersion' => '

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass' => '

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

', 'DescribeOrderableDBInstanceOptionsMessage$LicenseModel' => '

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

', 'DescribeOrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'DescribePendingMaintenanceActionsMessage$ResourceIdentifier' => '

The ARN of a resource to return pending maintenance actions for.

', 'DescribePendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

', 'DescribeReservedDBInstancesMessage$ReservedDBInstanceId' => '

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

', 'DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId' => '

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

', 'DescribeReservedDBInstancesMessage$DBInstanceClass' => '

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

', 'DescribeReservedDBInstancesMessage$Duration' => '

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

', 'DescribeReservedDBInstancesMessage$ProductDescription' => '

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

', 'DescribeReservedDBInstancesMessage$OfferingType' => '

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

', 'DescribeReservedDBInstancesMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeReservedDBInstancesOfferingsMessage$ReservedDBInstancesOfferingId' => '

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

', 'DescribeReservedDBInstancesOfferingsMessage$DBInstanceClass' => '

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

', 'DescribeReservedDBInstancesOfferingsMessage$Duration' => '

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

', 'DescribeReservedDBInstancesOfferingsMessage$ProductDescription' => '

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

The results show offerings that partially match the filter value.

', 'DescribeReservedDBInstancesOfferingsMessage$OfferingType' => '

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

', 'DescribeReservedDBInstancesOfferingsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeSourceRegionsMessage$RegionName' => '

The source AWS Region name. For example, us-east-1.

Constraints:

  • Must specify a valid AWS Region name.

', 'DescribeSourceRegionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeValidDBInstanceModificationsMessage$DBInstanceIdentifier' => '

The customer identifier or the ARN of your DB instance.

', 'DomainMembership$Domain' => '

The identifier of the Active Directory Domain.

', 'DomainMembership$Status' => '

The status of the DB instance\'s Active Directory Domain membership, such as joined, pending-join, failed etc).

', 'DomainMembership$FQDN' => '

The fully qualified domain name of the Active Directory Domain.

', 'DomainMembership$IAMRoleName' => '

The name of the IAM role to be used when making API calls to the Directory Service.

', 'DownloadDBLogFilePortionDetails$LogFileData' => '

Entries from the specified log file.

', 'DownloadDBLogFilePortionDetails$Marker' => '

A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

', 'DownloadDBLogFilePortionMessage$DBInstanceIdentifier' => '

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'DownloadDBLogFilePortionMessage$LogFileName' => '

The name of the log file to be downloaded.

', 'DownloadDBLogFilePortionMessage$Marker' => '

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

', 'EC2SecurityGroup$Status' => '

Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

', 'EC2SecurityGroup$EC2SecurityGroupName' => '

Specifies the name of the EC2 security group.

', 'EC2SecurityGroup$EC2SecurityGroupId' => '

Specifies the id of the EC2 security group.

', 'EC2SecurityGroup$EC2SecurityGroupOwnerId' => '

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

', 'Endpoint$Address' => '

Specifies the DNS address of the DB instance.

', 'Endpoint$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'EngineDefaults$DBParameterGroupFamily' => '

Specifies the name of the DB parameter group family that the engine default parameters apply to.

', 'EngineDefaults$Marker' => '

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'EngineModeList$member' => NULL, 'Event$SourceIdentifier' => '

Provides the identifier for the source of the event.

', 'Event$Message' => '

Provides the text of this event.

', 'Event$SourceArn' => '

The Amazon Resource Name (ARN) for the event.

', 'EventCategoriesList$member' => NULL, 'EventCategoriesMap$SourceType' => '

The source type that the returned categories belong to

', 'EventSubscription$CustomerAwsId' => '

The AWS customer account associated with the RDS event notification subscription.

', 'EventSubscription$CustSubscriptionId' => '

The RDS event notification subscription Id.

', 'EventSubscription$SnsTopicArn' => '

The topic ARN of the RDS event notification subscription.

', 'EventSubscription$Status' => '

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

', 'EventSubscription$SubscriptionCreationTime' => '

The time the RDS event notification subscription was created.

', 'EventSubscription$SourceType' => '

The source type for the RDS event notification subscription.

', 'EventSubscription$EventSubscriptionArn' => '

The Amazon Resource Name (ARN) for the event subscription.

', 'EventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'EventsMessage$Marker' => '

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'FailoverDBClusterMessage$DBClusterIdentifier' => '

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'FailoverDBClusterMessage$TargetDBInstanceIdentifier' => '

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

', 'FeatureNameList$member' => NULL, 'Filter$Name' => '

The name of the filter. Filter names are case-sensitive.

', 'FilterValueList$member' => NULL, 'GlobalCluster$GlobalClusterIdentifier' => '

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

', 'GlobalCluster$GlobalClusterResourceId' => '

The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

', 'GlobalCluster$GlobalClusterArn' => '

The Amazon Resource Name (ARN) for the global database cluster.

', 'GlobalCluster$Status' => '

Specifies the current state of this global database cluster.

', 'GlobalCluster$Engine' => '

The Aurora database engine used by the global database cluster.

', 'GlobalCluster$EngineVersion' => '

Indicates the database engine version.

', 'GlobalCluster$DatabaseName' => '

The default database name within the new global database cluster.

', 'GlobalClusterMember$DBClusterArn' => '

The Amazon Resource Name (ARN) for each Aurora cluster.

', 'GlobalClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'IPRange$Status' => '

Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

', 'IPRange$CIDRIP' => '

Specifies the IP range.

', 'KeyList$member' => NULL, 'ListTagsForResourceMessage$ResourceName' => '

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

', 'LogTypeList$member' => NULL, 'MinimumEngineVersionPerAllowedValue$AllowedValue' => '

The allowed value for an option setting.

', 'MinimumEngineVersionPerAllowedValue$MinimumEngineVersion' => '

The minimum DB engine version required for the allowed value.

', 'ModifyCurrentDBClusterCapacityMessage$DBClusterIdentifier' => '

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DB cluster.

', 'ModifyCurrentDBClusterCapacityMessage$TimeoutAction' => '

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

', 'ModifyDBClusterEndpointMessage$DBClusterEndpointIdentifier' => '

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

', 'ModifyDBClusterEndpointMessage$EndpointType' => '

The type of the endpoint. One of: READER, ANY.

', 'ModifyDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'ModifyDBClusterMessage$NewDBClusterIdentifier' => '

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • The first character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

', 'ModifyDBClusterMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to use for the DB cluster.

', 'ModifyDBClusterMessage$MasterUserPassword' => '

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'ModifyDBClusterMessage$OptionGroupName' => '

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn\'t result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can\'t be removed from an option group. The option group can\'t be removed from a DB cluster once it is associated with a DB cluster.

', 'ModifyDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'ModifyDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'ModifyDBClusterMessage$EngineVersion' => '

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

', 'ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to modify.

', 'ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier' => '

The identifier for the DB cluster snapshot to modify the attributes for.

', 'ModifyDBClusterSnapshotAttributeMessage$AttributeName' => '

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

', 'ModifyDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'ModifyDBInstanceMessage$DBInstanceClass' => '

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

', 'ModifyDBInstanceMessage$DBSubnetGroupName' => '

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

', 'ModifyDBInstanceMessage$MasterUserPassword' => '

The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

', 'ModifyDBInstanceMessage$DBParameterGroupName' => '

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn\'t result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

', 'ModifyDBInstanceMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn\'t result in an outage and the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

', 'ModifyDBInstanceMessage$PreferredMaintenanceWindow' => '

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn\'t result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

', 'ModifyDBInstanceMessage$EngineVersion' => '

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

', 'ModifyDBInstanceMessage$LicenseModel' => '

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

', 'ModifyDBInstanceMessage$OptionGroupName' => '

Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn\'t result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'ModifyDBInstanceMessage$NewDBInstanceIdentifier' => '

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'ModifyDBInstanceMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise standard

', 'ModifyDBInstanceMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'ModifyDBInstanceMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'ModifyDBInstanceMessage$CACertificateIdentifier' => '

Indicates the certificate that needs to be associated with the instance.

', 'ModifyDBInstanceMessage$Domain' => '

The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain.

', 'ModifyDBInstanceMessage$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'ModifyDBInstanceMessage$DomainIAMRoleName' => '

The name of the IAM role to use when making API calls to the Directory Service.

', 'ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'ModifyDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

', 'ModifyDBSnapshotAttributeMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot to modify the attributes for.

', 'ModifyDBSnapshotAttributeMessage$AttributeName' => '

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.

', 'ModifyDBSnapshotMessage$DBSnapshotIdentifier' => '

The identifier of the DB snapshot to modify.

', 'ModifyDBSnapshotMessage$EngineVersion' => '

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

  • 5.5.46 (supported for 5.1 DB snapshots)

Oracle

  • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

  • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

  • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

', 'ModifyDBSnapshotMessage$OptionGroupName' => '

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide.

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the DB subnet group. This value is stored as a lowercase string. You can\'t modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the DB subnet group.

', 'ModifyEventSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription.

', 'ModifyEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

', 'ModifyEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

', 'ModifyGlobalClusterMessage$GlobalClusterIdentifier' => '

The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing global database cluster.

', 'ModifyGlobalClusterMessage$NewGlobalClusterIdentifier' => '

The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • The first character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

', 'ModifyOptionGroupMessage$OptionGroupName' => '

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'Option$OptionName' => '

The name of the option.

', 'Option$OptionDescription' => '

The description of the option.

', 'Option$OptionVersion' => '

The version of the option.

', 'OptionConfiguration$OptionName' => '

The configuration of options to include in a group.

', 'OptionConfiguration$OptionVersion' => '

The version for the option.

', 'OptionGroup$OptionGroupName' => '

Specifies the name of the option group.

', 'OptionGroup$OptionGroupDescription' => '

Provides a description of the option group.

', 'OptionGroup$EngineName' => '

Indicates the name of the engine that this option group can be applied to.

', 'OptionGroup$MajorEngineVersion' => '

Indicates the major engine version associated with this option group.

', 'OptionGroup$VpcId' => '

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

', 'OptionGroup$OptionGroupArn' => '

The Amazon Resource Name (ARN) for the option group.

', 'OptionGroupMembership$OptionGroupName' => '

The name of the option group that the instance belongs to.

', 'OptionGroupMembership$Status' => '

The status of the DB instance\'s option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

', 'OptionGroupOption$Name' => '

The name of the option.

', 'OptionGroupOption$Description' => '

The description of the option.

', 'OptionGroupOption$EngineName' => '

The name of the engine that this option can be applied to.

', 'OptionGroupOption$MajorEngineVersion' => '

Indicates the major engine version that the option is available for.

', 'OptionGroupOption$MinimumRequiredMinorEngineVersion' => '

The minimum required engine version for the option to be applied.

', 'OptionGroupOptionSetting$SettingName' => '

The name of the option group option.

', 'OptionGroupOptionSetting$SettingDescription' => '

The description of the option group option.

', 'OptionGroupOptionSetting$DefaultValue' => '

The default value for the option group option.

', 'OptionGroupOptionSetting$ApplyType' => '

The DB engine specific parameter type for the option group option.

', 'OptionGroupOptionSetting$AllowedValues' => '

Indicates the acceptable values for the option group option.

', 'OptionGroupOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'OptionGroups$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'OptionNamesList$member' => NULL, 'OptionSetting$Name' => '

The name of the option that has settings that you can set.

', 'OptionSetting$Value' => '

The current value of the option setting.

', 'OptionSetting$DefaultValue' => '

The default value of the option setting.

', 'OptionSetting$Description' => '

The description of the option setting.

', 'OptionSetting$ApplyType' => '

The DB engine specific parameter type.

', 'OptionSetting$DataType' => '

The data type of the option setting.

', 'OptionSetting$AllowedValues' => '

The allowed values of the option setting.

', 'OptionVersion$Version' => '

The version of the option.

', 'OptionsConflictsWith$member' => NULL, 'OptionsDependedOn$member' => NULL, 'OrderableDBInstanceOption$Engine' => '

The engine type of a DB instance.

', 'OrderableDBInstanceOption$EngineVersion' => '

The engine version of a DB instance.

', 'OrderableDBInstanceOption$DBInstanceClass' => '

The DB instance class for a DB instance.

', 'OrderableDBInstanceOption$LicenseModel' => '

The license model for a DB instance.

', 'OrderableDBInstanceOption$StorageType' => '

Indicates the storage type for a DB instance.

', 'OrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

', 'Parameter$ParameterName' => '

Specifies the name of the parameter.

', 'Parameter$ParameterValue' => '

Specifies the value of the parameter.

', 'Parameter$Description' => '

Provides a description of the parameter.

', 'Parameter$Source' => '

Indicates the source of the parameter value.

', 'Parameter$ApplyType' => '

Specifies the engine specific parameters type.

', 'Parameter$DataType' => '

Specifies the valid data type for the parameter.

', 'Parameter$AllowedValues' => '

Specifies the valid range of values for the parameter.

', 'Parameter$MinimumEngineVersion' => '

The earliest engine version to which the parameter can apply.

', 'PendingMaintenanceAction$Action' => '

The type of pending maintenance action that is available for the resource. Valid actions are system-update and db-upgrade.

', 'PendingMaintenanceAction$OptInStatus' => '

Indicates the type of opt-in request that has been received for the resource.

', 'PendingMaintenanceAction$Description' => '

A description providing more detail about the maintenance action.

', 'PendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

', 'PendingModifiedValues$DBInstanceClass' => '

Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

', 'PendingModifiedValues$MasterUserPassword' => '

Contains the pending or currently-in-progress change of the master credentials for the DB instance.

', 'PendingModifiedValues$EngineVersion' => '

Indicates the database engine version.

', 'PendingModifiedValues$LicenseModel' => '

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

', 'PendingModifiedValues$DBInstanceIdentifier' => '

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

', 'PendingModifiedValues$StorageType' => '

Specifies the storage type to be associated with the DB instance.

', 'PendingModifiedValues$CACertificateIdentifier' => '

Specifies the identifier of the CA certificate for the DB instance.

', 'PendingModifiedValues$DBSubnetGroupName' => '

The new DB subnet group for the DB instance.

', 'ProcessorFeature$Name' => '

The name of the processor feature. Valid names are coreCount and threadsPerCore.

', 'ProcessorFeature$Value' => '

The value of a processor feature name.

', 'PromoteReadReplicaDBClusterMessage$DBClusterIdentifier' => '

The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster Read Replica.

Example: my-cluster-replica1

', 'PromoteReadReplicaMessage$DBInstanceIdentifier' => '

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing Read Replica DB instance.

Example: mydbinstance

', 'PromoteReadReplicaMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferingId' => '

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

', 'PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId' => '

Customer-specified identifier to track this reservation.

Example: myreservationID

', 'ReadReplicaDBClusterIdentifierList$member' => NULL, 'ReadReplicaDBInstanceIdentifierList$member' => NULL, 'ReadReplicaIdentifierList$member' => NULL, 'ReadersArnList$member' => NULL, 'RebootDBInstanceMessage$DBInstanceIdentifier' => '

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'RemoveFromGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier to detach from the Aurora global database cluster.

', 'RemoveFromGlobalClusterMessage$DbClusterIdentifier' => '

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

', 'RemoveRoleFromDBClusterMessage$DBClusterIdentifier' => '

The name of the DB cluster to disassociate the IAM role from.

', 'RemoveRoleFromDBClusterMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

', 'RemoveRoleFromDBInstanceMessage$DBInstanceIdentifier' => '

The name of the DB instance to disassociate the IAM role from.

', 'RemoveRoleFromDBInstanceMessage$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

', 'RemoveRoleFromDBInstanceMessage$FeatureName' => '

The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName' => '

The name of the RDS event notification subscription you want to remove a source identifier from.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier' => '

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

', 'RemoveTagsFromResourceMessage$ResourceName' => '

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

', 'ReservedDBInstance$ReservedDBInstanceId' => '

The unique identifier for the reservation.

', 'ReservedDBInstance$ReservedDBInstancesOfferingId' => '

The offering identifier.

', 'ReservedDBInstance$DBInstanceClass' => '

The DB instance class for the reserved DB instance.

', 'ReservedDBInstance$CurrencyCode' => '

The currency code for the reserved DB instance.

', 'ReservedDBInstance$ProductDescription' => '

The description of the reserved DB instance.

', 'ReservedDBInstance$OfferingType' => '

The offering type of this reserved DB instance.

', 'ReservedDBInstance$State' => '

The state of the reserved DB instance.

', 'ReservedDBInstance$ReservedDBInstanceArn' => '

The Amazon Resource Name (ARN) for the reserved DB instance.

', 'ReservedDBInstanceMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'ReservedDBInstancesOffering$ReservedDBInstancesOfferingId' => '

The offering identifier.

', 'ReservedDBInstancesOffering$DBInstanceClass' => '

The DB instance class for the reserved DB instance.

', 'ReservedDBInstancesOffering$CurrencyCode' => '

The currency code for the reserved DB instance offering.

', 'ReservedDBInstancesOffering$ProductDescription' => '

The database engine used by the offering.

', 'ReservedDBInstancesOffering$OfferingType' => '

The offering type.

', 'ReservedDBInstancesOfferingMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'ResetDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to reset.

', 'ResetDBParameterGroupMessage$DBParameterGroupName' => '

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

', 'ResourcePendingMaintenanceActions$ResourceIdentifier' => '

The ARN of the resource that has pending maintenance actions.

', 'RestoreDBClusterFromS3Message$CharacterSetName' => '

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

', 'RestoreDBClusterFromS3Message$DatabaseName' => '

The database name for the restored DB cluster.

', 'RestoreDBClusterFromS3Message$DBClusterIdentifier' => '

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is isn\'t case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

', 'RestoreDBClusterFromS3Message$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

', 'RestoreDBClusterFromS3Message$DBSubnetGroupName' => '

A DB subnet group to associate with the restored DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterFromS3Message$Engine' => '

The name of the database engine to be used for the restored DB cluster.

Valid Values: aurora, aurora-postgresql

', 'RestoreDBClusterFromS3Message$EngineVersion' => '

The version number of the database engine to use.

Aurora MySQL

Example: 5.6.10a

Aurora PostgreSQL

Example: 9.6.3

', 'RestoreDBClusterFromS3Message$MasterUsername' => '

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'RestoreDBClusterFromS3Message$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'RestoreDBClusterFromS3Message$OptionGroupName' => '

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can\'t be removed from an option group. An option group can\'t be removed from a DB cluster once it is associated with a DB cluster.

', 'RestoreDBClusterFromS3Message$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'RestoreDBClusterFromS3Message$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

', 'RestoreDBClusterFromS3Message$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

', 'RestoreDBClusterFromS3Message$SourceEngine' => '

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

', 'RestoreDBClusterFromS3Message$SourceEngineVersion' => '

The version of the database that the backup files were created from.

MySQL version 5.5 and 5.6 are supported.

Example: 5.6.22

', 'RestoreDBClusterFromS3Message$S3BucketName' => '

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

', 'RestoreDBClusterFromS3Message$S3Prefix' => '

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

', 'RestoreDBClusterFromS3Message$S3IngestionRoleArn' => '

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier' => '

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn\'t case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

', 'RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier' => '

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

', 'RestoreDBClusterFromSnapshotMessage$Engine' => '

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

', 'RestoreDBClusterFromSnapshotMessage$EngineVersion' => '

The version of the database engine to use for the new DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName' => '

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

', 'RestoreDBClusterFromSnapshotMessage$DatabaseName' => '

The database name for the restored DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$OptionGroupName' => '

The name of the option group to use for the restored DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$KmsKeyId' => '

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you don\'t specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

', 'RestoreDBClusterFromSnapshotMessage$EngineMode' => '

The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier' => '

The name of the new DB cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'RestoreDBClusterToPointInTimeMessage$RestoreType' => '

The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can\'t specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don\'t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier' => '

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName' => '

The DB subnet group name to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterToPointInTimeMessage$OptionGroupName' => '

The name of the option group for the new DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$KmsKeyId' => '

The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you don\'t specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

  • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

', 'RestoreDBClusterToPointInTimeMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier' => '

Name of the DB instance to create from the DB snapshot. This parameter isn\'t case-sensitive.

Constraints:

  • Must contain from 1 to 63 numbers, letters, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

', 'RestoreDBInstanceFromDBSnapshotMessage$DBSnapshotIdentifier' => '

The identifier for the DB snapshot to restore from.

Constraints:

  • Must match the identifier of an existing DBSnapshot.

  • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

', 'RestoreDBInstanceFromDBSnapshotMessage$DBInstanceClass' => '

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

', 'RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone' => '

The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

', 'RestoreDBInstanceFromDBSnapshotMessage$DBSubnetGroupName' => '

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBInstanceFromDBSnapshotMessage$LicenseModel' => '

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

', 'RestoreDBInstanceFromDBSnapshotMessage$DBName' => '

The database name for the restored DB instance.

This parameter doesn\'t apply to the MySQL, PostgreSQL, or MariaDB engines.

', 'RestoreDBInstanceFromDBSnapshotMessage$Engine' => '

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

', 'RestoreDBInstanceFromDBSnapshotMessage$OptionGroupName' => '

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'RestoreDBInstanceFromDBSnapshotMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'RestoreDBInstanceFromDBSnapshotMessage$Domain' => '

Specify the Active Directory Domain to restore the instance in.

', 'RestoreDBInstanceFromDBSnapshotMessage$DomainIAMRoleName' => '

Specify the name of the IAM role to be used when making API calls to the Directory Service.

', 'RestoreDBInstanceFromDBSnapshotMessage$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBInstanceFromS3Message$DBName' => '

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

', 'RestoreDBInstanceFromS3Message$DBInstanceIdentifier' => '

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'RestoreDBInstanceFromS3Message$DBInstanceClass' => '

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.

', 'RestoreDBInstanceFromS3Message$Engine' => '

The name of the database engine to be used for this instance.

Valid Values: mysql

', 'RestoreDBInstanceFromS3Message$MasterUsername' => '

The name for the master user.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

', 'RestoreDBInstanceFromS3Message$MasterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

', 'RestoreDBInstanceFromS3Message$AvailabilityZone' => '

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

Default: A random, system-chosen Availability Zone in the endpoint\'s AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can\'t be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

', 'RestoreDBInstanceFromS3Message$DBSubnetGroupName' => '

A DB subnet group to associate with this DB instance.

', 'RestoreDBInstanceFromS3Message$PreferredMaintenanceWindow' => '

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

  • Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred backup window.

  • Must be at least 30 minutes.

', 'RestoreDBInstanceFromS3Message$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.

', 'RestoreDBInstanceFromS3Message$PreferredBackupWindow' => '

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'RestoreDBInstanceFromS3Message$EngineVersion' => '

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

', 'RestoreDBInstanceFromS3Message$LicenseModel' => '

The license model for this DB instance. Use general-public-license.

', 'RestoreDBInstanceFromS3Message$OptionGroupName' => '

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

', 'RestoreDBInstanceFromS3Message$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

', 'RestoreDBInstanceFromS3Message$KmsKeyId' => '

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

', 'RestoreDBInstanceFromS3Message$MonitoringRoleArn' => '

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

', 'RestoreDBInstanceFromS3Message$SourceEngine' => '

The name of the engine of your source database.

Valid Values: mysql

', 'RestoreDBInstanceFromS3Message$SourceEngineVersion' => '

The engine version of your source database.

Valid Values: 5.6

', 'RestoreDBInstanceFromS3Message$S3BucketName' => '

The name of your Amazon S3 bucket that contains your database backup file.

', 'RestoreDBInstanceFromS3Message$S3Prefix' => '

The prefix of your Amazon S3 bucket.

', 'RestoreDBInstanceFromS3Message$S3IngestionRoleArn' => '

An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

', 'RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId' => '

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier' => '

The identifier of the source DB instance from which to restore.

Constraints:

  • Must match the identifier of an existing DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$TargetDBInstanceIdentifier' => '

The name of the new DB instance to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can\'t end with a hyphen or contain two consecutive hyphens

', 'RestoreDBInstanceToPointInTimeMessage$DBInstanceClass' => '

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$AvailabilityZone' => '

The EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone.

Constraint: You can\'t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

', 'RestoreDBInstanceToPointInTimeMessage$DBSubnetGroupName' => '

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBInstanceToPointInTimeMessage$LicenseModel' => '

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

', 'RestoreDBInstanceToPointInTimeMessage$DBName' => '

The database name for the restored DB instance.

This parameter is not used for the MySQL or MariaDB engines.

', 'RestoreDBInstanceToPointInTimeMessage$Engine' => '

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

', 'RestoreDBInstanceToPointInTimeMessage$OptionGroupName' => '

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can\'t be removed from an option group, and that option group can\'t be removed from a DB instance once it is associated with a DB instance

', 'RestoreDBInstanceToPointInTimeMessage$StorageType' => '

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise standard

', 'RestoreDBInstanceToPointInTimeMessage$TdeCredentialArn' => '

The ARN from the key store with which to associate the instance for TDE encryption.

', 'RestoreDBInstanceToPointInTimeMessage$TdeCredentialPassword' => '

The password for the given ARN from the key store in order to access the device.

', 'RestoreDBInstanceToPointInTimeMessage$Domain' => '

Specify the Active Directory Domain to restore the instance in.

', 'RestoreDBInstanceToPointInTimeMessage$DomainIAMRoleName' => '

Specify the name of the IAM role to be used when making API calls to the Directory Service.

', 'RestoreDBInstanceToPointInTimeMessage$DBParameterGroupName' => '

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBInstanceToPointInTimeMessage$SourceDbiResourceId' => '

The resource ID of the source DB instance from which to restore.

', 'RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName' => '

The name of the DB security group to revoke ingress from.

', 'RevokeDBSecurityGroupIngressMessage$CIDRIP' => '

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can\'t be provided.

', 'RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupName' => '

The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupId' => '

The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => '

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

', 'SourceIdsList$member' => NULL, 'SourceRegion$RegionName' => '

The name of the source AWS Region.

', 'SourceRegion$Endpoint' => '

The endpoint for the source AWS Region endpoint.

', 'SourceRegion$Status' => '

The status of the source AWS Region.

', 'SourceRegionMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'StartDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.

', 'StartDBInstanceMessage$DBInstanceIdentifier' => '

The user-supplied instance identifier.

', 'StopDBClusterMessage$DBClusterIdentifier' => '

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

', 'StopDBInstanceMessage$DBInstanceIdentifier' => '

The user-supplied instance identifier.

', 'StopDBInstanceMessage$DBSnapshotIdentifier' => '

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

', 'StringList$member' => NULL, 'Subnet$SubnetIdentifier' => '

Specifies the identifier of the subnet.

', 'Subnet$SubnetStatus' => '

Specifies the status of the subnet.

', 'SubnetIdentifierList$member' => NULL, 'Tag$Key' => '

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can\'t be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'Tag$Value' => '

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can\'t be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'Timezone$TimezoneName' => '

The name of the time zone.

', 'UpgradeTarget$Engine' => '

The name of the upgrade target database engine.

', 'UpgradeTarget$EngineVersion' => '

The version number of the upgrade target database engine.

', 'UpgradeTarget$Description' => '

The version of the database engine that a DB instance can be upgraded to.

', 'ValidStorageOptions$StorageType' => '

The valid storage types for your DB instance. For example, gp2, io1.

', 'VpcSecurityGroupIdList$member' => NULL, 'VpcSecurityGroupMembership$VpcSecurityGroupId' => '

The name of the VPC security group.

', 'VpcSecurityGroupMembership$Status' => '

The status of the VPC security group.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterEndpointMessage$StaticMembers' => '

List of DB instance identifiers that are part of the custom endpoint group.

', 'CreateDBClusterEndpointMessage$ExcludedMembers' => '

List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

', 'DBCluster$CustomEndpoints' => '

Identifies all custom endpoints associated with the cluster.

', 'DBClusterEndpoint$StaticMembers' => '

List of DB instance identifiers that are part of the custom endpoint group.

', 'DBClusterEndpoint$ExcludedMembers' => '

List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

', 'ModifyDBClusterEndpointMessage$StaticMembers' => '

List of DB instance identifiers that are part of the custom endpoint group.

', 'ModifyDBClusterEndpointMessage$ExcludedMembers' => '

List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

', ], ], 'Subnet' => [ 'base' => '

This data type is used as a response element in the DescribeDBSubnetGroups action.

', 'refs' => [ 'SubnetList$member' => NULL, ], ], 'SubnetAlreadyInUse' => [ 'base' => '

The DB subnet is already in use in the Availability Zone.

', 'refs' => [], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateDBSubnetGroupMessage$SubnetIds' => '

The EC2 Subnet IDs for the DB subnet group.

', 'ModifyDBSubnetGroupMessage$SubnetIds' => '

The EC2 subnet IDs for the DB subnet group.

', ], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroup$Subnets' => '

Contains a list of Subnet elements.

', ], ], 'SubscriptionAlreadyExistFault' => [ 'base' => '

The supplied subscription name already exists.

', 'refs' => [], ], 'SubscriptionCategoryNotFoundFault' => [ 'base' => '

The supplied category does not exist.

', 'refs' => [], ], 'SubscriptionNotFoundFault' => [ 'base' => '

The subscription name does not exist.

', 'refs' => [], ], 'SupportedCharacterSetsList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedCharacterSets' => '

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

', ], ], 'SupportedTimezonesList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedTimezones' => '

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

', ], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'BacktrackDBClusterMessage$BacktrackTo' => '

The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

If the specified time is not a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

  • Must contain a valid ISO 8601 timestamp.

  • Can\'t contain a timestamp set in the future.

Example: 2017-07-08T18:00Z

', 'Certificate$ValidFrom' => '

The starting date from which the certificate is valid.

', 'Certificate$ValidTill' => '

The final date that the certificate continues to be valid.

', 'DBCluster$EarliestRestorableTime' => '

The earliest time to which a database can be restored with point-in-time restore.

', 'DBCluster$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DBCluster$ClusterCreateTime' => '

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

', 'DBCluster$EarliestBacktrackTime' => '

The earliest time to which a DB cluster can be backtracked.

', 'DBClusterBacktrack$BacktrackTo' => '

The timestamp of the time to which the DB cluster was backtracked.

', 'DBClusterBacktrack$BacktrackedFrom' => '

The timestamp of the time from which the DB cluster was backtracked.

', 'DBClusterBacktrack$BacktrackRequestCreationTime' => '

The timestamp of the time at which the backtrack was requested.

', 'DBClusterSnapshot$SnapshotCreateTime' => '

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

', 'DBClusterSnapshot$ClusterCreateTime' => '

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

', 'DBInstance$InstanceCreateTime' => '

Provides the date and time the DB instance was created.

', 'DBInstance$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DBInstanceAutomatedBackup$InstanceCreateTime' => '

Provides the date and time that the DB instance was created.

', 'DBSnapshot$SnapshotCreateTime' => '

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

', 'DBSnapshot$InstanceCreateTime' => '

Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

', 'DescribeEventsMessage$StartTime' => '

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

', 'DescribeEventsMessage$EndTime' => '

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

', 'Event$Date' => '

Specifies the date and time of the event.

', 'PendingMaintenanceAction$AutoAppliedAfterDate' => '

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

', 'PendingMaintenanceAction$ForcedApplyDate' => '

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

', 'PendingMaintenanceAction$CurrentApplyDate' => '

The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

', 'ReservedDBInstance$StartTime' => '

The time the reservation started.

', 'RestoreDBClusterToPointInTimeMessage$RestoreToTime' => '

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Must be specified if UseLatestRestorableTime parameter is not provided

  • Can\'t be specified if UseLatestRestorableTime parameter is true

  • Can\'t be specified if RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

', 'RestoreDBInstanceToPointInTimeMessage$RestoreTime' => '

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Can\'t be specified if UseLatestRestorableTime parameter is true

Example: 2009-09-07T23:45:00Z

', 'RestoreWindow$EarliestTime' => '

The earliest time you can restore an instance to.

', 'RestoreWindow$LatestTime' => '

The latest time you can restore an instance to.

', ], ], 'Tag' => [ 'base' => '

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => '

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'refs' => [ 'AddTagsToResourceMessage$Tags' => '

The tags to be assigned to the Amazon RDS resource.

', 'CopyDBClusterParameterGroupMessage$Tags' => NULL, 'CopyDBClusterSnapshotMessage$Tags' => NULL, 'CopyDBParameterGroupMessage$Tags' => NULL, 'CopyDBSnapshotMessage$Tags' => NULL, 'CopyOptionGroupMessage$Tags' => NULL, 'CreateDBClusterMessage$Tags' => NULL, 'CreateDBClusterParameterGroupMessage$Tags' => NULL, 'CreateDBClusterSnapshotMessage$Tags' => '

The tags to be assigned to the DB cluster snapshot.

', 'CreateDBInstanceMessage$Tags' => NULL, 'CreateDBInstanceReadReplicaMessage$Tags' => NULL, 'CreateDBParameterGroupMessage$Tags' => NULL, 'CreateDBSecurityGroupMessage$Tags' => NULL, 'CreateDBSnapshotMessage$Tags' => NULL, 'CreateDBSubnetGroupMessage$Tags' => NULL, 'CreateEventSubscriptionMessage$Tags' => NULL, 'CreateOptionGroupMessage$Tags' => NULL, 'PurchaseReservedDBInstancesOfferingMessage$Tags' => NULL, 'RestoreDBClusterFromS3Message$Tags' => NULL, 'RestoreDBClusterFromSnapshotMessage$Tags' => '

The tags to be assigned to the restored DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$Tags' => NULL, 'RestoreDBInstanceFromDBSnapshotMessage$Tags' => NULL, 'RestoreDBInstanceFromS3Message$Tags' => '

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

', 'RestoreDBInstanceToPointInTimeMessage$Tags' => NULL, 'TagListMessage$TagList' => '

List of tags returned by the ListTagsForResource operation.

', ], ], 'TagListMessage' => [ 'base' => '

', 'refs' => [], ], 'Timezone' => [ 'base' => '

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

', 'refs' => [ 'SupportedTimezonesList$member' => NULL, ], ], 'UpgradeTarget' => [ 'base' => '

The version of the database engine that a DB instance can be upgraded to.

', 'refs' => [ 'ValidUpgradeTargetList$member' => NULL, ], ], 'ValidDBInstanceModificationsMessage' => [ 'base' => '

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

', 'refs' => [ 'DescribeValidDBInstanceModificationsResult$ValidDBInstanceModificationsMessage' => NULL, ], ], 'ValidStorageOptions' => [ 'base' => '

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

', 'refs' => [ 'ValidStorageOptionsList$member' => NULL, ], ], 'ValidStorageOptionsList' => [ 'base' => NULL, 'refs' => [ 'ValidDBInstanceModificationsMessage$Storage' => '

Valid storage options for your DB instance.

', ], ], 'ValidUpgradeTargetList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$ValidUpgradeTarget' => '

A list of engine versions that this database engine version can be upgraded to.

', ], ], 'VpcSecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this DB cluster.

', 'CreateDBInstanceMessage$VpcSecurityGroupIds' => '

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', 'CreateDBInstanceReadReplicaMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with the Read Replica.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', 'ModifyDBClusterMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the DB cluster will belong to.

', 'ModifyDBInstanceMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

', 'OptionConfiguration$VpcSecurityGroupMemberships' => '

A list of VpcSecurityGroupMemebrship name strings used for this option.

', 'RestoreDBClusterFromS3Message$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with the restored DB cluster.

', 'RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the new DB cluster will belong to.

', 'RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the new DB cluster belongs to.

', 'RestoreDBInstanceFromDBSnapshotMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', 'RestoreDBInstanceFromS3Message$VpcSecurityGroupIds' => '

A list of VPC security groups to associate with this DB instance.

', 'RestoreDBInstanceToPointInTimeMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group\'s VPC.

', ], ], 'VpcSecurityGroupMembership' => [ 'base' => '

This data type is used as a response element for queries on VPC security group membership.

', 'refs' => [ 'VpcSecurityGroupMembershipList$member' => NULL, ], ], 'VpcSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$VpcSecurityGroups' => '

Provides a list of VPC security groups that the DB cluster belongs to.

', 'DBInstance$VpcSecurityGroups' => '

Provides a list of VPC security group elements that the DB instance belongs to.

', 'Option$VpcSecurityGroupMemberships' => '

If the option requires access to a port, then this VPC security group allows access to the port.

', ], ], ],];