From fe2109b8e2a07d28d039d4a960f8b3a93094a842 Mon Sep 17 00:00:00 2001 From: Jonathan Eskew Date: Wed, 7 Oct 2015 17:56:29 -0700 Subject: [PATCH] Update models for next release --- CHANGELOG.md | 11 + features/smoke/ecs/ecs.feature | 6 +- features/smoke/inspector/inspector.feature | 2 +- features/smoke/iot/iot.feature | 12 + features/smoke/iotdataplane/iot.feature | 8 + .../marketplacecommerceanalytics.feature | 2 +- src/Iot/Exception/IotException.php | 9 + src/Iot/IotClient.php | 88 + .../Exception/IotDataPlaneException.php | 9 + src/IotDataPlane/IotDataPlaneClient.php | 18 + src/Lambda/LambdaClient.php | 14 + src/Sdk.php | 2 + src/data/data.iot/2015-05-28/api-2.json | 386 +++ src/data/data.iot/2015-05-28/api-2.json.php | 3 + src/data/data.iot/2015-05-28/docs-2.json | 152 + src/data/data.iot/2015-05-28/docs-2.json.php | 3 + src/data/ecs/2014-11-13/api-2.json | 130 +- src/data/ecs/2014-11-13/api-2.json.php | 2 +- src/data/ecs/2014-11-13/docs-2.json | 295 +- src/data/ecs/2014-11-13/docs-2.json.php | 2 +- src/data/iot/2015-05-28/api-2.json | 2851 +++++++++++++++++ src/data/iot/2015-05-28/api-2.json.php | 3 + src/data/iot/2015-05-28/docs-2.json | 1070 +++++++ src/data/iot/2015-05-28/docs-2.json.php | 3 + src/data/lambda/2015-03-31/api-2.json | 524 ++- src/data/lambda/2015-03-31/api-2.json.php | 2 +- src/data/lambda/2015-03-31/docs-2.json | 154 +- src/data/lambda/2015-03-31/docs-2.json.php | 2 +- src/data/manifest.json | 14 + src/data/manifest.json.php | 2 +- 30 files changed, 5632 insertions(+), 147 deletions(-) create mode 100644 features/smoke/iot/iot.feature create mode 100644 features/smoke/iotdataplane/iot.feature create mode 100644 src/Iot/Exception/IotException.php create mode 100644 src/Iot/IotClient.php create mode 100644 src/IotDataPlane/Exception/IotDataPlaneException.php create mode 100644 src/IotDataPlane/IotDataPlaneClient.php create mode 100644 src/data/data.iot/2015-05-28/api-2.json create mode 100644 src/data/data.iot/2015-05-28/api-2.json.php create mode 100644 src/data/data.iot/2015-05-28/docs-2.json create mode 100644 src/data/data.iot/2015-05-28/docs-2.json.php create mode 100644 src/data/iot/2015-05-28/api-2.json create mode 100644 src/data/iot/2015-05-28/api-2.json.php create mode 100644 src/data/iot/2015-05-28/docs-2.json create mode 100644 src/data/iot/2015-05-28/docs-2.json.php diff --git a/CHANGELOG.md b/CHANGELOG.md index b07b339d34..b5cc2ed239 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # CHANGELOG +## next release + +* `Aws\Ecs` - Added support for more Docker options hostname, Docker labels, + working directory, networking disabled, privileged execution, read-only root + filesystem, DNS servers, DNS search domains, ulimits, log configuration, extra + hosts (hosts to add to /etc/hosts), and security options (for MLS systems like + SELinux). +* `Aws\Iot` - Added support for the **AWS IoT** service. +* `Aws\IotDataPlane` - Added support for the **AWS IoT Data Plane** service. +* `Aws\Lambda` - Added support for function versioning. + ## 3.7.0 - 2015-10-07 * `Aws\ConfigService` - Added support for config rules, evaluation strategies, diff --git a/features/smoke/ecs/ecs.feature b/features/smoke/ecs/ecs.feature index 82c457674f..d3a38155d7 100644 --- a/features/smoke/ecs/ecs.feature +++ b/features/smoke/ecs/ecs.feature @@ -11,4 +11,8 @@ Feature: Amazon ECS Scenario: Handling errors When I attempt to call the "StopTask" API with: | task | xxxxxxxxxxx-xxxxxxxxxxxx-xxxxxxxxxxx | - Then the error code should be "ClusterNotFoundException" + Then the error code should be "ClientException" + And I expect the response error message to include: + """ + task was not found + """ diff --git a/features/smoke/inspector/inspector.feature b/features/smoke/inspector/inspector.feature index 53a06e6f8d..9a846b0e21 100644 --- a/features/smoke/inspector/inspector.feature +++ b/features/smoke/inspector/inspector.feature @@ -9,4 +9,4 @@ Feature: Amazon Inspector Scenario: Handling errors When I attempt to call the "DescribeApplication" API with: | applicationArn | fake-arn | - Then I expect the response error code to be "NoSuchEntityException" + Then I expect the response error code to be "InvalidInputException" diff --git a/features/smoke/iot/iot.feature b/features/smoke/iot/iot.feature new file mode 100644 index 0000000000..07c35e37cc --- /dev/null +++ b/features/smoke/iot/iot.feature @@ -0,0 +1,12 @@ +# language: en +@iot +Feature: AWS IoT + + Scenario: Making a request + When I call the "ListPolicies" API + Then the value at "policies" should be a list + + Scenario: Handling errors + When I attempt to call the "DescribeThing" API with: + | thingName | fake-thing | + Then I expect the response error code to be "ResourceNotFoundException" diff --git a/features/smoke/iotdataplane/iot.feature b/features/smoke/iotdataplane/iot.feature new file mode 100644 index 0000000000..a5381f1a7f --- /dev/null +++ b/features/smoke/iotdataplane/iot.feature @@ -0,0 +1,8 @@ +# language: en +@iotdataplane @data.iot +Feature: AWS IoT Data Plane + + Scenario: Handling errors + When I attempt to call the "GetThingShadow" API with: + | thingName | fake-thing | + Then I expect the response error code to be "ResourceNotFoundException" diff --git a/features/smoke/marketplacecommerceanalytics/marketplacecommerceanalytics.feature b/features/smoke/marketplacecommerceanalytics/marketplacecommerceanalytics.feature index d6eb8a245d..139da79954 100644 --- a/features/smoke/marketplacecommerceanalytics/marketplacecommerceanalytics.feature +++ b/features/smoke/marketplacecommerceanalytics/marketplacecommerceanalytics.feature @@ -9,4 +9,4 @@ Feature: AWS Marketplace Commerce Analytics | roleNameArn | fake-arn | | destinationS3BucketName | fake-bucket | | snsTopicArn | fake-arn | - Then I expect the response error code to be "MarketplaceCommerceAnalyticsException" + Then I expect the response error code to be "SerializationException" diff --git a/src/Iot/Exception/IotException.php b/src/Iot/Exception/IotException.php new file mode 100644 index 0000000000..8fff3e41ba --- /dev/null +++ b/src/Iot/Exception/IotException.php @@ -0,0 +1,9 @@ + '2.0', 'metadata' => [ 'apiVersion' => '2015-05-28', 'endpointPrefix' => 'data.iot', 'serviceFullName' => 'AWS IoT Data Plane', 'signatureVersion' => 'v4', 'signingName' => 'iotdata', 'protocol' => 'rest-json', ], 'operations' => [ 'DeleteThingShadow' => [ 'name' => 'DeleteThingShadow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/things/{thingName}/shadow', ], 'input' => [ 'shape' => 'DeleteThingShadowRequest', ], 'output' => [ 'shape' => 'DeleteThingShadowResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'MethodNotAllowedException', 'error' => [ 'httpStatusCode' => 405, ], 'exception' => true, ], [ 'shape' => 'UnsupportedDocumentEncodingException', 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], ], ], 'GetThingShadow' => [ 'name' => 'GetThingShadow', 'http' => [ 'method' => 'GET', 'requestUri' => '/things/{thingName}/shadow', ], 'input' => [ 'shape' => 'GetThingShadowRequest', ], 'output' => [ 'shape' => 'GetThingShadowResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'MethodNotAllowedException', 'error' => [ 'httpStatusCode' => 405, ], 'exception' => true, ], [ 'shape' => 'UnsupportedDocumentEncodingException', 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], ], ], 'Publish' => [ 'name' => 'Publish', 'http' => [ 'method' => 'POST', 'requestUri' => '/topics/{topic}', ], 'input' => [ 'shape' => 'PublishRequest', ], 'errors' => [ [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'MethodNotAllowedException', 'error' => [ 'httpStatusCode' => 405, ], 'exception' => true, ], ], ], 'UpdateThingShadow' => [ 'name' => 'UpdateThingShadow', 'http' => [ 'method' => 'POST', 'requestUri' => '/things/{thingName}/shadow', ], 'input' => [ 'shape' => 'UpdateThingShadowRequest', ], 'output' => [ 'shape' => 'UpdateThingShadowResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'RequestEntityTooLargeException', 'error' => [ 'httpStatusCode' => 413, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'MethodNotAllowedException', 'error' => [ 'httpStatusCode' => 405, ], 'exception' => true, ], [ 'shape' => 'UnsupportedDocumentEncodingException', 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], ], ], ], 'shapes' => [ 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DeleteThingShadowRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], ], ], 'DeleteThingShadowResponse' => [ 'type' => 'structure', 'required' => [ 'payload', ], 'members' => [ 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'ErrorMessage' => [ 'type' => 'string', ], 'GetThingShadowRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], ], ], 'GetThingShadowResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'InternalFailureException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'JsonDocument' => [ 'type' => 'blob', ], 'MethodNotAllowedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 405, ], 'exception' => true, ], 'Payload' => [ 'type' => 'blob', ], 'PublishRequest' => [ 'type' => 'structure', 'members' => [ 'topic' => [ 'shape' => 'Topic', 'location' => 'uri', 'locationName' => 'topic', ], 'qos' => [ 'shape' => 'Qos', 'location' => 'querystring', 'locationName' => 'qos', ], 'payload' => [ 'shape' => 'Payload', ], ], 'required' => [ 'topic', ], 'payload' => 'payload', ], 'Qos' => [ 'type' => 'integer', 'min' => 0, 'max' => 1, ], 'RequestEntityTooLargeException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'error' => [ 'httpStatusCode' => 413, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], 'ThingName' => [ 'type' => 'string', 'min' => 1, 'max' => 128, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'Topic' => [ 'type' => 'string', ], 'UnauthorizedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], 'UnsupportedDocumentEncodingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], 'UpdateThingShadowRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', 'payload', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'UpdateThingShadowResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'errorMessage' => [ 'type' => 'string', ], ],]; diff --git a/src/data/data.iot/2015-05-28/docs-2.json b/src/data/data.iot/2015-05-28/docs-2.json new file mode 100644 index 0000000000..79ce83d3a6 --- /dev/null +++ b/src/data/data.iot/2015-05-28/docs-2.json @@ -0,0 +1,152 @@ +{ + "version": "2.0", + "operations": { + "DeleteThingShadow": "

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

", + "GetThingShadow": "

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

", + "Publish": "

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

", + "UpdateThingShadow": "

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

" + }, + "service": "AWS IoT (Beta)

AWS IoT is considered a beta service as defined in the Service Terms

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.

", + "shapes": { + "ConflictException": { + "base": "

The specified version does not match the version of the document.

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

The input for the DeleteThingShadow operation.

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

The output from the DeleteThingShadow operation.

", + "refs": { + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "ConflictException$message": "

The message for the exception.

", + "MethodNotAllowedException$message": "

The message for the exception.

", + "RequestEntityTooLargeException$message": "

The message for the exception.

" + } + }, + "GetThingShadowRequest": { + "base": "

The input for the GetThingShadow operation.

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

The output from the GetThingShadow operation.

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

An unexpected error has occurred.

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

The request is not valid.

", + "refs": { + } + }, + "JsonDocument": { + "base": null, + "refs": { + "DeleteThingShadowResponse$payload": "

The state information, in JSON format.

", + "GetThingShadowResponse$payload": "

The state information, in JSON format.

", + "UpdateThingShadowRequest$payload": "

The state information, in JSON format.

", + "UpdateThingShadowResponse$payload": "

The state information, in JSON format.

" + } + }, + "MethodNotAllowedException": { + "base": "

The specified combination of HTTP verb and URI is not supported.

", + "refs": { + } + }, + "Payload": { + "base": null, + "refs": { + "PublishRequest$payload": "

The state information, in JSON format.

" + } + }, + "PublishRequest": { + "base": "

The input for the Publish operation.

", + "refs": { + } + }, + "Qos": { + "base": null, + "refs": { + "PublishRequest$qos": "

The Quality of Service (QoS) level.

" + } + }, + "RequestEntityTooLargeException": { + "base": "

The payload exceeds the maximum size allowed.

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

The specified resource does not exist.

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

The service is temporarily unavailable.

", + "refs": { + } + }, + "ThingName": { + "base": null, + "refs": { + "DeleteThingShadowRequest$thingName": "

The name of the thing.

", + "GetThingShadowRequest$thingName": "

The name of the thing.

", + "UpdateThingShadowRequest$thingName": "

The name of the thing.

" + } + }, + "ThrottlingException": { + "base": "

The rate exceeds the limit.

", + "refs": { + } + }, + "Topic": { + "base": null, + "refs": { + "PublishRequest$topic": "

The name of the MQTT topic.

" + } + }, + "UnauthorizedException": { + "base": "

You are not authorized to perform this operation.

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

The document encoding is not supported.

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

The input for the UpdateThingShadow operation.

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

The output from the UpdateThingShadow operation.

", + "refs": { + } + }, + "errorMessage": { + "base": null, + "refs": { + "InternalFailureException$message": "

The message for the exception.

", + "InvalidRequestException$message": "

The message for the exception.

", + "ResourceNotFoundException$message": "

The message for the exception.

", + "ServiceUnavailableException$message": "

The message for the exception.

", + "ThrottlingException$message": "

The message for the exception.

", + "UnauthorizedException$message": "

The message for the exception.

", + "UnsupportedDocumentEncodingException$message": "

The message for the exception.

" + } + } + } +} diff --git a/src/data/data.iot/2015-05-28/docs-2.json.php b/src/data/data.iot/2015-05-28/docs-2.json.php new file mode 100644 index 0000000000..ff1e7cfe2e --- /dev/null +++ b/src/data/data.iot/2015-05-28/docs-2.json.php @@ -0,0 +1,3 @@ + '2.0', 'operations' => [ 'DeleteThingShadow' => '

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

', 'GetThingShadow' => '

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

', 'Publish' => '

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

', 'UpdateThingShadow' => '

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

', ], 'service' => 'AWS IoT (Beta]

AWS IoT is considered a beta service as defined in the Service Terms

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances] and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish] and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.

', 'shapes' => [ 'ConflictException' => [ 'base' => '

The specified version does not match the version of the document.

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

The input for the DeleteThingShadow operation.

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

The output from the DeleteThingShadow operation.

', 'refs' => [], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ConflictException$message' => '

The message for the exception.

', 'MethodNotAllowedException$message' => '

The message for the exception.

', 'RequestEntityTooLargeException$message' => '

The message for the exception.

', ], ], 'GetThingShadowRequest' => [ 'base' => '

The input for the GetThingShadow operation.

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

The output from the GetThingShadow operation.

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

An unexpected error has occurred.

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

The request is not valid.

', 'refs' => [], ], 'JsonDocument' => [ 'base' => NULL, 'refs' => [ 'DeleteThingShadowResponse$payload' => '

The state information, in JSON format.

', 'GetThingShadowResponse$payload' => '

The state information, in JSON format.

', 'UpdateThingShadowRequest$payload' => '

The state information, in JSON format.

', 'UpdateThingShadowResponse$payload' => '

The state information, in JSON format.

', ], ], 'MethodNotAllowedException' => [ 'base' => '

The specified combination of HTTP verb and URI is not supported.

', 'refs' => [], ], 'Payload' => [ 'base' => NULL, 'refs' => [ 'PublishRequest$payload' => '

The state information, in JSON format.

', ], ], 'PublishRequest' => [ 'base' => '

The input for the Publish operation.

', 'refs' => [], ], 'Qos' => [ 'base' => NULL, 'refs' => [ 'PublishRequest$qos' => '

The Quality of Service (QoS] level.

', ], ], 'RequestEntityTooLargeException' => [ 'base' => '

The payload exceeds the maximum size allowed.

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

The specified resource does not exist.

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

The service is temporarily unavailable.

', 'refs' => [], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'DeleteThingShadowRequest$thingName' => '

The name of the thing.

', 'GetThingShadowRequest$thingName' => '

The name of the thing.

', 'UpdateThingShadowRequest$thingName' => '

The name of the thing.

', ], ], 'ThrottlingException' => [ 'base' => '

The rate exceeds the limit.

', 'refs' => [], ], 'Topic' => [ 'base' => NULL, 'refs' => [ 'PublishRequest$topic' => '

The name of the MQTT topic.

', ], ], 'UnauthorizedException' => [ 'base' => '

You are not authorized to perform this operation.

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

The document encoding is not supported.

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

The input for the UpdateThingShadow operation.

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

The output from the UpdateThingShadow operation.

', 'refs' => [], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'InternalFailureException$message' => '

The message for the exception.

', 'InvalidRequestException$message' => '

The message for the exception.

', 'ResourceNotFoundException$message' => '

The message for the exception.

', 'ServiceUnavailableException$message' => '

The message for the exception.

', 'ThrottlingException$message' => '

The message for the exception.

', 'UnauthorizedException$message' => '

The message for the exception.

', 'UnsupportedDocumentEncodingException$message' => '

The message for the exception.

', ], ], ],]; diff --git a/src/data/ecs/2014-11-13/api-2.json b/src/data/ecs/2014-11-13/api-2.json index 3cefdcc025..272ae7cd31 100644 --- a/src/data/ecs/2014-11-13/api-2.json +++ b/src/data/ecs/2014-11-13/api-2.json @@ -488,6 +488,10 @@ { "shape":"ClusterNotFoundException", "exception":true + }, + { + "shape":"ServiceNotFoundException", + "exception":true } ] }, @@ -748,6 +752,18 @@ "FAILED" ] }, + "Attribute":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"String"}, + "value":{"shape":"String"} + } + }, + "Attributes":{ + "type":"list", + "member":{"shape":"Attribute"} + }, "Boolean":{"type":"boolean"}, "BoxedBoolean":{ "type":"boolean", @@ -824,7 +840,20 @@ "command":{"shape":"StringList"}, "environment":{"shape":"EnvironmentVariables"}, "mountPoints":{"shape":"MountPointList"}, - "volumesFrom":{"shape":"VolumeFromList"} + "volumesFrom":{"shape":"VolumeFromList"}, + "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"}, + "dockerLabels":{"shape":"DockerLabelsMap"}, + "ulimits":{"shape":"UlimitList"}, + "logConfiguration":{"shape":"LogConfiguration"} } }, "ContainerDefinitions":{ @@ -843,7 +872,8 @@ "agentConnected":{"shape":"Boolean"}, "runningTasksCount":{"shape":"Integer"}, "pendingTasksCount":{"shape":"Integer"}, - "agentUpdateStatus":{"shape":"AgentUpdateStatus"} + "agentUpdateStatus":{"shape":"AgentUpdateStatus"}, + "attributes":{"shape":"Attributes"} } }, "ContainerInstances":{ @@ -1066,6 +1096,14 @@ "telemetryEndpoint":{"shape":"String"} } }, + "DockerLabelsMap":{ + "type":"map", + "key":{ + "shape":"String", + "required":true + }, + "value":{"shape":"String"} + }, "Double":{"type":"double"}, "EnvironmentVariables":{ "type":"list", @@ -1082,6 +1120,21 @@ "type":"list", "member":{"shape":"Failure"} }, + "HostEntry":{ + "type":"structure", + "required":[ + "hostname", + "ipAddress" + ], + "members":{ + "hostname":{"shape":"String"}, + "ipAddress":{"shape":"String"} + } + }, + "HostEntryList":{ + "type":"list", + "member":{"shape":"HostEntry"} + }, "HostVolumeProperties":{ "type":"structure", "members":{ @@ -1210,6 +1263,32 @@ "type":"list", "member":{"shape":"LoadBalancer"} }, + "LogConfiguration":{ + "type":"structure", + "required":["logDriver"], + "members":{ + "logDriver":{"shape":"LogDriver"}, + "options":{"shape":"LogConfigurationOptionsMap"} + } + }, + "LogConfigurationOptionsMap":{ + "type":"map", + "key":{ + "shape":"String", + "required":true + }, + "value":{"shape":"String"} + }, + "LogDriver":{ + "type":"string", + "enum":[ + "json-file", + "syslog", + "journald", + "gelf", + "fluentd" + ] + }, "Long":{"type":"long"}, "MissingVersionException":{ "type":"structure", @@ -1268,7 +1347,8 @@ "instanceIdentityDocumentSignature":{"shape":"String"}, "totalResources":{"shape":"Resources"}, "versionInfo":{"shape":"VersionInfo"}, - "containerInstanceArn":{"shape":"String"} + "containerInstanceArn":{"shape":"String"}, + "attributes":{"shape":"Attributes"} } }, "RegisterContainerInstanceResponse":{ @@ -1295,6 +1375,10 @@ "taskDefinition":{"shape":"TaskDefinition"} } }, + "RequiresAttributes":{ + "type":"list", + "member":{"shape":"Attribute"} + }, "Resource":{ "type":"structure", "members":{ @@ -1483,7 +1567,8 @@ "family":{"shape":"String"}, "revision":{"shape":"Integer"}, "volumes":{"shape":"VolumeList"}, - "status":{"shape":"TaskDefinitionStatus"} + "status":{"shape":"TaskDefinitionStatus"}, + "requiresAttributes":{"shape":"RequiresAttributes"} } }, "TaskDefinitionStatus":{ @@ -1511,6 +1596,43 @@ "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" + ] + }, "UpdateContainerAgentRequest":{ "type":"structure", "required":["containerInstance"], 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 c833335705..9e218d8947 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', 'serviceAbbreviation' => 'Amazon ECS', 'serviceFullName' => 'Amazon EC2 Container Service', 'signatureVersion' => 'v4', 'targetPrefix' => 'AmazonEC2ContainerServiceV20141113', 'protocol' => 'json', ], 'operations' => [ 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'CreateService' => [ 'name' => 'CreateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceRequest', ], 'output' => [ 'shape' => 'CreateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'ClusterContainsContainerInstancesException', 'exception' => true, ], [ 'shape' => 'ClusterContainsServicesException', 'exception' => true, ], ], ], 'DeleteService' => [ 'name' => 'DeleteService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceRequest', ], 'output' => [ 'shape' => 'DeleteServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'ServiceNotFoundException', 'exception' => true, ], ], ], 'DeregisterContainerInstance' => [ 'name' => 'DeregisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'DeregisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DeregisterTaskDefinition' => [ 'name' => 'DeregisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DeregisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'DescribeContainerInstances' => [ 'name' => 'DescribeContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContainerInstancesRequest', ], 'output' => [ 'shape' => 'DescribeContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DescribeServices' => [ 'name' => 'DescribeServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServicesRequest', ], 'output' => [ 'shape' => 'DescribeServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DescribeTaskDefinition' => [ 'name' => 'DescribeTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'DescribeTasks' => [ 'name' => 'DescribeTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTasksRequest', ], 'output' => [ 'shape' => 'DescribeTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DiscoverPollEndpoint' => [ 'name' => 'DiscoverPollEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverPollEndpointRequest', ], 'output' => [ 'shape' => 'DiscoverPollEndpointResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'ListContainerInstances' => [ 'name' => 'ListContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContainerInstancesRequest', ], 'output' => [ 'shape' => 'ListContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'ListServices' => [ 'name' => 'ListServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesRequest', ], 'output' => [ 'shape' => 'ListServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'ListTaskDefinitionFamilies' => [ 'name' => 'ListTaskDefinitionFamilies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionFamiliesRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionFamiliesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'ListTaskDefinitions' => [ 'name' => 'ListTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'ListTasks' => [ 'name' => 'ListTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTasksRequest', ], 'output' => [ 'shape' => 'ListTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'RegisterContainerInstance' => [ 'name' => 'RegisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'RegisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'RegisterTaskDefinition' => [ 'name' => 'RegisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'RegisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'RunTask' => [ 'name' => 'RunTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunTaskRequest', ], 'output' => [ 'shape' => 'RunTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'StartTask' => [ 'name' => 'StartTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartTaskRequest', ], 'output' => [ 'shape' => 'StartTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'StopTask' => [ 'name' => 'StopTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTaskRequest', ], 'output' => [ 'shape' => 'StopTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'SubmitContainerStateChange' => [ 'name' => 'SubmitContainerStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitContainerStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitContainerStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'SubmitTaskStateChange' => [ 'name' => 'SubmitTaskStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitTaskStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitTaskStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'UpdateContainerAgent' => [ 'name' => 'UpdateContainerAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerAgentRequest', ], 'output' => [ 'shape' => 'UpdateContainerAgentResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'UpdateInProgressException', 'exception' => true, ], [ 'shape' => 'NoUpdateAvailableException', 'exception' => true, ], [ 'shape' => 'MissingVersionException', 'exception' => true, ], ], ], 'UpdateService' => [ 'name' => 'UpdateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceRequest', ], 'output' => [ 'shape' => 'UpdateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'ServiceNotFoundException', 'exception' => true, ], [ 'shape' => 'ServiceNotActiveException', 'exception' => true, ], ], ], ], 'shapes' => [ 'AgentUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STAGING', 'STAGED', 'UPDATING', 'UPDATED', 'FAILED', ], ], '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', ], ], ], 'ClusterContainsContainerInstancesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsServicesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], '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', ], ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'cpu' => [ 'shape' => 'Integer', ], 'memory' => [ 'shape' => 'Integer', ], 'links' => [ 'shape' => 'StringList', ], 'portMappings' => [ 'shape' => 'PortMappingList', ], 'essential' => [ 'shape' => 'BoxedBoolean', ], 'entryPoint' => [ 'shape' => 'StringList', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'mountPoints' => [ 'shape' => 'MountPointList', ], 'volumesFrom' => [ 'shape' => 'VolumeFromList', ], ], ], 'ContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], ], 'ContainerInstance' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArn' => [ 'shape' => 'String', ], 'ec2InstanceId' => [ 'shape' => 'String', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'remainingResources' => [ 'shape' => 'Resources', ], 'registeredResources' => [ 'shape' => 'Resources', ], 'status' => [ 'shape' => 'String', ], 'agentConnected' => [ 'shape' => 'Boolean', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'agentUpdateStatus' => [ 'shape' => 'AgentUpdateStatus', ], ], ], 'ContainerInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstance', ], ], 'ContainerOverride' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], ], ], 'ContainerOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerOverride', ], ], 'Containers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Container', ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'members' => [ 'clusterName' => [ 'shape' => 'String', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'taskDefinition', 'desiredCount', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'clientToken' => [ 'shape' => 'String', ], 'role' => [ 'shape' => 'String', ], ], ], 'CreateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'Clusters', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeContainerInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], ], ], 'DescribeContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeServicesRequest' => [ 'type' => 'structure', 'required' => [ 'services', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'StringList', ], ], ], 'DescribeServicesResponse' => [ 'type' => 'structure', 'members' => [ 'services' => [ 'shape' => 'Services', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'DescribeTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], 'DescribeTasksRequest' => [ 'type' => 'structure', 'required' => [ 'tasks', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], ], ], 'DescribeTasksResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DesiredStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'PENDING', 'STOPPED', ], ], 'DiscoverPollEndpointRequest' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'String', ], 'cluster' => [ 'shape' => 'String', ], ], ], 'DiscoverPollEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'endpoint' => [ 'shape' => 'String', ], 'telemetryEndpoint' => [ 'shape' => 'String', ], ], ], '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', ], ], 'HostVolumeProperties' => [ 'type' => 'structure', 'members' => [ 'sourcePath' => [ 'shape' => 'String', ], ], ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'KeyValuePair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ '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', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListServicesResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTaskDefinitionFamiliesRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], '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', ], ], ], 'ListTasksResponse' => [ 'type' => 'structure', 'members' => [ 'taskArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'loadBalancerName' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'LoadBalancers' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], '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', ], ], 'NoUpdateAvailableException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PortMapping' => [ 'type' => 'structure', 'members' => [ 'containerPort' => [ 'shape' => 'Integer', ], 'hostPort' => [ 'shape' => 'Integer', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], ], ], 'PortMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortMapping', ], ], 'RegisterContainerInstanceRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'instanceIdentityDocument' => [ 'shape' => 'String', ], 'instanceIdentityDocumentSignature' => [ 'shape' => 'String', ], 'totalResources' => [ 'shape' => 'Resources', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'containerInstanceArn' => [ 'shape' => 'String', ], ], ], 'RegisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'RegisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'family', 'containerDefinitions', ], 'members' => [ 'family' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'volumes' => [ 'shape' => 'VolumeList', ], ], ], 'RegisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'doubleValue' => [ 'shape' => 'Double', ], 'longValue' => [ 'shape' => 'Long', ], 'integerValue' => [ 'shape' => 'Integer', ], 'stringSetValue' => [ 'shape' => 'StringList', ], ], ], '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', ], ], ], 'RunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], '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', ], 'status' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deployments' => [ 'shape' => 'Deployments', ], 'roleArn' => [ 'shape' => 'String', ], 'events' => [ 'shape' => 'ServiceEvents', ], ], ], 'ServiceEvent' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'message' => [ 'shape' => 'String', ], ], ], 'ServiceEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceEvent', ], ], 'ServiceNotActiveException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Services' => [ 'type' => 'list', 'member' => [ 'shape' => 'Service', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'StartTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'startedBy' => [ 'shape' => 'String', ], ], ], 'StartTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'StopTaskRequest' => [ 'type' => 'structure', 'required' => [ 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], ], ], 'StopTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'Task', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ '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', ], ], ], 'SubmitTaskStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], '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', ], 'containers' => [ 'shape' => 'Containers', ], 'startedBy' => [ 'shape' => 'String', ], ], ], 'TaskDefinition' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'family' => [ 'shape' => 'String', ], 'revision' => [ 'shape' => 'Integer', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], ], ], 'TaskDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'TaskOverride' => [ 'type' => 'structure', 'members' => [ 'containerOverrides' => [ 'shape' => 'ContainerOverrides', ], ], ], 'Tasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'Task', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TransportProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'udp', ], ], 'UpdateContainerAgentRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], ], ], 'UpdateContainerAgentResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'UpdateInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UpdateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'taskDefinition' => [ 'shape' => 'String', ], ], ], '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', ], ], ], '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', 'serviceAbbreviation' => 'Amazon ECS', 'serviceFullName' => 'Amazon EC2 Container Service', 'signatureVersion' => 'v4', 'targetPrefix' => 'AmazonEC2ContainerServiceV20141113', 'protocol' => 'json', ], 'operations' => [ 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'CreateService' => [ 'name' => 'CreateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceRequest', ], 'output' => [ 'shape' => 'CreateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'ClusterContainsContainerInstancesException', 'exception' => true, ], [ 'shape' => 'ClusterContainsServicesException', 'exception' => true, ], ], ], 'DeleteService' => [ 'name' => 'DeleteService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceRequest', ], 'output' => [ 'shape' => 'DeleteServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'ServiceNotFoundException', 'exception' => true, ], ], ], 'DeregisterContainerInstance' => [ 'name' => 'DeregisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'DeregisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DeregisterTaskDefinition' => [ 'name' => 'DeregisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DeregisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'DescribeContainerInstances' => [ 'name' => 'DescribeContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContainerInstancesRequest', ], 'output' => [ 'shape' => 'DescribeContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DescribeServices' => [ 'name' => 'DescribeServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServicesRequest', ], 'output' => [ 'shape' => 'DescribeServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DescribeTaskDefinition' => [ 'name' => 'DescribeTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'DescribeTasks' => [ 'name' => 'DescribeTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTasksRequest', ], 'output' => [ 'shape' => 'DescribeTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'DiscoverPollEndpoint' => [ 'name' => 'DiscoverPollEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverPollEndpointRequest', ], 'output' => [ 'shape' => 'DiscoverPollEndpointResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'ListContainerInstances' => [ 'name' => 'ListContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContainerInstancesRequest', ], 'output' => [ 'shape' => 'ListContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'ListServices' => [ 'name' => 'ListServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesRequest', ], 'output' => [ 'shape' => 'ListServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'ListTaskDefinitionFamilies' => [ 'name' => 'ListTaskDefinitionFamilies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionFamiliesRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionFamiliesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'ListTaskDefinitions' => [ 'name' => 'ListTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'ListTasks' => [ 'name' => 'ListTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTasksRequest', ], 'output' => [ 'shape' => 'ListTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'ServiceNotFoundException', 'exception' => true, ], ], ], 'RegisterContainerInstance' => [ 'name' => 'RegisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'RegisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'RegisterTaskDefinition' => [ 'name' => 'RegisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'RegisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], ], ], 'RunTask' => [ 'name' => 'RunTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunTaskRequest', ], 'output' => [ 'shape' => 'RunTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'StartTask' => [ 'name' => 'StartTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartTaskRequest', ], 'output' => [ 'shape' => 'StartTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'StopTask' => [ 'name' => 'StopTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTaskRequest', ], 'output' => [ 'shape' => 'StopTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], ], ], 'SubmitContainerStateChange' => [ 'name' => 'SubmitContainerStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitContainerStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitContainerStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'SubmitTaskStateChange' => [ 'name' => 'SubmitTaskStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitTaskStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitTaskStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], ], ], 'UpdateContainerAgent' => [ 'name' => 'UpdateContainerAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerAgentRequest', ], 'output' => [ 'shape' => 'UpdateContainerAgentResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'UpdateInProgressException', 'exception' => true, ], [ 'shape' => 'NoUpdateAvailableException', 'exception' => true, ], [ 'shape' => 'MissingVersionException', 'exception' => true, ], ], ], 'UpdateService' => [ 'name' => 'UpdateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceRequest', ], 'output' => [ 'shape' => 'UpdateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', 'exception' => true, 'fault' => true, ], [ 'shape' => 'ClientException', 'exception' => true, ], [ 'shape' => 'InvalidParameterException', 'exception' => true, ], [ 'shape' => 'ClusterNotFoundException', 'exception' => true, ], [ 'shape' => 'ServiceNotFoundException', 'exception' => true, ], [ 'shape' => 'ServiceNotActiveException', 'exception' => true, ], ], ], ], 'shapes' => [ 'AgentUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STAGING', 'STAGED', 'UPDATING', 'UPDATED', 'FAILED', ], ], 'Attribute' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'Attributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], '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', ], ], ], 'ClusterContainsContainerInstancesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsServicesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], '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', ], ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'cpu' => [ 'shape' => 'Integer', ], 'memory' => [ 'shape' => 'Integer', ], 'links' => [ 'shape' => 'StringList', ], 'portMappings' => [ 'shape' => 'PortMappingList', ], 'essential' => [ 'shape' => 'BoxedBoolean', ], 'entryPoint' => [ 'shape' => 'StringList', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'mountPoints' => [ 'shape' => 'MountPointList', ], 'volumesFrom' => [ 'shape' => 'VolumeFromList', ], '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', ], 'dockerLabels' => [ 'shape' => 'DockerLabelsMap', ], 'ulimits' => [ 'shape' => 'UlimitList', ], 'logConfiguration' => [ 'shape' => 'LogConfiguration', ], ], ], 'ContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], ], 'ContainerInstance' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArn' => [ 'shape' => 'String', ], 'ec2InstanceId' => [ 'shape' => 'String', ], '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', ], ], ], 'ContainerInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstance', ], ], 'ContainerOverride' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], ], ], 'ContainerOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerOverride', ], ], 'Containers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Container', ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'members' => [ 'clusterName' => [ 'shape' => 'String', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'taskDefinition', 'desiredCount', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'clientToken' => [ 'shape' => 'String', ], 'role' => [ 'shape' => 'String', ], ], ], 'CreateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'Clusters', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeContainerInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], ], ], 'DescribeContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeServicesRequest' => [ 'type' => 'structure', 'required' => [ 'services', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'StringList', ], ], ], 'DescribeServicesResponse' => [ 'type' => 'structure', 'members' => [ 'services' => [ 'shape' => 'Services', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'DescribeTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], 'DescribeTasksRequest' => [ 'type' => 'structure', 'required' => [ 'tasks', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], ], ], 'DescribeTasksResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DesiredStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'PENDING', 'STOPPED', ], ], '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', 'required' => true, ], 'value' => [ 'shape' => 'String', ], ], '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', ], ], '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, ], 'KeyValuePair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ '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', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListServicesResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTaskDefinitionFamiliesRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], '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', ], ], ], 'ListTasksResponse' => [ 'type' => 'structure', 'members' => [ 'taskArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ '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', 'required' => true, ], 'value' => [ 'shape' => 'String', ], ], 'LogDriver' => [ 'type' => 'string', 'enum' => [ 'json-file', 'syslog', 'journald', 'gelf', 'fluentd', ], ], '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', ], ], 'NoUpdateAvailableException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PortMapping' => [ 'type' => 'structure', 'members' => [ 'containerPort' => [ 'shape' => 'Integer', ], 'hostPort' => [ 'shape' => 'Integer', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], ], ], 'PortMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortMapping', ], ], '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', ], ], ], 'RegisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'RegisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'family', 'containerDefinitions', ], 'members' => [ 'family' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'volumes' => [ 'shape' => 'VolumeList', ], ], ], 'RegisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], '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', ], ], ], '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', ], ], ], 'RunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], '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', ], 'status' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deployments' => [ 'shape' => 'Deployments', ], 'roleArn' => [ 'shape' => 'String', ], 'events' => [ 'shape' => 'ServiceEvents', ], ], ], 'ServiceEvent' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'message' => [ 'shape' => 'String', ], ], ], 'ServiceEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceEvent', ], ], 'ServiceNotActiveException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Services' => [ 'type' => 'list', 'member' => [ 'shape' => 'Service', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'StartTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'startedBy' => [ 'shape' => 'String', ], ], ], 'StartTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'StopTaskRequest' => [ 'type' => 'structure', 'required' => [ 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], ], ], 'StopTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'Task', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ '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', ], ], ], 'SubmitTaskStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], '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', ], 'containers' => [ 'shape' => 'Containers', ], 'startedBy' => [ 'shape' => 'String', ], ], ], 'TaskDefinition' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'family' => [ 'shape' => 'String', ], 'revision' => [ 'shape' => 'Integer', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'requiresAttributes' => [ 'shape' => 'RequiresAttributes', ], ], ], 'TaskDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'TaskOverride' => [ 'type' => 'structure', 'members' => [ 'containerOverrides' => [ 'shape' => 'ContainerOverrides', ], ], ], 'Tasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'Task', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], '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', ], ], 'UpdateContainerAgentRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], ], ], 'UpdateContainerAgentResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'UpdateInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UpdateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'taskDefinition' => [ 'shape' => 'String', ], ], ], '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', ], ], ], '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 e104467217..2f0a62fcc5 100644 --- a/src/data/ecs/2014-11-13/docs-2.json +++ b/src/data/ecs/2014-11-13/docs-2.json @@ -1,16 +1,16 @@ { "version": "2.0", "operations": { - "CreateCluster": "

Creates a new Amazon ECS cluster. By default, your account will receive 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.

", - "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 will spawn another instantiation of the task in the specified cluster.

", + "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.

", + "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 instantiation of the task in the specified cluster.

", "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.

", - "DeregisterContainerInstance": "

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be 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 to avoid 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.

When you terminate a container instance, it is automatically deregistered from your cluster.

", + "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 to avoid 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.

When you terminate a container instance, it is automatically deregistered from your cluster.

", "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 (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).

", "DescribeClusters": "

Describes one or more of your clusters.

", "DescribeContainerInstances": "

Describes Amazon EC2 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 on 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.

", + "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 EC2 Container Service agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.

", "ListClusters": "

Returns a list of existing clusters.

", @@ -19,17 +19,17 @@ "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 definitions). You can 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.

", - "RegisterContainerInstance": "

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Registers an Amazon EC2 instance into the specified cluster. This instance will become 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 on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

", - "RunTask": "

Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.

The count parameter is limited to 10 tasks per call.

", - "StartTask": "

Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.

The list of container instances to start tasks on is limited to 10.

", - "StopTask": "

Stops a running task.

", + "RegisterContainerInstance": "

This action is only used by the Amazon EC2 Container Service 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 EC2 Container Service Developer Guide.

", + "RunTask": "

Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead.

The count parameter is limited to 10 tasks per call.

", + "StartTask": "

Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead.

The list of container instances to start tasks on is limited to 10.

", + "StopTask": "

Stops a running task.

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 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.

", "SubmitContainerStateChange": "

This action is only used by the Amazon EC2 Container Service 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 EC2 Container Service agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

", "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 EC2 Container Service Developer Guide.

", - "UpdateService": "

Modify the desired count or task definition used in a service.

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.

You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. 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. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

" + "UpdateService": "

Modify the desired count or task definition used in a service.

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.

You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. 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. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

When UpdateService replaces a task during an update, 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.

" }, - "service": "

Amazon EC2 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 of Amazon EC2 instances. Amazon ECS lets you launch and stop container-enabled 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 like security groups, Amazon EBS volumes, and IAM roles.

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 EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

", + "service": "

Amazon EC2 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 of EC2 instances. Amazon ECS lets you launch and stop container-enabled 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 like security groups, Amazon EBS volumes, and IAM roles.

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 EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

", "shapes": { "AgentUpdateStatus": { "base": null, @@ -37,17 +37,34 @@ "ContainerInstance$agentUpdateStatus": "

The status of the most recent agent update. If an update has never been requested, this value is NULL.

" } }, + "Attribute": { + "base": "

The attributes applicable to a container instance when it is registered.

", + "refs": { + "Attributes$member": null, + "RequiresAttributes$member": null + } + }, + "Attributes": { + "base": null, + "refs": { + "ContainerInstance$attributes": "

The attributes set for the container instance by the Amazon ECS container agent at instance registration.

", + "RegisterContainerInstanceRequest$attributes": "

The container instance attributes that this container instance supports.

" + } + }, "Boolean": { "base": null, "refs": { - "ContainerInstance$agentConnected": "

This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false, and instances without a connected agent cannot accept placement request.

" + "ContainerInstance$agentConnected": "

This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot accept placement requests.

" } }, "BoxedBoolean": { "base": null, "refs": { - "ContainerDefinition$essential": "

If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will 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.

", - "DeregisterContainerInstanceRequest$force": "

Force 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 and they will continue to pass Elastic Load Balancing load balancer health checks 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 will start another copy of that task on a different container instance if possible.

", + "ContainerDefinition$essential": "

If the essential parameter of a container is marked as true, the failure of that container stops the task. 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.

", + "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.

", + "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.

", + "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.

", + "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 and they continue to pass Elastic Load Balancing load balancer health checks 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.

", "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.

" } @@ -56,7 +73,7 @@ "base": null, "refs": { "Container$exitCode": "

The exit code returned from the container.

", - "CreateServiceRequest$desiredCount": "

The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

", + "CreateServiceRequest$desiredCount": "

The number of instantiations of the specified task definition to place and keep running on your cluster.

", "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 container instance 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 100 results and a nextToken value if applicable.

", @@ -66,13 +83,13 @@ "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 be used with the network binding.

", "NetworkBinding$hostPort": "

The port number on the host that is used with the network binding.

", - "RunTaskRequest$count": "

The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

", + "RunTaskRequest$count": "

The number of instantiations of the specified task to place on your cluster.

The count parameter is limited to 10 tasks per call.

", "SubmitContainerStateChangeRequest$exitCode": "

The exit code returned for the state change request.

", - "UpdateServiceRequest$desiredCount": "

The number of instantiations of the task that you would like to place and keep running in your service.

" + "UpdateServiceRequest$desiredCount": "

The number of instantiations of the task to place and keep running in your service.

" } }, "ClientException": { - "base": "

These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.

", + "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 permission to use the action or resource, or specifying an identifier that is not valid.

", "refs": { } }, @@ -106,7 +123,7 @@ } }, "Container": { - "base": "

A docker container that is part of a task.

", + "base": "

A Docker container that is part of a task.

", "refs": { "Containers$member": null } @@ -121,11 +138,11 @@ "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 on container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

" + "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 EC2 Container Service Developer Guide.

" } }, "ContainerInstance": { - "base": "

An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

", + "base": "

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

", "refs": { "ContainerInstances$member": null, "DeregisterContainerInstanceResponse$containerInstance": null, @@ -282,7 +299,7 @@ "DesiredStatus": { "base": null, "refs": { - "ListTasksRequest$desiredStatus": "

The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

" + "ListTasksRequest$desiredStatus": "

The task status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

" } }, "DiscoverPollEndpointRequest": { @@ -295,6 +312,12 @@ "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 into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" + } + }, "Double": { "base": null, "refs": { @@ -304,7 +327,7 @@ "EnvironmentVariables": { "base": null, "refs": { - "ContainerDefinition$environment": "

The environment variables to pass to a container.

", + "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.

", "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.

" } }, @@ -317,12 +340,24 @@ "Failures": { "base": null, "refs": { - "DescribeClustersResponse$failures": null, - "DescribeContainerInstancesResponse$failures": null, + "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": null, - "RunTaskResponse$failures": "

Any failed tasks from your RunTask action are listed here.

", - "StartTaskResponse$failures": "

Any failed tasks from your StartTask action are listed here.

" + "DescribeTasksResponse$failures": "

Any failures associated with the call.

", + "RunTaskResponse$failures": "

Any failures associated with the call.

", + "StartTaskResponse$failures": "

Any failures associated with the call.

" + } + }, + "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.

" } }, "HostVolumeProperties": { @@ -338,20 +373,22 @@ "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. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the 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.

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 will allow 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:

", - "ContainerDefinition$memory": "

The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.

", + "ContainerDefinition$cpu": "

The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

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.

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:

", + "ContainerDefinition$memory": "

The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated 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.

", "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 and/or maintain.

", + "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.

", - "PortMapping$containerPort": "

The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container will automatically receive a host port in the ephemeral port range (for more information, see hostPort).

", - "PortMapping$hostPort": "

The port number on the container instance to reserve for your container. 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 will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

", + "PortMapping$containerPort": "

The port number on the container that is bound to the user-specified or automatically assigned host port. If 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).

", + "PortMapping$hostPort": "

The port number on the container instance to reserve for your container. 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 is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. 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, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

", "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. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1, and each time 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).

" + "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 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).

", + "Ulimit$softLimit": "

The soft limit for the ulimit type.

", + "Ulimit$hardLimit": "

The hard limit for the ulimit type.

" } }, "InvalidParameterException": { @@ -438,6 +475,24 @@ "Service$loadBalancers": "

A list of 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.

" } }, + "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. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. Valid log drivers are displayed in the LogConfiguration 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 into your container instance and run the following command: sudo docker version | grep \"Server API version\"

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 EC2 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 into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" + } + }, + "LogDriver": { + "base": null, + "refs": { + "LogConfiguration$logDriver": "

The log driver to use for the container. 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 into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" + } + }, "Long": { "base": null, "refs": { @@ -458,11 +513,11 @@ "MountPointList": { "base": null, "refs": { - "ContainerDefinition$mountPoints": "

The mount points for data volumes in your container.

" + "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.

" } }, "NetworkBinding": { - "base": "

Details on the network bindings between a container and its host container instance.

", + "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 } @@ -480,7 +535,7 @@ } }, "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.

", + "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. 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 } @@ -488,7 +543,7 @@ "PortMappingList": { "base": null, "refs": { - "ContainerDefinition$portMappings": "

The list of port mappings for the container.

" + "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. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run.

" } }, "RegisterContainerInstanceRequest": { @@ -511,6 +566,12 @@ "refs": { } }, + "RequiresAttributes": { + "base": null, + "refs": { + "TaskDefinition$requiresAttributes": "

The container instance attributes required by your task.

" + } + }, "Resource": { "base": "

Describes the resources available for a container instance.

", "refs": { @@ -536,7 +597,7 @@ } }, "ServerException": { - "base": "

These errors are usually caused by a server-side issue.

", + "base": "

These errors are usually caused by a server issue.

", "refs": { } }, @@ -544,7 +605,7 @@ "base": "

Details on a service within a cluster

", "refs": { "CreateServiceResponse$service": "

The full description of your service following the create call.

", - "DeleteServiceResponse$service": null, + "DeleteServiceResponse$service": "

The full description of the deleted service.

", "Services$member": null, "UpdateServiceResponse$service": "

The full description of your service following the update call.

" } @@ -562,7 +623,7 @@ } }, "ServiceNotActiveException": { - "base": "

The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can recreate it with CreateService.

", + "base": "

The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with CreateService.

", "refs": { } }, @@ -606,84 +667,95 @@ "String": { "base": null, "refs": { + "Attribute$name": "

The name of the container instance attribute.

", + "Attribute$value": "

The value of the container instance attribute.

", "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 can use to identify your cluster.

", + "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 Amazon Resource Name (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 detail about a running or stopped 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.

", - "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 repository-url/image:tag.

", - "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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

", - "ContainerInstance$ec2InstanceId": "

The Amazon EC2 instance ID of the container instance.

", + "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 repository-url/image:tag. 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.

", + "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.

", + "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 or INACTIVE. ACTIVE indicates that the container instance can accept tasks.

", "ContainerOverride$name": "

The name of the container that receives the override.

", - "CreateClusterRequest$clusterName": "

The name of your cluster. If you do not specify a name for your cluster, you will 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 that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.

", + "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 Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

", + "CreateServiceRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (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 you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

", "CreateServiceRequest$role": "

The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

", - "DeleteClusterRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that you want to delete.

", - "DeleteServiceRequest$cluster": "

The name of the cluster that hosts the service you want to delete.

", - "DeleteServiceRequest$service": "

The name of the service you want to delete.

", + "DeleteClusterRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

", + "DeleteServiceRequest$cluster": "

The name 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. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).

", "Deployment$taskDefinition": "

The most recent task definition that was specified for the service to use.

", - "DeregisterContainerInstanceRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

", - "DeregisterContainerInstanceRequest$containerInstance": "

The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

", - "DeregisterTaskDefinitionRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want 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 you want to describe. If you do not specify a cluster, the default cluster is assumed.

", - "DescribeServicesRequest$cluster": "

The name of the cluster that hosts the service you want to describe.

", - "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 that you want to describe.

", - "DescribeTasksRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.

", - "DiscoverPollEndpointRequest$containerInstance": "

The container instance UUID or full 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

", + "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 Amazon Resource Name (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 name of 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.

", + "DiscoverPollEndpointRequest$containerInstance": "

The container instance ID or full 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.

", "DiscoverPollEndpointRequest$cluster": "

The cluster that the container instance belongs to.

", "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, "Failure$arn": "

The Amazon Resource Name (ARN) of the failed resource.

", "Failure$reason": "

The reason for the failure.

", + "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": "

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.

", "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.

", "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 value is null when there are no more results to return.

", "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 you want to list. If you do not specify a cluster, the default cluster is assumed..

", + "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$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 value is null when there are no more results to return.

", "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 you want to list. If you do not specify a cluster, the default cluster is assumed..

", + "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 value is null when there are no more results to return.

", "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.

", "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 value is null when there are no more results to return.

", "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 that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit the listed task definitions to task definition revisions that belong to that family.

", + "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 value is null when there are no more results to return.

", "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 you want to list. If you do not specify a cluster, the default cluster is assumed..

", - "ListTasksRequest$containerInstance": "

The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

", - "ListTasksRequest$family": "

The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

", + "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 Amazon Resource Name (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 value is null when there are no more results to return.

", - "ListTasksRequest$startedBy": "

The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

", - "ListTasksRequest$serviceName": "

The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.

", + "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$loadBalancerName": "

The name of the load balancer.

", "LoadBalancer$containerName": "

The name of the container to associate with the load balancer.

", + "LogConfigurationOptionsMap$key": null, + "LogConfigurationOptionsMap$value": null, "MountPoint$sourceVolume": "

The name of the volume to mount.

", "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.

", - "RegisterContainerInstanceRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..

", - "RegisterContainerInstanceRequest$instanceIdentityDocument": "

The instance identity document for the Amazon 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 Amazon 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$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 Amazon Resource Name (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. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", + "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.

", "Resource$name": "

The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.

", "Resource$type": "

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

", - "RunTaskRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

", - "RunTaskRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

", + "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 Amazon Resource Name (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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

", "ServerException$message": null, "Service$serviceArn": "

The Amazon Resource Name (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.

", @@ -694,20 +766,20 @@ "Service$roleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

", "ServiceEvent$id": "

The ID string of the event.

", "ServiceEvent$message": "

The event message.

", - "StartTaskRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..

", - "StartTaskRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start. If a revision is not specified, the latest ACTIVE revision is used.

", + "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 Amazon Resource Name (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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

", - "StopTaskRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to stop. If you do not specify a cluster, the default cluster is assumed..

", - "StopTaskRequest$task": "

The task UUIDs or full Amazon Resource Name (ARN) entry of the task you would like to stop.

", + "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 Amazon Resource Name (ARN) entry of the task to stop.

", "StringList$member": null, "SubmitContainerStateChangeRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.

", - "SubmitContainerStateChangeRequest$task": "

The task UUID or full Amazon Resource Name (ARN) of the task 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 UUID or full Amazon Resource Name (ARN) of the task in the state change request.

", + "SubmitTaskStateChangeRequest$task": "

The task ID or full Amazon Resource Name (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.

", @@ -719,12 +791,12 @@ "Task$desiredStatus": "

The desired status of the task.

", "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.

", "TaskDefinition$taskDefinitionArn": "

The full Amazon Resource Name (ARN) of the of the task definition.

", - "TaskDefinition$family": "

The family of your task definition. You can think of the family as the name of your task definition.

", + "TaskDefinition$family": "

The family of your task definition, used as the definition name.

", "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 UUID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.

", + "UpdateContainerAgentRequest$containerInstance": "

The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.

", "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 that you want to update.

", - "UpdateServiceRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want 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$service": "

The name of the service to update.

", + "UpdateServiceRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (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.

", "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.

", @@ -735,22 +807,25 @@ "StringList": { "base": null, "refs": { - "ContainerDefinition$links": "

The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.

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 ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.

", - "ContainerDefinition$command": "

The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.

", + "ContainerDefinition$links": "

The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

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/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/reference/builder/#cmd.

", + "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.

", + "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.

", + "ContainerDefinition$dockerSecurityOptions": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. 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 EC2 Container Service Developer Guide.

", "ContainerOverride$command": "

The command to send to the container that overrides the default command from the Docker image or the task definition.

", "DescribeClustersRequest$clusters": "

A space-separated list of 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 space-separated list of container instance UUIDs or full Amazon Resource Name (ARN) entries.

", - "DescribeServicesRequest$services": "

A list of services you want to describe.

", - "DescribeTasksRequest$tasks": "

A space-separated list of task UUIDs or full Amazon Resource Name (ARN) entries.

", + "DescribeContainerInstancesRequest$containerInstances": "

A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.

", + "DescribeServicesRequest$services": "

A list of services to describe.

", + "DescribeTasksRequest$tasks": "

A space-separated list of task IDs or full Amazon Resource Name (ARN) entries.

", "ListClustersResponse$clusterArns": "

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

", - "ListContainerInstancesResponse$containerInstanceArns": "

The list of container instance full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.

", + "ListContainerInstancesResponse$containerInstanceArns": "

The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.

", "ListServicesResponse$serviceArns": "

The list of full Amazon Resource Name (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 ListTaskDefintions request.

", + "ListTaskDefinitionsResponse$taskDefinitionArns": "

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

", "ListTasksResponse$taskArns": "

The list of task Amazon Resource Name (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 UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

" + "StartTaskRequest$containerInstances": "

The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

" } }, "SubmitContainerStateChangeRequest": { @@ -785,13 +860,13 @@ "refs": { "DeregisterTaskDefinitionResponse$taskDefinition": "

The full description of the deregistered task.

", "DescribeTaskDefinitionResponse$taskDefinition": "

The full task definition description.

", - "RegisterTaskDefinitionResponse$taskDefinition": null + "RegisterTaskDefinitionResponse$taskDefinition": "

The full description of the registered task definition.

" } }, "TaskDefinitionStatus": { "base": null, "refs": { - "ListTaskDefinitionsRequest$status": "

The task definition status that you want to filter the ListTaskDefinitions results with. 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.

", + "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.

" } }, @@ -807,8 +882,8 @@ "base": null, "refs": { "DescribeTasksResponse$tasks": "

The list of tasks.

", - "RunTaskResponse$tasks": "

A full description of the tasks that were run. Each task that was successfully placed on your cluster will be described here.

", - "StartTaskResponse$tasks": "

A full description of the tasks that were started. Each task that was successfully placed on your container instances will be described here.

" + "RunTaskResponse$tasks": "

A full description of the tasks that were run. Each task that was 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 are described here.

" } }, "Timestamp": { @@ -826,6 +901,24 @@ "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 into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" + } + }, + "UlimitName": { + "base": null, + "refs": { + "Ulimit$name": "

The type of the ulimit.

" + } + }, "UpdateContainerAgentRequest": { "base": null, "refs": { @@ -837,7 +930,7 @@ } }, "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 will resume where it stopped previously.

", + "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": { } }, @@ -852,7 +945,7 @@ } }, "VersionInfo": { - "base": "

The Docker and Amazon ECS container agent version information on a container instance.

", + "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.

" @@ -873,14 +966,14 @@ "VolumeFromList": { "base": null, "refs": { - "ContainerDefinition$volumesFrom": "

Data volumes to mount from another container.

" + "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. For more information on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

" + "TaskDefinition$volumes": "

The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

" } } } 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 c745d22ebc..b5ca701ca1 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', 'operations' => [ 'CreateCluster' => '

Creates a new Amazon ECS cluster. By default, your account will receive 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.

', '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 will spawn another instantiation of the task in the specified cluster.

', '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.

', 'DeregisterContainerInstance' => '

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be 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 to avoid 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.

When you terminate a container instance, it is automatically deregistered from your cluster.

', '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 (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect].

', 'DescribeClusters' => '

Describes one or more of your clusters.

', 'DescribeContainerInstances' => '

Describes Amazon EC2 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 on 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 EC2 Container Service agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.

', 'ListClusters' => '

Returns a list of existing clusters.

', 'ListContainerInstances' => '

Returns a list of container instances in a specified cluster.

', 'ListServices' => '

Lists the services that are running in a specified cluster.

', '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 definitions]. You can 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.

', 'RegisterContainerInstance' => '

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Registers an Amazon EC2 instance into the specified cluster. This instance will become 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 on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

', 'RunTask' => '

Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.

The count parameter is limited to 10 tasks per call.

', 'StartTask' => '

Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.

The list of container instances to start tasks on is limited to 10.

', 'StopTask' => '

Stops a running task.

', 'SubmitContainerStateChange' => '

This action is only used by the Amazon EC2 Container Service 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 EC2 Container Service agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

', '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 EC2 Container Service Developer Guide.

', 'UpdateService' => '

Modify the desired count or task definition used in a service.

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.

You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. 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. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

', ], 'service' => '

Amazon EC2 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 of Amazon EC2 instances. Amazon ECS lets you launch and stop container-enabled 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 like security groups, Amazon EBS volumes, and IAM roles.

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 EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

', 'shapes' => [ '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.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => '

This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false, and instances without a connected agent cannot accept placement request.

', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$essential' => '

If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will 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.

', 'DeregisterContainerInstanceRequest$force' => '

Force 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 and they will continue to pass Elastic Load Balancing load balancer health checks 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 will start another copy of that task on a different container instance if possible.

', '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.

', 'CreateServiceRequest$desiredCount' => '

The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

', '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 container instance 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 100 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 be used with the network binding.

', 'NetworkBinding$hostPort' => '

The port number on the host that is used with the network binding.

', 'RunTaskRequest$count' => '

The number of instantiations of the specified task that you would like to place on your cluster.

The count parameter is limited to 10 tasks per call.

', 'SubmitContainerStateChangeRequest$exitCode' => '

The exit code returned for the state change request.

', 'UpdateServiceRequest$desiredCount' => '

The number of instantiations of the task that you would like to place and keep running in your service.

', ], ], 'ClientException' => [ 'base' => '

These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn\'t have permission to use the action or resource, or specify 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. You must 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. You must 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' => [], ], '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.

', ], ], '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 on container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

', ], ], 'ContainerInstance' => [ 'base' => '

An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => NULL, 'RegisterContainerInstanceResponse$containerInstance' => NULL, 'UpdateContainerAgentResponse$containerInstance' => NULL, ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$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.

', ], ], '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' => [], ], '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.

', 'refs' => [ 'Deployments$member' => NULL, ], ], '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 status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

', ], ], 'DiscoverPollEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscoverPollEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], '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.

', ], ], 'EnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$environment' => '

The environment variables to pass to a container.

', '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.

', ], ], 'Failure' => [ 'base' => '

A failed resource.

', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$failures' => NULL, 'DescribeContainerInstancesResponse$failures' => NULL, 'DescribeServicesResponse$failures' => '

Any failures associated with the call.

', 'DescribeTasksResponse$failures' => NULL, 'RunTaskResponse$failures' => '

Any failed tasks from your RunTask action are listed here.

', 'StartTaskResponse$failures' => '

Any failed tasks from your StartTask action are listed here.

', ], ], 'HostVolumeProperties' => [ 'base' => '

Details on a container instance host volume.

', 'refs' => [ 'Volume$host' => '

The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => '

The number of container instances registered into the cluster.

', '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. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the 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.

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 will allow 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:

', 'ContainerDefinition$memory' => '

The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.

', '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 and/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.

', 'PortMapping$containerPort' => '

The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container will automatically receive a host port in the ephemeral port range (for more information, see hostPort].

', 'PortMapping$hostPort' => '

The port number on the container instance to reserve for your container. 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 will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once a task stops, the host port is released].The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit].

', '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. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1, and each time 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].

', ], ], 'InvalidParameterException' => [ 'base' => '

The specified parameter is invalid. Review the available parameters for the API request.

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

A key and value pair object.

', 'refs' => [ 'EnvironmentVariables$member' => NULL, ], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ '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.

', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => '

A list of 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.

', 'Service$loadBalancers' => '

A list of 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.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'Resource$longValue' => '

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

', ], ], '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.

', ], ], 'NetworkBinding' => [ 'base' => '

Details on the network bindings between a container and its host container instance.

', 'refs' => [ 'NetworkBindings$member' => NULL, ], ], 'NetworkBindings' => [ 'base' => NULL, 'refs' => [ 'Container$networkBindings' => '

The network bindings associated with the container.

', 'SubmitContainerStateChangeRequest$networkBindings' => '

The network bindings of the container.

', ], ], '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' => [], ], '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.

', 'refs' => [ 'PortMappingList$member' => NULL, ], ], 'PortMappingList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$portMappings' => '

The list of port mappings for the container.

', ], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Resource' => [ 'base' => '

Describes the resources available for a container instance.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => '

The remaining resources of the container instance that are available for new tasks.

', 'ContainerInstance$registeredResources' => '

The registered resources on the container instance that are in use by current tasks.

', 'RegisterContainerInstanceRequest$totalResources' => '

The resources available on the instance.

', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerException' => [ 'base' => '

These errors are usually caused by a server-side issue.

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

Details on a service within a cluster

', 'refs' => [ 'CreateServiceResponse$service' => '

The full description of your service following the create call.

', 'DeleteServiceResponse$service' => NULL, '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.

', ], ], 'ServiceNotActiveException' => [ 'base' => '

The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can recreate 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' => [], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => '

The list of services described.

', ], ], '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.

', ], ], 'StartTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ '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 can 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 Amazon Resource Name (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 detail about a running or stopped 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.

', '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 repository-url/image:tag.

', '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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

', 'ContainerInstance$ec2InstanceId' => '

The Amazon EC2 instance ID of the container instance.

', 'ContainerInstance$status' => '

The status of the container instance. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that the container instance can accept tasks.

', 'ContainerOverride$name' => '

The name of the container that receives the override.

', 'CreateClusterRequest$clusterName' => '

The name of your cluster. If you do not specify a name for your cluster, you will 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 that you want to run your service on. 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 Amazon Resource Name (ARN] of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

', 'CreateServiceRequest$clientToken' => '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

', 'CreateServiceRequest$role' => '

The name or full Amazon Resource Name (ARN] of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

', 'DeleteClusterRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that you want to delete.

', 'DeleteServiceRequest$cluster' => '

The name of the cluster that hosts the service you want to delete.

', 'DeleteServiceRequest$service' => '

The name of the service you want to delete.

', 'Deployment$id' => '

The ID of the deployment.

', 'Deployment$status' => '

The status of the deployment. Valid values are PRIMARY (for the most recent deployment], ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment], and INACTIVE (for deployments that have been completely replaced].

', 'Deployment$taskDefinition' => '

The most recent task definition that was specified for the service to use.

', 'DeregisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

', 'DeregisterContainerInstanceRequest$containerInstance' => '

The container instance UUID or full Amazon Resource Name (ARN] of the container instance you want 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

', 'DeregisterTaskDefinitionRequest$taskDefinition' => '

The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition that you want 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 you want to describe. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeServicesRequest$cluster' => '

The name of the cluster that hosts the service you want to describe.

', '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 that you want to describe.

', 'DescribeTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.

', 'DiscoverPollEndpointRequest$containerInstance' => '

The container instance UUID or full 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

', 'DiscoverPollEndpointRequest$cluster' => '

The cluster that the container instance belongs to.

', 'DiscoverPollEndpointResponse$endpoint' => '

The endpoint for the Amazon ECS agent to poll.

', 'DiscoverPollEndpointResponse$telemetryEndpoint' => '

The telemetry endpoint for the Amazon ECS agent.

', 'Failure$arn' => '

The Amazon Resource Name (ARN] of the failed resource.

', 'Failure$reason' => '

The reason for the failure.

', 'HostVolumeProperties$sourcePath' => '

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.

', '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.

', '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 value is null when there are no more results to return.

', '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 you want to list. If you do not specify a cluster, the default cluster is assumed..

', '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 value is null when there are no more results to return.

', '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 you want 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 value is null when there are no more results to return.

', '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.

', '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 value is null when there are no more results to return.

', '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 that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit 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 value is null when there are no more results to return.

', '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 you want to list. If you do not specify a cluster, the default cluster is assumed..

', 'ListTasksRequest$containerInstance' => '

The container instance UUID or full Amazon Resource Name (ARN] of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

', 'ListTasksRequest$family' => '

The name of the family that you want to filter the ListTasks results with. Specifying a family will limit 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 value is null when there are no more results to return.

', 'ListTasksRequest$startedBy' => '

The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

', 'ListTasksRequest$serviceName' => '

The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit 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$loadBalancerName' => '

The name of the load balancer.

', 'LoadBalancer$containerName' => '

The name of the container to associate with the load balancer.

', 'MountPoint$sourceVolume' => '

The name of the volume to mount.

', '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.

', 'RegisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..

', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => '

The instance identity document for the Amazon 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 Amazon 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 Amazon Resource Name (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. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed.

', 'Resource$name' => '

The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.

', 'Resource$type' => '

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

', 'RunTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..

', 'RunTaskRequest$taskDefinition' => '

The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition that you want 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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'ServerException$message' => NULL, 'Service$serviceArn' => '

The Amazon Resource Name (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' => '

A user-generated string that you can use to identify your service.

', 'Service$clusterArn' => '

The Amazon Resource Name (ARN] of the of the cluster that hosts the service.

', 'Service$status' => '

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

', '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 Amazon Resource Name (ARN] of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

', 'ServiceEvent$id' => '

The ID string of the event.

', 'ServiceEvent$message' => '

The event message.

', 'StartTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..

', 'StartTaskRequest$taskDefinition' => '

The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition that you want 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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'StopTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that hosts the task you want to stop. If you do not specify a cluster, the default cluster is assumed..

', 'StopTaskRequest$task' => '

The task UUIDs or full Amazon Resource Name (ARN] entry of the task you would like to stop.

', 'StringList$member' => NULL, 'SubmitContainerStateChangeRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster that hosts the container.

', 'SubmitContainerStateChangeRequest$task' => '

The task UUID 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 UUID or full Amazon Resource Name (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.

', 'Task$taskArn' => '

The Amazon Resource Name (ARN] of the task.

', 'Task$clusterArn' => '

The Amazon Resource Name (ARN] of the of the cluster that hosts the task.

', 'Task$taskDefinitionArn' => '

The Amazon Resource Name (ARN] of the of the task definition that creates the task.

', 'Task$containerInstanceArn' => '

The Amazon Resource Name (ARN] of the container instances that host the task.

', 'Task$lastStatus' => '

The last known status of the task.

', 'Task$desiredStatus' => '

The desired status of the task.

', '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.

', 'TaskDefinition$taskDefinitionArn' => '

The full Amazon Resource Name (ARN] of the of the task definition.

', 'TaskDefinition$family' => '

The family of your task definition. You can think of the family as the name of your task definition.

', '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 UUID or full Amazon Resource Name (ARN] entries for the container instance on which you would like to update the Amazon ECS container agent.

', '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 that you want to update.

', 'UpdateServiceRequest$taskDefinition' => '

The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition that you want 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.

', '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. This name is referenced in the sourceVolume parameter of container definition mountPoints.

', 'VolumeFrom$sourceContainer' => '

The name of the container to mount volumes from.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$links' => '

The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.

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 ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.

', 'ContainerDefinition$command' => '

The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.

', 'ContainerOverride$command' => '

The command to send to the container that overrides the default command from the Docker image or the task definition.

', 'DescribeClustersRequest$clusters' => '

A space-separated list of 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 space-separated list of container instance UUIDs or full Amazon Resource Name (ARN] entries.

', 'DescribeServicesRequest$services' => '

A list of services you want to describe.

', 'DescribeTasksRequest$tasks' => '

A space-separated list of task UUIDs or full Amazon Resource Name (ARN] entries.

', 'ListClustersResponse$clusterArns' => '

The list of full Amazon Resource Name (ARN] entries for each cluster associated with your account.

', 'ListContainerInstancesResponse$containerInstanceArns' => '

The list of container instance full Amazon Resource Name (ARN] entries for each container instance associated with the specified cluster.

', 'ListServicesResponse$serviceArns' => '

The list of full Amazon Resource Name (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 ListTaskDefintions request.

', 'ListTasksResponse$taskArns' => '

The list of task Amazon Resource Name (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 UUIDs or full Amazon Resource Name (ARN] entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

', ], ], 'SubmitContainerStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'Task' => [ 'base' => '

Details on a task in a cluster.

', 'refs' => [ 'StopTaskResponse$task' => NULL, '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' => NULL, ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => '

The task definition status that you want to filter the ListTaskDefinitions results with. 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.

', ], ], '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.

', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => '

The list of tasks.

', 'RunTaskResponse$tasks' => '

A full description of the tasks that were run. Each task that was successfully placed on your cluster will be described here.

', 'StartTaskResponse$tasks' => '

A full description of the tasks that were started. Each task that was successfully placed on your container instances will be described here.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Deployment$createdAt' => '

The Unix time in seconds and milliseconds when the service was created.

', 'Deployment$updatedAt' => '

The Unix time in seconds and milliseconds when the service was last updated.

', 'ServiceEvent$createdAt' => '

The Unix time in seconds and milliseconds when the event was triggered.

', ], ], '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.

', ], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ '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 will resume where it stopped previously.

', 'refs' => [], ], 'UpdateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'VersionInfo' => [ 'base' => '

The Docker and Amazon ECS container agent version information on 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.

', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => '

Details on a data volume from another container.

', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => '

Data volumes to mount from another container.

', ], ], '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. For more information on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

', ], ], ],]; +return [ 'version' => '2.0', '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.

', '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 instantiation of the task in the specified cluster.

', '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.

', '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 to avoid 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.

When you terminate a container instance, it is automatically deregistered from your cluster.

', '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 (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect].

', 'DescribeClusters' => '

Describes one or more of your clusters.

', 'DescribeContainerInstances' => '

Describes Amazon EC2 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 EC2 Container Service agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.

', 'ListClusters' => '

Returns a list of existing clusters.

', 'ListContainerInstances' => '

Returns a list of container instances in a specified cluster.

', 'ListServices' => '

Lists the services that are running in a specified cluster.

', '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 definitions]. You can 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.

', 'RegisterContainerInstance' => '

This action is only used by the Amazon EC2 Container Service 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 EC2 Container Service Developer Guide.

', 'RunTask' => '

Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead.

The count parameter is limited to 10 tasks per call.

', 'StartTask' => '

Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead.

The list of container instances to start tasks on is limited to 10.

', 'StopTask' => '

Stops a running task.

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 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.

', 'SubmitContainerStateChange' => '

This action is only used by the Amazon EC2 Container Service 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 EC2 Container Service agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

', '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 EC2 Container Service Developer Guide.

', 'UpdateService' => '

Modify the desired count or task definition used in a service.

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.

You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. 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. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

When UpdateService replaces a task during an update, 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.

', ], 'service' => '

Amazon EC2 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 of EC2 instances. Amazon ECS lets you launch and stop container-enabled 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 like security groups, Amazon EBS volumes, and IAM roles.

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 EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

', 'shapes' => [ '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.

', ], ], 'Attribute' => [ 'base' => '

The attributes applicable to a container instance when it is registered.

', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => '

The attributes set for the container instance by the Amazon ECS container agent at instance registration.

', 'RegisterContainerInstanceRequest$attributes' => '

The container instance attributes that this container instance supports.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => '

This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot accept placement requests.

', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$essential' => '

If the essential parameter of a container is marked as true, the failure of that container stops the task. 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.

', '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.

', '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.

', '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.

', '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 and they continue to pass Elastic Load Balancing load balancer health checks 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.

', '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.

', 'CreateServiceRequest$desiredCount' => '

The number of instantiations of the specified task definition to place and keep running on your cluster.

', '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 container instance 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 100 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 be used with the network binding.

', 'NetworkBinding$hostPort' => '

The port number on the host that is used with the network binding.

', 'RunTaskRequest$count' => '

The number of instantiations of the specified task to place on your cluster.

The count parameter is limited to 10 tasks per call.

', '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.

', ], ], '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 permission 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. You must 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. You must 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' => [], ], '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.

', ], ], '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 EC2 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' => NULL, 'RegisterContainerInstanceResponse$containerInstance' => NULL, 'UpdateContainerAgentResponse$containerInstance' => NULL, ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$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.

', ], ], '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' => [], ], '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.

', 'refs' => [ 'Deployments$member' => NULL, ], ], '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 status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

', ], ], '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 into your container instance and run the following command: sudo docker version | grep "Server API version"

', ], ], '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.

', ], ], '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.

', '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.

', ], ], '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.

', ], ], '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.

', ], ], 'HostVolumeProperties' => [ 'base' => '

Details on a container instance host volume.

', 'refs' => [ 'Volume$host' => '

The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => '

The number of container instances registered into the cluster.

', '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. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

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.

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:

', 'ContainerDefinition$memory' => '

The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated 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.

', '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.

', 'PortMapping$containerPort' => '

The port number on the container that is bound to the user-specified or automatically assigned host port. If 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].

', 'PortMapping$hostPort' => '

The port number on the container instance to reserve for your container. 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 is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. 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, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit].

', '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 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].

', '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' => [], ], 'KeyValuePair' => [ 'base' => '

A key and value pair object.

', 'refs' => [ 'EnvironmentVariables$member' => NULL, ], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ '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.

', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => '

A list of 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.

', 'Service$loadBalancers' => '

A list of 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.

', ], ], '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. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. Valid log drivers are displayed in the LogConfiguration 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 into your container instance and run the following command: sudo docker version | grep "Server API version"

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 EC2 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 into your container instance and run the following command: sudo docker version | grep "Server API version"

', ], ], 'LogDriver' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$logDriver' => '

The log driver to use for the container. 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 into your container instance and run the following command: sudo docker version | grep "Server API version"

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'Resource$longValue' => '

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

', ], ], '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.

', ], ], '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.

', 'SubmitContainerStateChangeRequest$networkBindings' => '

The network bindings of the container.

', ], ], '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' => [], ], '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. 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. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run.

', ], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RequiresAttributes' => [ 'base' => NULL, 'refs' => [ 'TaskDefinition$requiresAttributes' => '

The container instance attributes required by your task.

', ], ], 'Resource' => [ 'base' => '

Describes the resources available for a container instance.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => '

The remaining resources of the container instance that are available for new tasks.

', 'ContainerInstance$registeredResources' => '

The registered resources on the container instance that are in use by current tasks.

', 'RegisterContainerInstanceRequest$totalResources' => '

The resources available on the instance.

', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], '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.

', '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.

', ], ], 'ServiceNotActiveException' => [ 'base' => '

The specified service is not active. You cannot update a service that is not active. 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' => [], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => '

The list of services described.

', ], ], '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.

', ], ], 'StartTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Attribute$name' => '

The name of the container instance attribute.

', 'Attribute$value' => '

The value of the container instance attribute.

', '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 Amazon Resource Name (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 detail about a running or stopped 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 repository-url/image:tag. 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.

', '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.

', '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 or INACTIVE. ACTIVE indicates that the container instance can accept tasks.

', 'ContainerOverride$name' => '

The name of the container that receives the override.

', '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 Amazon Resource Name (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 you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

', 'CreateServiceRequest$role' => '

The name or full Amazon Resource Name (ARN] of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

', 'DeleteClusterRequest$cluster' => '

The short name or full Amazon Resource Name (ARN] of the cluster to delete.

', 'DeleteServiceRequest$cluster' => '

The name 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. Valid values are PRIMARY (for the most recent deployment], ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment], and INACTIVE (for deployments that have been completely replaced].

', 'Deployment$taskDefinition' => '

The most recent task definition that was specified for the service to use.

', '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 Amazon Resource Name (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 name of 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.

', 'DiscoverPollEndpointRequest$containerInstance' => '

The container instance ID or full 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.

', 'DiscoverPollEndpointRequest$cluster' => '

The cluster that the container instance belongs to.

', '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, 'Failure$arn' => '

The Amazon Resource Name (ARN] of the failed resource.

', 'Failure$reason' => '

The reason for the failure.

', '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' => '

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.

', '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.

', '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 value is null when there are no more results to return.

', '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$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 value is null when there are no more results to return.

', '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 value is null when there are no more results to return.

', '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.

', '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 value is null when there are no more results to return.

', '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 value is null when there are no more results to return.

', '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 Amazon Resource Name (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 value is null when there are no more results to return.

', '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$loadBalancerName' => '

The name of the load balancer.

', 'LoadBalancer$containerName' => '

The name of the container to associate with the load balancer.

', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'MountPoint$sourceVolume' => '

The name of the volume to mount.

', '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.

', '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 Amazon Resource Name (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.

', 'Resource$name' => '

The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.

', 'Resource$type' => '

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

', '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 Amazon Resource Name (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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'ServerException$message' => NULL, 'Service$serviceArn' => '

The Amazon Resource Name (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' => '

A user-generated string that you can use to identify your service.

', 'Service$clusterArn' => '

The Amazon Resource Name (ARN] of the of the cluster that hosts the service.

', 'Service$status' => '

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

', '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 Amazon Resource Name (ARN] of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

', 'ServiceEvent$id' => '

The ID string of the event.

', 'ServiceEvent$message' => '

The event message.

', '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 Amazon Resource Name (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.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', '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 Amazon Resource Name (ARN] entry of the task to stop.

', 'StringList$member' => NULL, 'SubmitContainerStateChangeRequest$cluster' => '

The short name or full Amazon Resource Name (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 Amazon Resource Name (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.

', 'Task$taskArn' => '

The Amazon Resource Name (ARN] of the task.

', 'Task$clusterArn' => '

The Amazon Resource Name (ARN] of the of the cluster that hosts the task.

', 'Task$taskDefinitionArn' => '

The Amazon Resource Name (ARN] of the of the task definition that creates the task.

', 'Task$containerInstanceArn' => '

The Amazon Resource Name (ARN] of the container instances that host the task.

', 'Task$lastStatus' => '

The last known status of the task.

', 'Task$desiredStatus' => '

The desired status of the task.

', '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.

', 'TaskDefinition$taskDefinitionArn' => '

The full Amazon Resource Name (ARN] of the of the task definition.

', 'TaskDefinition$family' => '

The family of your task definition, used as the definition name.

', '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 Amazon Resource Name (ARN] entries for the container instance on which you would like to update the Amazon ECS container agent.

', '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 Amazon Resource Name (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.

', '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. This name is referenced in the sourceVolume parameter of container definition mountPoints.

', 'VolumeFrom$sourceContainer' => '

The name of the container to mount volumes from.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$links' => '

The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

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/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/reference/builder/#cmd.

', '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.

', '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.

', 'ContainerDefinition$dockerSecurityOptions' => '

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. 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 EC2 Container Service Developer Guide.

', 'ContainerOverride$command' => '

The command to send to the container that overrides the default command from the Docker image or the task definition.

', 'DescribeClustersRequest$clusters' => '

A space-separated list of 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 space-separated list of container instance IDs or full Amazon Resource Name (ARN] entries.

', 'DescribeServicesRequest$services' => '

A list of services to describe.

', 'DescribeTasksRequest$tasks' => '

A space-separated list of task IDs or full Amazon Resource Name (ARN] entries.

', '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 Amazon Resource Name (ARN] entries for each container instance associated with the specified cluster.

', 'ListServicesResponse$serviceArns' => '

The list of full Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (ARN] entries for the container instances on which you would like to place your task.

The list of container instances to start tasks on is limited to 10.

', ], ], 'SubmitContainerStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'Task' => [ 'base' => '

Details on a task in a cluster.

', 'refs' => [ 'StopTaskResponse$task' => NULL, '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.

', ], ], '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.

', ], ], '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.

', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => '

The list of tasks.

', 'RunTaskResponse$tasks' => '

A full description of the tasks that were run. Each task that was 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 are described here.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Deployment$createdAt' => '

The Unix time in seconds and milliseconds when the service was created.

', 'Deployment$updatedAt' => '

The Unix time in seconds and milliseconds when the service was last updated.

', 'ServiceEvent$createdAt' => '

The Unix time in seconds and milliseconds when the event was triggered.

', ], ], '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 into your container instance and run the following command: sudo docker version | grep "Server API version"

', ], ], 'UlimitName' => [ 'base' => NULL, 'refs' => [ 'Ulimit$name' => '

The type of the ulimit.

', ], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ '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.

', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => '

Details on a data volume from another container.

', '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. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

', ], ], ],]; diff --git a/src/data/iot/2015-05-28/api-2.json b/src/data/iot/2015-05-28/api-2.json new file mode 100644 index 0000000000..c51d160c01 --- /dev/null +++ b/src/data/iot/2015-05-28/api-2.json @@ -0,0 +1,2851 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-05-28", + "endpointPrefix":"iot", + "serviceFullName":"AWS IoT", + "signatureVersion":"v4", + "signingName":"execute-api", + "protocol":"rest-json" + }, + "operations":{ + "AcceptCertificateTransfer":{ + "name":"AcceptCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/accept-certificate-transfer/{certificateId}" + }, + "input":{"shape":"AcceptCertificateTransferRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"TransferAlreadyCompletedException", + "error":{"httpStatusCode":410}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "AttachPrincipalPolicy":{ + "name":"AttachPrincipalPolicy", + "http":{ + "method":"PUT", + "requestUri":"/principal-policies/{policyName}" + }, + "input":{"shape":"AttachPrincipalPolicyRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":410}, + "exception":true + } + ] + }, + "AttachThingPrincipal":{ + "name":"AttachThingPrincipal", + "http":{ + "method":"PUT", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"AttachThingPrincipalRequest"}, + "output":{"shape":"AttachThingPrincipalResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CancelCertificateTransfer":{ + "name":"CancelCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/cancel-certificate-transfer/{certificateId}" + }, + "input":{"shape":"CancelCertificateTransferRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"TransferAlreadyCompletedException", + "error":{"httpStatusCode":410}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreateCertificateFromCsr":{ + "name":"CreateCertificateFromCsr", + "http":{ + "method":"POST", + "requestUri":"/certificates" + }, + "input":{"shape":"CreateCertificateFromCsrRequest"}, + "output":{"shape":"CreateCertificateFromCsrResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreateKeysAndCertificate":{ + "name":"CreateKeysAndCertificate", + "http":{ + "method":"POST", + "requestUri":"/keys-and-certificate" + }, + "input":{"shape":"CreateKeysAndCertificateRequest"}, + "output":{"shape":"CreateKeysAndCertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreatePolicy":{ + "name":"CreatePolicy", + "http":{ + "method":"POST", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"CreatePolicyRequest"}, + "output":{"shape":"CreatePolicyResponse"}, + "errors":[ + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"MalformedPolicyException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreatePolicyVersion":{ + "name":"CreatePolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/policies/{policyName}/version" + }, + "input":{"shape":"CreatePolicyVersionRequest"}, + "output":{"shape":"CreatePolicyVersionResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"MalformedPolicyException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"VersionsLimitExceededException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreateThing":{ + "name":"CreateThing", + "http":{ + "method":"POST", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"CreateThingRequest"}, + "output":{"shape":"CreateThingResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + } + ] + }, + "CreateTopicRule":{ + "name":"CreateTopicRule", + "http":{ + "method":"POST", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"CreateTopicRuleRequest"}, + "errors":[ + { + "shape":"SqlParseException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "DeleteCertificate":{ + "name":"DeleteCertificate", + "http":{ + "method":"DELETE", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"DeleteCertificateRequest"}, + "errors":[ + { + "shape":"DeleteConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + } + ] + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"DELETE", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"DeletePolicyRequest"}, + "errors":[ + { + "shape":"DeleteConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeletePolicyVersion":{ + "name":"DeletePolicyVersion", + "http":{ + "method":"DELETE", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"DeletePolicyVersionRequest"}, + "errors":[ + { + "shape":"DeleteConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteThing":{ + "name":"DeleteThing", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"DeleteThingRequest"}, + "output":{"shape":"DeleteThingResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteTopicRule":{ + "name":"DeleteTopicRule", + "http":{ + "method":"DELETE", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"DeleteTopicRuleRequest"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "DescribeCertificate":{ + "name":"DescribeCertificate", + "http":{ + "method":"GET", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"DescribeCertificateRequest"}, + "output":{"shape":"DescribeCertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "DescribeEndpoint":{ + "name":"DescribeEndpoint", + "http":{ + "method":"GET", + "requestUri":"/endpoint" + }, + "input":{"shape":"DescribeEndpointRequest"}, + "output":{"shape":"DescribeEndpointResponse"}, + "errors":[ + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "DescribeThing":{ + "name":"DescribeThing", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"DescribeThingRequest"}, + "output":{"shape":"DescribeThingResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DetachPrincipalPolicy":{ + "name":"DetachPrincipalPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/principal-policies/{policyName}" + }, + "input":{"shape":"DetachPrincipalPolicyRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DetachThingPrincipal":{ + "name":"DetachThingPrincipal", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"DetachThingPrincipalRequest"}, + "output":{"shape":"DetachThingPrincipalResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetLoggingOptions":{ + "name":"GetLoggingOptions", + "http":{ + "method":"GET", + "requestUri":"/loggingOptions" + }, + "input":{"shape":"GetLoggingOptionsRequest"}, + "output":{"shape":"GetLoggingOptionsResponse"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{"shape":"GetPolicyResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetPolicyVersion":{ + "name":"GetPolicyVersion", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"GetPolicyVersionRequest"}, + "output":{"shape":"GetPolicyVersionResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetTopicRule":{ + "name":"GetTopicRule", + "http":{ + "method":"GET", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"GetTopicRuleRequest"}, + "output":{"shape":"GetTopicRuleResponse"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "ListCertificates":{ + "name":"ListCertificates", + "http":{ + "method":"GET", + "requestUri":"/certificates" + }, + "input":{"shape":"ListCertificatesRequest"}, + "output":{"shape":"ListCertificatesResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPolicies":{ + "name":"ListPolicies", + "http":{ + "method":"GET", + "requestUri":"/policies" + }, + "input":{"shape":"ListPoliciesRequest"}, + "output":{"shape":"ListPoliciesResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPolicyVersions":{ + "name":"ListPolicyVersions", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}/version" + }, + "input":{"shape":"ListPolicyVersionsRequest"}, + "output":{"shape":"ListPolicyVersionsResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPrincipalPolicies":{ + "name":"ListPrincipalPolicies", + "http":{ + "method":"GET", + "requestUri":"/principal-policies" + }, + "input":{"shape":"ListPrincipalPoliciesRequest"}, + "output":{"shape":"ListPrincipalPoliciesResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPrincipalThings":{ + "name":"ListPrincipalThings", + "http":{ + "method":"GET", + "requestUri":"/principals/things" + }, + "input":{"shape":"ListPrincipalThingsRequest"}, + "output":{"shape":"ListPrincipalThingsResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListThingPrincipals":{ + "name":"ListThingPrincipals", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"ListThingPrincipalsRequest"}, + "output":{"shape":"ListThingPrincipalsResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListThings":{ + "name":"ListThings", + "http":{ + "method":"GET", + "requestUri":"/things" + }, + "input":{"shape":"ListThingsRequest"}, + "output":{"shape":"ListThingsResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListTopicRules":{ + "name":"ListTopicRules", + "http":{ + "method":"GET", + "requestUri":"/rules" + }, + "input":{"shape":"ListTopicRulesRequest"}, + "output":{"shape":"ListTopicRulesResponse"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "RejectCertificateTransfer":{ + "name":"RejectCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/reject-certificate-transfer/{certificateId}" + }, + "input":{"shape":"RejectCertificateTransferRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"TransferAlreadyCompletedException", + "error":{"httpStatusCode":410}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ReplaceTopicRule":{ + "name":"ReplaceTopicRule", + "http":{ + "method":"PATCH", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"ReplaceTopicRuleRequest"}, + "errors":[ + { + "shape":"SqlParseException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "SetDefaultPolicyVersion":{ + "name":"SetDefaultPolicyVersion", + "http":{ + "method":"PATCH", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"SetDefaultPolicyVersionRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "SetLoggingOptions":{ + "name":"SetLoggingOptions", + "http":{ + "method":"POST", + "requestUri":"/loggingOptions" + }, + "input":{"shape":"SetLoggingOptionsRequest"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "TransferCertificate":{ + "name":"TransferCertificate", + "http":{ + "method":"PATCH", + "requestUri":"/transfer-certificate/{certificateId}" + }, + "input":{"shape":"TransferCertificateRequest"}, + "output":{"shape":"TransferCertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"TransferConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateCertificate":{ + "name":"UpdateCertificate", + "http":{ + "method":"PUT", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"UpdateCertificateRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateThing":{ + "name":"UpdateThing", + "http":{ + "method":"PATCH", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"UpdateThingRequest"}, + "output":{"shape":"UpdateThingResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + } + }, + "shapes":{ + "AcceptCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + }, + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "Action":{ + "type":"structure", + "members":{ + "dynamoDB":{"shape":"DynamoDBAction"}, + "lambda":{"shape":"LambdaAction"}, + "sns":{"shape":"SnsAction"}, + "sqs":{"shape":"SqsAction"}, + "kinesis":{"shape":"KinesisAction"}, + "republish":{"shape":"RepublishAction"}, + "s3":{"shape":"S3Action"}, + "firehose":{"shape":"FirehoseAction"} + } + }, + "ActionList":{ + "type":"list", + "member":{"shape":"Action"}, + "min":0, + "max":10 + }, + "AscendingOrder":{"type":"boolean"}, + "AttachPrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "principal" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-iot-principal" + } + } + }, + "AttachThingPrincipalRequest":{ + "type":"structure", + "required":[ + "thingName", + "principal" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-principal" + } + } + }, + "AttachThingPrincipalResponse":{ + "type":"structure", + "members":{ + } + }, + "AttributeName":{ + "type":"string", + "max":128, + "pattern":"[a-zA-Z0-9_.,@/:#-]+" + }, + "AttributePayload":{ + "type":"structure", + "members":{ + "attributes":{"shape":"Attributes"} + } + }, + "AttributeValue":{ + "type":"string", + "max":1024, + "pattern":"[a-zA-Z0-9_.,@/:#-]+" + }, + "Attributes":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AwsAccountId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "AwsArn":{"type":"string"}, + "BucketName":{"type":"string"}, + "CancelCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + } + } + }, + "Certificate":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "status":{"shape":"CertificateStatus"}, + "creationDate":{"shape":"DateType"} + } + }, + "CertificateArn":{"type":"string"}, + "CertificateDescription":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "status":{"shape":"CertificateStatus"}, + "certificatePem":{"shape":"CertificatePem"}, + "ownedBy":{"shape":"AwsAccountId"}, + "creationDate":{"shape":"DateType"}, + "lastModifiedDate":{"shape":"DateType"} + } + }, + "CertificateId":{ + "type":"string", + "min":64, + "max":64, + "pattern":"(0x)?[a-fA-F0-9]+" + }, + "CertificatePem":{"type":"string"}, + "CertificateSigningRequest":{ + "type":"string", + "min":1 + }, + "CertificateStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":406}, + "exception":true + }, + "CertificateStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE", + "REVOKED", + "PENDING_TRANSFER" + ] + }, + "Certificates":{ + "type":"list", + "member":{"shape":"Certificate"} + }, + "ClientId":{"type":"string"}, + "CreateCertificateFromCsrRequest":{ + "type":"structure", + "required":["certificateSigningRequest"], + "members":{ + "certificateSigningRequest":{"shape":"CertificateSigningRequest"}, + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "CreateCertificateFromCsrResponse":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "certificatePem":{"shape":"CertificatePem"} + } + }, + "CreateKeysAndCertificateRequest":{ + "type":"structure", + "members":{ + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "CreateKeysAndCertificateResponse":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "certificatePem":{"shape":"CertificatePem"}, + "keyPair":{"shape":"KeyPair"} + } + }, + "CreatePolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyDocument" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyDocument":{"shape":"PolicyDocument"} + } + }, + "CreatePolicyResponse":{ + "type":"structure", + "members":{ + "policyName":{"shape":"PolicyName"}, + "policyArn":{"shape":"PolicyArn"}, + "policyDocument":{"shape":"PolicyDocument"}, + "policyVersionId":{"shape":"PolicyVersionId"} + } + }, + "CreatePolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyDocument" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyDocument":{"shape":"PolicyDocument"}, + "setAsDefault":{ + "shape":"SetAsDefault", + "location":"querystring", + "locationName":"setAsDefault" + } + } + }, + "CreatePolicyVersionResponse":{ + "type":"structure", + "members":{ + "policyArn":{"shape":"PolicyArn"}, + "policyDocument":{"shape":"PolicyDocument"}, + "policyVersionId":{"shape":"PolicyVersionId"}, + "isDefaultVersion":{"shape":"IsDefaultVersion"} + } + }, + "CreateThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "attributePayload":{"shape":"AttributePayload"} + } + }, + "CreateThingResponse":{ + "type":"structure", + "members":{ + "thingName":{"shape":"ThingName"}, + "thingArn":{"shape":"ThingArn"} + } + }, + "CreateTopicRuleRequest":{ + "type":"structure", + "required":[ + "ruleName", + "topicRulePayload" + ], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + }, + "topicRulePayload":{"shape":"TopicRulePayload"} + }, + "payload":"topicRulePayload" + }, + "CreatedAtDate":{"type":"timestamp"}, + "DateType":{"type":"timestamp"}, + "DeleteCertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + } + } + }, + "DeleteConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DeletePolicyRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + } + } + }, + "DeletePolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "location":"uri", + "locationName":"policyVersionId" + } + } + }, + "DeleteThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "DeleteThingResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTopicRuleRequest":{ + "type":"structure", + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + } + }, + "required":["ruleName"] + }, + "DeliveryStreamName":{"type":"string"}, + "DescribeCertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + } + } + }, + "DescribeCertificateResponse":{ + "type":"structure", + "members":{ + "certificateDescription":{"shape":"CertificateDescription"} + } + }, + "DescribeEndpointRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeEndpointResponse":{ + "type":"structure", + "members":{ + "endpointAddress":{"shape":"EndpointAddress"} + } + }, + "DescribeThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "DescribeThingResponse":{ + "type":"structure", + "members":{ + "defaultClientId":{"shape":"ClientId"}, + "thingName":{"shape":"ThingName"}, + "attributes":{"shape":"Attributes"} + } + }, + "Description":{"type":"string"}, + "DetachPrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "principal" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-iot-principal" + } + } + }, + "DetachThingPrincipalRequest":{ + "type":"structure", + "required":[ + "thingName", + "principal" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-principal" + } + } + }, + "DetachThingPrincipalResponse":{ + "type":"structure", + "members":{ + } + }, + "DynamoDBAction":{ + "type":"structure", + "required":[ + "tableName", + "roleArn", + "hashKeyField", + "hashKeyValue", + "rangeKeyField", + "rangeKeyValue" + ], + "members":{ + "tableName":{"shape":"TableName"}, + "roleArn":{"shape":"AwsArn"}, + "hashKeyField":{"shape":"HashKeyField"}, + "hashKeyValue":{"shape":"HashKeyValue"}, + "rangeKeyField":{"shape":"RangeKeyField"}, + "rangeKeyValue":{"shape":"RangeKeyValue"}, + "payloadField":{"shape":"PayloadField"} + } + }, + "EndpointAddress":{"type":"string"}, + "FirehoseAction":{ + "type":"structure", + "required":[ + "roleArn", + "deliveryStreamName" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "deliveryStreamName":{"shape":"DeliveryStreamName"} + } + }, + "FunctionArn":{"type":"string"}, + "GetLoggingOptionsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetLoggingOptionsResponse":{ + "type":"structure", + "members":{ + "roleArn":{"shape":"AwsArn"}, + "logLevel":{"shape":"LogLevel"} + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + } + } + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "policyName":{"shape":"PolicyName"}, + "policyArn":{"shape":"PolicyArn"}, + "policyDocument":{"shape":"PolicyDocument"}, + "defaultVersionId":{"shape":"PolicyVersionId"} + } + }, + "GetPolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "location":"uri", + "locationName":"policyVersionId" + } + } + }, + "GetPolicyVersionResponse":{ + "type":"structure", + "members":{ + "policyArn":{"shape":"PolicyArn"}, + "policyName":{"shape":"PolicyName"}, + "policyDocument":{"shape":"PolicyDocument"}, + "policyVersionId":{"shape":"PolicyVersionId"}, + "isDefaultVersion":{"shape":"IsDefaultVersion"} + } + }, + "GetTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + } + } + }, + "GetTopicRuleResponse":{ + "type":"structure", + "members":{ + "rule":{"shape":"TopicRule"} + } + }, + "HashKeyField":{"type":"string"}, + "HashKeyValue":{"type":"string"}, + "InternalException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "IsDefaultVersion":{"type":"boolean"}, + "IsDisabled":{"type":"boolean"}, + "Key":{"type":"string"}, + "KeyPair":{ + "type":"structure", + "members":{ + "PublicKey":{"shape":"PublicKey"}, + "PrivateKey":{"shape":"PrivateKey"} + } + }, + "KinesisAction":{ + "type":"structure", + "required":[ + "roleArn", + "streamName" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "streamName":{"shape":"StreamName"}, + "partitionKey":{"shape":"PartitionKey"} + } + }, + "LambdaAction":{ + "type":"structure", + "required":["functionArn"], + "members":{ + "functionArn":{"shape":"FunctionArn"} + } + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":410}, + "exception":true + }, + "ListCertificatesRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListCertificatesResponse":{ + "type":"structure", + "members":{ + "certificates":{"shape":"Certificates"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListPoliciesRequest":{ + "type":"structure", + "members":{ + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListPoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{"shape":"Policies"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListPolicyVersionsRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + } + } + }, + "ListPolicyVersionsResponse":{ + "type":"structure", + "members":{ + "policyVersions":{"shape":"PolicyVersions"} + } + }, + "ListPrincipalPoliciesRequest":{ + "type":"structure", + "required":["principal"], + "members":{ + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-iot-principal" + }, + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListPrincipalPoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{"shape":"Policies"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListPrincipalThingsRequest":{ + "type":"structure", + "required":["principal"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-principal" + } + } + }, + "ListPrincipalThingsResponse":{ + "type":"structure", + "members":{ + "things":{"shape":"ThingNameList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListThingPrincipalsRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "ListThingPrincipalsResponse":{ + "type":"structure", + "members":{ + "principals":{"shape":"Principals"} + } + }, + "ListThingsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "attributeName":{ + "shape":"AttributeName", + "location":"querystring", + "locationName":"attributeName" + }, + "attributeValue":{ + "shape":"AttributeValue", + "location":"querystring", + "locationName":"attributeValue" + } + } + }, + "ListThingsResponse":{ + "type":"structure", + "members":{ + "things":{"shape":"ThingAttributeList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListTopicRulesRequest":{ + "type":"structure", + "members":{ + "topic":{ + "shape":"Topic", + "location":"querystring", + "locationName":"topic" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "ruleDisabled":{ + "shape":"IsDisabled", + "location":"querystring", + "locationName":"ruleDisabled" + } + } + }, + "ListTopicRulesResponse":{ + "type":"structure", + "members":{ + "rules":{"shape":"TopicRuleList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "LogLevel":{ + "type":"string", + "enum":[ + "DEBUG", + "INFO", + "ERROR", + "WARN", + "DISABLED" + ] + }, + "LoggingOptionsPayload":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "logLevel":{"shape":"LogLevel"} + } + }, + "MalformedPolicyException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Marker":{"type":"string"}, + "MaxResults":{ + "type":"integer", + "min":1, + "max":10000 + }, + "NextToken":{"type":"string"}, + "PageSize":{ + "type":"integer", + "min":1, + "max":250 + }, + "PartitionKey":{"type":"string"}, + "PayloadField":{"type":"string"}, + "Policies":{ + "type":"list", + "member":{"shape":"Policy"} + }, + "Policy":{ + "type":"structure", + "members":{ + "policyName":{"shape":"PolicyName"}, + "policyArn":{"shape":"PolicyArn"} + } + }, + "PolicyArn":{"type":"string"}, + "PolicyDocument":{"type":"string"}, + "PolicyName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w+=,.@-]+" + }, + "PolicyVersion":{ + "type":"structure", + "members":{ + "versionId":{"shape":"PolicyVersionId"}, + "isDefaultVersion":{"shape":"IsDefaultVersion"}, + "createDate":{"shape":"DateType"} + } + }, + "PolicyVersionId":{ + "type":"string", + "pattern":"[0-9]+" + }, + "PolicyVersions":{ + "type":"list", + "member":{"shape":"PolicyVersion"} + }, + "Principal":{"type":"string"}, + "PrincipalArn":{"type":"string"}, + "Principals":{ + "type":"list", + "member":{"shape":"PrincipalArn"} + }, + "PrivateKey":{ + "type":"string", + "min":1 + }, + "PublicKey":{ + "type":"string", + "min":1 + }, + "QueueUrl":{"type":"string"}, + "RangeKeyField":{"type":"string"}, + "RangeKeyValue":{"type":"string"}, + "RejectCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + } + } + }, + "ReplaceTopicRuleRequest":{ + "type":"structure", + "required":[ + "ruleName", + "topicRulePayload" + ], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + }, + "topicRulePayload":{"shape":"TopicRulePayload"} + }, + "payload":"topicRulePayload" + }, + "RepublishAction":{ + "type":"structure", + "required":[ + "roleArn", + "topic" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "topic":{"shape":"TopicPattern"} + } + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "RuleName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "S3Action":{ + "type":"structure", + "required":[ + "roleArn", + "bucketName", + "key" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "bucketName":{"shape":"BucketName"}, + "key":{"shape":"Key"} + } + }, + "SQL":{"type":"string"}, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SetAsActive":{"type":"boolean"}, + "SetAsDefault":{"type":"boolean"}, + "SetDefaultPolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "location":"uri", + "locationName":"policyVersionId" + } + } + }, + "SetLoggingOptionsRequest":{ + "type":"structure", + "members":{ + "loggingOptionsPayload":{"shape":"LoggingOptionsPayload"} + }, + "payload":"loggingOptionsPayload" + }, + "SnsAction":{ + "type":"structure", + "required":[ + "targetArn", + "roleArn" + ], + "members":{ + "targetArn":{"shape":"AwsArn"}, + "roleArn":{"shape":"AwsArn"} + } + }, + "SqlParseException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":406}, + "exception":true + }, + "SqsAction":{ + "type":"structure", + "required":[ + "roleArn", + "queueUrl" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "queueUrl":{"shape":"QueueUrl"}, + "useBase64":{"shape":"UseBase64"} + } + }, + "StreamName":{"type":"string"}, + "TableName":{"type":"string"}, + "ThingArn":{"type":"string"}, + "ThingAttribute":{ + "type":"structure", + "members":{ + "thingName":{"shape":"ThingName"}, + "attributes":{"shape":"Attributes"} + } + }, + "ThingAttributeList":{ + "type":"list", + "member":{"shape":"ThingAttribute"} + }, + "ThingName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ThingNameList":{ + "type":"list", + "member":{"shape":"ThingName"} + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":429}, + "exception":true + }, + "Topic":{"type":"string"}, + "TopicPattern":{"type":"string"}, + "TopicRule":{ + "type":"structure", + "members":{ + "ruleName":{"shape":"RuleName"}, + "sql":{"shape":"SQL"}, + "description":{"shape":"Description"}, + "createdAt":{"shape":"CreatedAtDate"}, + "actions":{"shape":"ActionList"}, + "ruleDisabled":{"shape":"IsDisabled"} + } + }, + "TopicRuleList":{ + "type":"list", + "member":{"shape":"TopicRuleListItem"} + }, + "TopicRuleListItem":{ + "type":"structure", + "members":{ + "ruleName":{"shape":"RuleName"}, + "topicPattern":{"shape":"TopicPattern"}, + "createdAt":{"shape":"CreatedAtDate"}, + "ruleDisabled":{"shape":"IsDisabled"} + } + }, + "TopicRulePayload":{ + "type":"structure", + "required":[ + "sql", + "actions" + ], + "members":{ + "sql":{"shape":"SQL"}, + "description":{"shape":"Description"}, + "actions":{"shape":"ActionList"}, + "ruleDisabled":{"shape":"IsDisabled"} + } + }, + "TransferAlreadyCompletedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":410}, + "exception":true + }, + "TransferCertificateRequest":{ + "type":"structure", + "required":[ + "certificateId", + "targetAwsAccount" + ], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + }, + "targetAwsAccount":{ + "shape":"AwsAccountId", + "location":"querystring", + "locationName":"targetAwsAccount" + } + } + }, + "TransferCertificateResponse":{ + "type":"structure", + "members":{ + "transferredCertificateArn":{"shape":"CertificateArn"} + } + }, + "TransferConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":401}, + "exception":true + }, + "UpdateCertificateRequest":{ + "type":"structure", + "required":[ + "certificateId", + "newStatus" + ], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + }, + "newStatus":{ + "shape":"CertificateStatus", + "location":"querystring", + "locationName":"newStatus" + } + } + }, + "UpdateThingRequest":{ + "type":"structure", + "required":[ + "thingName", + "attributePayload" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "attributePayload":{"shape":"AttributePayload"} + } + }, + "UpdateThingResponse":{ + "type":"structure", + "members":{ + } + }, + "UseBase64":{"type":"boolean"}, + "VersionsLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "errorMessage":{"type":"string"} + } +} diff --git a/src/data/iot/2015-05-28/api-2.json.php b/src/data/iot/2015-05-28/api-2.json.php new file mode 100644 index 0000000000..7f88ee77d0 --- /dev/null +++ b/src/data/iot/2015-05-28/api-2.json.php @@ -0,0 +1,3 @@ + '2.0', 'metadata' => [ 'apiVersion' => '2015-05-28', 'endpointPrefix' => 'iot', 'serviceFullName' => 'AWS IoT', 'signatureVersion' => 'v4', 'signingName' => 'execute-api', 'protocol' => 'rest-json', ], 'operations' => [ 'AcceptCertificateTransfer' => [ 'name' => 'AcceptCertificateTransfer', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/accept-certificate-transfer/{certificateId}', ], 'input' => [ 'shape' => 'AcceptCertificateTransferRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TransferAlreadyCompletedException', 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'AttachPrincipalPolicy' => [ 'name' => 'AttachPrincipalPolicy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/principal-policies/{policyName}', ], 'input' => [ 'shape' => 'AttachPrincipalPolicyRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'LimitExceededException', 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], ], ], 'AttachThingPrincipal' => [ 'name' => 'AttachThingPrincipal', 'http' => [ 'method' => 'PUT', 'requestUri' => '/things/{thingName}/principals', ], 'input' => [ 'shape' => 'AttachThingPrincipalRequest', ], 'output' => [ 'shape' => 'AttachThingPrincipalResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'CancelCertificateTransfer' => [ 'name' => 'CancelCertificateTransfer', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/cancel-certificate-transfer/{certificateId}', ], 'input' => [ 'shape' => 'CancelCertificateTransferRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TransferAlreadyCompletedException', 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'CreateCertificateFromCsr' => [ 'name' => 'CreateCertificateFromCsr', 'http' => [ 'method' => 'POST', 'requestUri' => '/certificates', ], 'input' => [ 'shape' => 'CreateCertificateFromCsrRequest', ], 'output' => [ 'shape' => 'CreateCertificateFromCsrResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'CreateKeysAndCertificate' => [ 'name' => 'CreateKeysAndCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/keys-and-certificate', ], 'input' => [ 'shape' => 'CreateKeysAndCertificateRequest', ], 'output' => [ 'shape' => 'CreateKeysAndCertificateResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'CreatePolicy' => [ 'name' => 'CreatePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/policies/{policyName}', ], 'input' => [ 'shape' => 'CreatePolicyRequest', ], 'output' => [ 'shape' => 'CreatePolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceAlreadyExistsException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'MalformedPolicyException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'CreatePolicyVersion' => [ 'name' => 'CreatePolicyVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/policies/{policyName}/version', ], 'input' => [ 'shape' => 'CreatePolicyVersionRequest', ], 'output' => [ 'shape' => 'CreatePolicyVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'MalformedPolicyException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'VersionsLimitExceededException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'CreateThing' => [ 'name' => 'CreateThing', 'http' => [ 'method' => 'POST', 'requestUri' => '/things/{thingName}', ], 'input' => [ 'shape' => 'CreateThingRequest', ], 'output' => [ 'shape' => 'CreateThingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'ResourceAlreadyExistsException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], ], ], 'CreateTopicRule' => [ 'name' => 'CreateTopicRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/rules/{ruleName}', ], 'input' => [ 'shape' => 'CreateTopicRuleRequest', ], 'errors' => [ [ 'shape' => 'SqlParseException', 'error' => [ 'httpStatusCode' => 406, ], 'exception' => true, ], [ 'shape' => 'InternalException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceAlreadyExistsException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], ], ], 'DeleteCertificate' => [ 'name' => 'DeleteCertificate', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/certificates/{certificateId}', ], 'input' => [ 'shape' => 'DeleteCertificateRequest', ], 'errors' => [ [ 'shape' => 'DeleteConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'CertificateStateException', 'error' => [ 'httpStatusCode' => 406, ], 'exception' => true, ], ], ], 'DeletePolicy' => [ 'name' => 'DeletePolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/policies/{policyName}', ], 'input' => [ 'shape' => 'DeletePolicyRequest', ], 'errors' => [ [ 'shape' => 'DeleteConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'DeletePolicyVersion' => [ 'name' => 'DeletePolicyVersion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/policies/{policyName}/version/{policyVersionId}', ], 'input' => [ 'shape' => 'DeletePolicyVersionRequest', ], 'errors' => [ [ 'shape' => 'DeleteConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'DeleteThing' => [ 'name' => 'DeleteThing', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/things/{thingName}', ], 'input' => [ 'shape' => 'DeleteThingRequest', ], 'output' => [ 'shape' => 'DeleteThingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'DeleteTopicRule' => [ 'name' => 'DeleteTopicRule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/rules/{ruleName}', ], 'input' => [ 'shape' => 'DeleteTopicRuleRequest', ], 'errors' => [ [ 'shape' => 'InternalException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], ], ], 'DescribeCertificate' => [ 'name' => 'DescribeCertificate', 'http' => [ 'method' => 'GET', 'requestUri' => '/certificates/{certificateId}', ], 'input' => [ 'shape' => 'DescribeCertificateRequest', ], 'output' => [ 'shape' => 'DescribeCertificateResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], ], ], 'DescribeEndpoint' => [ 'name' => 'DescribeEndpoint', 'http' => [ 'method' => 'GET', 'requestUri' => '/endpoint', ], 'input' => [ 'shape' => 'DescribeEndpointRequest', ], 'output' => [ 'shape' => 'DescribeEndpointResponse', ], 'errors' => [ [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], ], ], 'DescribeThing' => [ 'name' => 'DescribeThing', 'http' => [ 'method' => 'GET', 'requestUri' => '/things/{thingName}', ], 'input' => [ 'shape' => 'DescribeThingRequest', ], 'output' => [ 'shape' => 'DescribeThingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'DetachPrincipalPolicy' => [ 'name' => 'DetachPrincipalPolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/principal-policies/{policyName}', ], 'input' => [ 'shape' => 'DetachPrincipalPolicyRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'DetachThingPrincipal' => [ 'name' => 'DetachThingPrincipal', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/things/{thingName}/principals', ], 'input' => [ 'shape' => 'DetachThingPrincipalRequest', ], 'output' => [ 'shape' => 'DetachThingPrincipalResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'GetLoggingOptions' => [ 'name' => 'GetLoggingOptions', 'http' => [ 'method' => 'GET', 'requestUri' => '/loggingOptions', ], 'input' => [ 'shape' => 'GetLoggingOptionsRequest', ], 'output' => [ 'shape' => 'GetLoggingOptionsResponse', ], 'errors' => [ [ 'shape' => 'InternalException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], ], ], 'GetPolicy' => [ 'name' => 'GetPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/policies/{policyName}', ], 'input' => [ 'shape' => 'GetPolicyRequest', ], 'output' => [ 'shape' => 'GetPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'GetPolicyVersion' => [ 'name' => 'GetPolicyVersion', 'http' => [ 'method' => 'GET', 'requestUri' => '/policies/{policyName}/version/{policyVersionId}', ], 'input' => [ 'shape' => 'GetPolicyVersionRequest', ], 'output' => [ 'shape' => 'GetPolicyVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'GetTopicRule' => [ 'name' => 'GetTopicRule', 'http' => [ 'method' => 'GET', 'requestUri' => '/rules/{ruleName}', ], 'input' => [ 'shape' => 'GetTopicRuleRequest', ], 'output' => [ 'shape' => 'GetTopicRuleResponse', ], 'errors' => [ [ 'shape' => 'InternalException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], ], ], 'ListCertificates' => [ 'name' => 'ListCertificates', 'http' => [ 'method' => 'GET', 'requestUri' => '/certificates', ], 'input' => [ 'shape' => 'ListCertificatesRequest', ], 'output' => [ 'shape' => 'ListCertificatesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ListPolicies' => [ 'name' => 'ListPolicies', 'http' => [ 'method' => 'GET', 'requestUri' => '/policies', ], 'input' => [ 'shape' => 'ListPoliciesRequest', ], 'output' => [ 'shape' => 'ListPoliciesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ListPolicyVersions' => [ 'name' => 'ListPolicyVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/policies/{policyName}/version', ], 'input' => [ 'shape' => 'ListPolicyVersionsRequest', ], 'output' => [ 'shape' => 'ListPolicyVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ListPrincipalPolicies' => [ 'name' => 'ListPrincipalPolicies', 'http' => [ 'method' => 'GET', 'requestUri' => '/principal-policies', ], 'input' => [ 'shape' => 'ListPrincipalPoliciesRequest', ], 'output' => [ 'shape' => 'ListPrincipalPoliciesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ListPrincipalThings' => [ 'name' => 'ListPrincipalThings', 'http' => [ 'method' => 'GET', 'requestUri' => '/principals/things', ], 'input' => [ 'shape' => 'ListPrincipalThingsRequest', ], 'output' => [ 'shape' => 'ListPrincipalThingsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ListThingPrincipals' => [ 'name' => 'ListThingPrincipals', 'http' => [ 'method' => 'GET', 'requestUri' => '/things/{thingName}/principals', ], 'input' => [ 'shape' => 'ListThingPrincipalsRequest', ], 'output' => [ 'shape' => 'ListThingPrincipalsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ListThings' => [ 'name' => 'ListThings', 'http' => [ 'method' => 'GET', 'requestUri' => '/things', ], 'input' => [ 'shape' => 'ListThingsRequest', ], 'output' => [ 'shape' => 'ListThingsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ListTopicRules' => [ 'name' => 'ListTopicRules', 'http' => [ 'method' => 'GET', 'requestUri' => '/rules', ], 'input' => [ 'shape' => 'ListTopicRulesRequest', ], 'output' => [ 'shape' => 'ListTopicRulesResponse', ], 'errors' => [ [ 'shape' => 'InternalException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], ], ], 'RejectCertificateTransfer' => [ 'name' => 'RejectCertificateTransfer', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/reject-certificate-transfer/{certificateId}', ], 'input' => [ 'shape' => 'RejectCertificateTransferRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TransferAlreadyCompletedException', 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'ReplaceTopicRule' => [ 'name' => 'ReplaceTopicRule', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/rules/{ruleName}', ], 'input' => [ 'shape' => 'ReplaceTopicRuleRequest', ], 'errors' => [ [ 'shape' => 'SqlParseException', 'error' => [ 'httpStatusCode' => 406, ], 'exception' => true, ], [ 'shape' => 'InternalException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], ], ], 'SetDefaultPolicyVersion' => [ 'name' => 'SetDefaultPolicyVersion', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/policies/{policyName}/version/{policyVersionId}', ], 'input' => [ 'shape' => 'SetDefaultPolicyVersionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'SetLoggingOptions' => [ 'name' => 'SetLoggingOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/loggingOptions', ], 'input' => [ 'shape' => 'SetLoggingOptionsRequest', ], 'errors' => [ [ 'shape' => 'InternalException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], ], ], 'TransferCertificate' => [ 'name' => 'TransferCertificate', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/transfer-certificate/{certificateId}', ], 'input' => [ 'shape' => 'TransferCertificateRequest', ], 'output' => [ 'shape' => 'TransferCertificateResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'CertificateStateException', 'error' => [ 'httpStatusCode' => 406, ], 'exception' => true, ], [ 'shape' => 'TransferConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'UpdateCertificate' => [ 'name' => 'UpdateCertificate', 'http' => [ 'method' => 'PUT', 'requestUri' => '/certificates/{certificateId}', ], 'input' => [ 'shape' => 'UpdateCertificateRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'CertificateStateException', 'error' => [ 'httpStatusCode' => 406, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], ], ], 'UpdateThing' => [ 'name' => 'UpdateThing', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/things/{thingName}', ], 'input' => [ 'shape' => 'UpdateThingRequest', ], 'output' => [ 'shape' => 'UpdateThingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ThrottlingException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'UnauthorizedException', 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], [ 'shape' => 'ServiceUnavailableException', 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'InternalFailureException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], ], ], ], 'shapes' => [ 'AcceptCertificateTransferRequest' => [ 'type' => 'structure', 'required' => [ 'certificateId', ], 'members' => [ 'certificateId' => [ 'shape' => 'CertificateId', 'location' => 'uri', 'locationName' => 'certificateId', ], 'setAsActive' => [ 'shape' => 'SetAsActive', 'location' => 'querystring', 'locationName' => 'setAsActive', ], ], ], 'Action' => [ 'type' => 'structure', 'members' => [ 'dynamoDB' => [ 'shape' => 'DynamoDBAction', ], 'lambda' => [ 'shape' => 'LambdaAction', ], 'sns' => [ 'shape' => 'SnsAction', ], 'sqs' => [ 'shape' => 'SqsAction', ], 'kinesis' => [ 'shape' => 'KinesisAction', ], 'republish' => [ 'shape' => 'RepublishAction', ], 's3' => [ 'shape' => 'S3Action', ], 'firehose' => [ 'shape' => 'FirehoseAction', ], ], ], 'ActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Action', ], 'min' => 0, 'max' => 10, ], 'AscendingOrder' => [ 'type' => 'boolean', ], 'AttachPrincipalPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', 'principal', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], 'principal' => [ 'shape' => 'Principal', 'location' => 'header', 'locationName' => 'x-amzn-iot-principal', ], ], ], 'AttachThingPrincipalRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', 'principal', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'principal' => [ 'shape' => 'Principal', 'location' => 'header', 'locationName' => 'x-amzn-principal', ], ], ], 'AttachThingPrincipalResponse' => [ 'type' => 'structure', 'members' => [], ], 'AttributeName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[a-zA-Z0-9_.,@/:#-]+', ], 'AttributePayload' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'AttributeValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z0-9_.,@/:#-]+', ], 'Attributes' => [ 'type' => 'map', 'key' => [ 'shape' => 'AttributeName', ], 'value' => [ 'shape' => 'AttributeValue', ], ], 'AwsAccountId' => [ 'type' => 'string', 'pattern' => '[0-9]{12}', ], 'AwsArn' => [ 'type' => 'string', ], 'BucketName' => [ 'type' => 'string', ], 'CancelCertificateTransferRequest' => [ 'type' => 'structure', 'required' => [ 'certificateId', ], 'members' => [ 'certificateId' => [ 'shape' => 'CertificateId', 'location' => 'uri', 'locationName' => 'certificateId', ], ], ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'certificateArn' => [ 'shape' => 'CertificateArn', ], 'certificateId' => [ 'shape' => 'CertificateId', ], 'status' => [ 'shape' => 'CertificateStatus', ], 'creationDate' => [ 'shape' => 'DateType', ], ], ], 'CertificateArn' => [ 'type' => 'string', ], 'CertificateDescription' => [ 'type' => 'structure', 'members' => [ 'certificateArn' => [ 'shape' => 'CertificateArn', ], 'certificateId' => [ 'shape' => 'CertificateId', ], 'status' => [ 'shape' => 'CertificateStatus', ], 'certificatePem' => [ 'shape' => 'CertificatePem', ], 'ownedBy' => [ 'shape' => 'AwsAccountId', ], 'creationDate' => [ 'shape' => 'DateType', ], 'lastModifiedDate' => [ 'shape' => 'DateType', ], ], ], 'CertificateId' => [ 'type' => 'string', 'min' => 64, 'max' => 64, 'pattern' => '(0x]?[a-fA-F0-9]+', ], 'CertificatePem' => [ 'type' => 'string', ], 'CertificateSigningRequest' => [ 'type' => 'string', 'min' => 1, ], 'CertificateStateException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 406, ], 'exception' => true, ], 'CertificateStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'REVOKED', 'PENDING_TRANSFER', ], ], 'Certificates' => [ 'type' => 'list', 'member' => [ 'shape' => 'Certificate', ], ], 'ClientId' => [ 'type' => 'string', ], 'CreateCertificateFromCsrRequest' => [ 'type' => 'structure', 'required' => [ 'certificateSigningRequest', ], 'members' => [ 'certificateSigningRequest' => [ 'shape' => 'CertificateSigningRequest', ], 'setAsActive' => [ 'shape' => 'SetAsActive', 'location' => 'querystring', 'locationName' => 'setAsActive', ], ], ], 'CreateCertificateFromCsrResponse' => [ 'type' => 'structure', 'members' => [ 'certificateArn' => [ 'shape' => 'CertificateArn', ], 'certificateId' => [ 'shape' => 'CertificateId', ], 'certificatePem' => [ 'shape' => 'CertificatePem', ], ], ], 'CreateKeysAndCertificateRequest' => [ 'type' => 'structure', 'members' => [ 'setAsActive' => [ 'shape' => 'SetAsActive', 'location' => 'querystring', 'locationName' => 'setAsActive', ], ], ], 'CreateKeysAndCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'certificateArn' => [ 'shape' => 'CertificateArn', ], 'certificateId' => [ 'shape' => 'CertificateId', ], 'certificatePem' => [ 'shape' => 'CertificatePem', ], 'keyPair' => [ 'shape' => 'KeyPair', ], ], ], 'CreatePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', 'policyDocument', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], ], ], 'CreatePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', ], 'policyArn' => [ 'shape' => 'PolicyArn', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], 'policyVersionId' => [ 'shape' => 'PolicyVersionId', ], ], ], 'CreatePolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', 'policyDocument', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], 'setAsDefault' => [ 'shape' => 'SetAsDefault', 'location' => 'querystring', 'locationName' => 'setAsDefault', ], ], ], 'CreatePolicyVersionResponse' => [ 'type' => 'structure', 'members' => [ 'policyArn' => [ 'shape' => 'PolicyArn', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], 'policyVersionId' => [ 'shape' => 'PolicyVersionId', ], 'isDefaultVersion' => [ 'shape' => 'IsDefaultVersion', ], ], ], 'CreateThingRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'attributePayload' => [ 'shape' => 'AttributePayload', ], ], ], 'CreateThingResponse' => [ 'type' => 'structure', 'members' => [ 'thingName' => [ 'shape' => 'ThingName', ], 'thingArn' => [ 'shape' => 'ThingArn', ], ], ], 'CreateTopicRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ruleName', 'topicRulePayload', ], 'members' => [ 'ruleName' => [ 'shape' => 'RuleName', 'location' => 'uri', 'locationName' => 'ruleName', ], 'topicRulePayload' => [ 'shape' => 'TopicRulePayload', ], ], 'payload' => 'topicRulePayload', ], 'CreatedAtDate' => [ 'type' => 'timestamp', ], 'DateType' => [ 'type' => 'timestamp', ], 'DeleteCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateId', ], 'members' => [ 'certificateId' => [ 'shape' => 'CertificateId', 'location' => 'uri', 'locationName' => 'certificateId', ], ], ], 'DeleteConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DeletePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], ], ], 'DeletePolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', 'policyVersionId', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], 'policyVersionId' => [ 'shape' => 'PolicyVersionId', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'DeleteThingRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], ], ], 'DeleteThingResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTopicRuleRequest' => [ 'type' => 'structure', 'members' => [ 'ruleName' => [ 'shape' => 'RuleName', 'location' => 'uri', 'locationName' => 'ruleName', ], ], 'required' => [ 'ruleName', ], ], 'DeliveryStreamName' => [ 'type' => 'string', ], 'DescribeCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateId', ], 'members' => [ 'certificateId' => [ 'shape' => 'CertificateId', 'location' => 'uri', 'locationName' => 'certificateId', ], ], ], 'DescribeCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'certificateDescription' => [ 'shape' => 'CertificateDescription', ], ], ], 'DescribeEndpointRequest' => [ 'type' => 'structure', 'members' => [], ], 'DescribeEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'endpointAddress' => [ 'shape' => 'EndpointAddress', ], ], ], 'DescribeThingRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], ], ], 'DescribeThingResponse' => [ 'type' => 'structure', 'members' => [ 'defaultClientId' => [ 'shape' => 'ClientId', ], 'thingName' => [ 'shape' => 'ThingName', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'Description' => [ 'type' => 'string', ], 'DetachPrincipalPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', 'principal', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], 'principal' => [ 'shape' => 'Principal', 'location' => 'header', 'locationName' => 'x-amzn-iot-principal', ], ], ], 'DetachThingPrincipalRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', 'principal', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'principal' => [ 'shape' => 'Principal', 'location' => 'header', 'locationName' => 'x-amzn-principal', ], ], ], 'DetachThingPrincipalResponse' => [ 'type' => 'structure', 'members' => [], ], 'DynamoDBAction' => [ 'type' => 'structure', 'required' => [ 'tableName', 'roleArn', 'hashKeyField', 'hashKeyValue', 'rangeKeyField', 'rangeKeyValue', ], 'members' => [ 'tableName' => [ 'shape' => 'TableName', ], 'roleArn' => [ 'shape' => 'AwsArn', ], 'hashKeyField' => [ 'shape' => 'HashKeyField', ], 'hashKeyValue' => [ 'shape' => 'HashKeyValue', ], 'rangeKeyField' => [ 'shape' => 'RangeKeyField', ], 'rangeKeyValue' => [ 'shape' => 'RangeKeyValue', ], 'payloadField' => [ 'shape' => 'PayloadField', ], ], ], 'EndpointAddress' => [ 'type' => 'string', ], 'FirehoseAction' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'deliveryStreamName', ], 'members' => [ 'roleArn' => [ 'shape' => 'AwsArn', ], 'deliveryStreamName' => [ 'shape' => 'DeliveryStreamName', ], ], ], 'FunctionArn' => [ 'type' => 'string', ], 'GetLoggingOptionsRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetLoggingOptionsResponse' => [ 'type' => 'structure', 'members' => [ 'roleArn' => [ 'shape' => 'AwsArn', ], 'logLevel' => [ 'shape' => 'LogLevel', ], ], ], 'GetPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], ], ], 'GetPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', ], 'policyArn' => [ 'shape' => 'PolicyArn', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], 'defaultVersionId' => [ 'shape' => 'PolicyVersionId', ], ], ], 'GetPolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', 'policyVersionId', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], 'policyVersionId' => [ 'shape' => 'PolicyVersionId', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'GetPolicyVersionResponse' => [ 'type' => 'structure', 'members' => [ 'policyArn' => [ 'shape' => 'PolicyArn', ], 'policyName' => [ 'shape' => 'PolicyName', ], 'policyDocument' => [ 'shape' => 'PolicyDocument', ], 'policyVersionId' => [ 'shape' => 'PolicyVersionId', ], 'isDefaultVersion' => [ 'shape' => 'IsDefaultVersion', ], ], ], 'GetTopicRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ruleName', ], 'members' => [ 'ruleName' => [ 'shape' => 'RuleName', 'location' => 'uri', 'locationName' => 'ruleName', ], ], ], 'GetTopicRuleResponse' => [ 'type' => 'structure', 'members' => [ 'rule' => [ 'shape' => 'TopicRule', ], ], ], 'HashKeyField' => [ 'type' => 'string', ], 'HashKeyValue' => [ 'type' => 'string', ], 'InternalException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InternalFailureException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'IsDefaultVersion' => [ 'type' => 'boolean', ], 'IsDisabled' => [ 'type' => 'boolean', ], 'Key' => [ 'type' => 'string', ], 'KeyPair' => [ 'type' => 'structure', 'members' => [ 'PublicKey' => [ 'shape' => 'PublicKey', ], 'PrivateKey' => [ 'shape' => 'PrivateKey', ], ], ], 'KinesisAction' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'streamName', ], 'members' => [ 'roleArn' => [ 'shape' => 'AwsArn', ], 'streamName' => [ 'shape' => 'StreamName', ], 'partitionKey' => [ 'shape' => 'PartitionKey', ], ], ], 'LambdaAction' => [ 'type' => 'structure', 'required' => [ 'functionArn', ], 'members' => [ 'functionArn' => [ 'shape' => 'FunctionArn', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], 'ListCertificatesRequest' => [ 'type' => 'structure', 'members' => [ 'pageSize' => [ 'shape' => 'PageSize', 'location' => 'querystring', 'locationName' => 'pageSize', ], 'marker' => [ 'shape' => 'Marker', 'location' => 'querystring', 'locationName' => 'marker', ], 'ascendingOrder' => [ 'shape' => 'AscendingOrder', 'location' => 'querystring', 'locationName' => 'isAscendingOrder', ], ], ], 'ListCertificatesResponse' => [ 'type' => 'structure', 'members' => [ 'certificates' => [ 'shape' => 'Certificates', ], 'nextMarker' => [ 'shape' => 'Marker', ], ], ], 'ListPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'marker' => [ 'shape' => 'Marker', 'location' => 'querystring', 'locationName' => 'marker', ], 'pageSize' => [ 'shape' => 'PageSize', 'location' => 'querystring', 'locationName' => 'pageSize', ], 'ascendingOrder' => [ 'shape' => 'AscendingOrder', 'location' => 'querystring', 'locationName' => 'isAscendingOrder', ], ], ], 'ListPoliciesResponse' => [ 'type' => 'structure', 'members' => [ 'policies' => [ 'shape' => 'Policies', ], 'nextMarker' => [ 'shape' => 'Marker', ], ], ], 'ListPolicyVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], ], ], 'ListPolicyVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'policyVersions' => [ 'shape' => 'PolicyVersions', ], ], ], 'ListPrincipalPoliciesRequest' => [ 'type' => 'structure', 'required' => [ 'principal', ], 'members' => [ 'principal' => [ 'shape' => 'Principal', 'location' => 'header', 'locationName' => 'x-amzn-iot-principal', ], 'marker' => [ 'shape' => 'Marker', 'location' => 'querystring', 'locationName' => 'marker', ], 'pageSize' => [ 'shape' => 'PageSize', 'location' => 'querystring', 'locationName' => 'pageSize', ], 'ascendingOrder' => [ 'shape' => 'AscendingOrder', 'location' => 'querystring', 'locationName' => 'isAscendingOrder', ], ], ], 'ListPrincipalPoliciesResponse' => [ 'type' => 'structure', 'members' => [ 'policies' => [ 'shape' => 'Policies', ], 'nextMarker' => [ 'shape' => 'Marker', ], ], ], 'ListPrincipalThingsRequest' => [ 'type' => 'structure', 'required' => [ 'principal', ], 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'principal' => [ 'shape' => 'Principal', 'location' => 'header', 'locationName' => 'x-amzn-principal', ], ], ], 'ListPrincipalThingsResponse' => [ 'type' => 'structure', 'members' => [ 'things' => [ 'shape' => 'ThingNameList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListThingPrincipalsRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], ], ], 'ListThingPrincipalsResponse' => [ 'type' => 'structure', 'members' => [ 'principals' => [ 'shape' => 'Principals', ], ], ], 'ListThingsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'attributeName' => [ 'shape' => 'AttributeName', 'location' => 'querystring', 'locationName' => 'attributeName', ], 'attributeValue' => [ 'shape' => 'AttributeValue', 'location' => 'querystring', 'locationName' => 'attributeValue', ], ], ], 'ListThingsResponse' => [ 'type' => 'structure', 'members' => [ 'things' => [ 'shape' => 'ThingAttributeList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTopicRulesRequest' => [ 'type' => 'structure', 'members' => [ 'topic' => [ 'shape' => 'Topic', 'location' => 'querystring', 'locationName' => 'topic', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'ruleDisabled' => [ 'shape' => 'IsDisabled', 'location' => 'querystring', 'locationName' => 'ruleDisabled', ], ], ], 'ListTopicRulesResponse' => [ 'type' => 'structure', 'members' => [ 'rules' => [ 'shape' => 'TopicRuleList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'DEBUG', 'INFO', 'ERROR', 'WARN', 'DISABLED', ], ], 'LoggingOptionsPayload' => [ 'type' => 'structure', 'required' => [ 'roleArn', ], 'members' => [ 'roleArn' => [ 'shape' => 'AwsArn', ], 'logLevel' => [ 'shape' => 'LogLevel', ], ], ], 'MalformedPolicyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'Marker' => [ 'type' => 'string', ], 'MaxResults' => [ 'type' => 'integer', 'min' => 1, 'max' => 10000, ], 'NextToken' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'min' => 1, 'max' => 250, ], 'PartitionKey' => [ 'type' => 'string', ], 'PayloadField' => [ 'type' => 'string', ], 'Policies' => [ 'type' => 'list', 'member' => [ 'shape' => 'Policy', ], ], 'Policy' => [ 'type' => 'structure', 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', ], 'policyArn' => [ 'shape' => 'PolicyArn', ], ], ], 'PolicyArn' => [ 'type' => 'string', ], 'PolicyDocument' => [ 'type' => 'string', ], 'PolicyName' => [ 'type' => 'string', 'min' => 1, 'max' => 128, 'pattern' => '[\\w+=,.@-]+', ], 'PolicyVersion' => [ 'type' => 'structure', 'members' => [ 'versionId' => [ 'shape' => 'PolicyVersionId', ], 'isDefaultVersion' => [ 'shape' => 'IsDefaultVersion', ], 'createDate' => [ 'shape' => 'DateType', ], ], ], 'PolicyVersionId' => [ 'type' => 'string', 'pattern' => '[0-9]+', ], 'PolicyVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicyVersion', ], ], 'Principal' => [ 'type' => 'string', ], 'PrincipalArn' => [ 'type' => 'string', ], 'Principals' => [ 'type' => 'list', 'member' => [ 'shape' => 'PrincipalArn', ], ], 'PrivateKey' => [ 'type' => 'string', 'min' => 1, ], 'PublicKey' => [ 'type' => 'string', 'min' => 1, ], 'QueueUrl' => [ 'type' => 'string', ], 'RangeKeyField' => [ 'type' => 'string', ], 'RangeKeyValue' => [ 'type' => 'string', ], 'RejectCertificateTransferRequest' => [ 'type' => 'structure', 'required' => [ 'certificateId', ], 'members' => [ 'certificateId' => [ 'shape' => 'CertificateId', 'location' => 'uri', 'locationName' => 'certificateId', ], ], ], 'ReplaceTopicRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ruleName', 'topicRulePayload', ], 'members' => [ 'ruleName' => [ 'shape' => 'RuleName', 'location' => 'uri', 'locationName' => 'ruleName', ], 'topicRulePayload' => [ 'shape' => 'TopicRulePayload', ], ], 'payload' => 'topicRulePayload', ], 'RepublishAction' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'topic', ], 'members' => [ 'roleArn' => [ 'shape' => 'AwsArn', ], 'topic' => [ 'shape' => 'TopicPattern', ], ], ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'RuleName' => [ 'type' => 'string', 'min' => 1, 'max' => 128, 'pattern' => '^[a-zA-Z0-9_]+$', ], 'S3Action' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'bucketName', 'key', ], 'members' => [ 'roleArn' => [ 'shape' => 'AwsArn', ], 'bucketName' => [ 'shape' => 'BucketName', ], 'key' => [ 'shape' => 'Key', ], ], ], 'SQL' => [ 'type' => 'string', ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], 'SetAsActive' => [ 'type' => 'boolean', ], 'SetAsDefault' => [ 'type' => 'boolean', ], 'SetDefaultPolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'policyName', 'policyVersionId', ], 'members' => [ 'policyName' => [ 'shape' => 'PolicyName', 'location' => 'uri', 'locationName' => 'policyName', ], 'policyVersionId' => [ 'shape' => 'PolicyVersionId', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'SetLoggingOptionsRequest' => [ 'type' => 'structure', 'members' => [ 'loggingOptionsPayload' => [ 'shape' => 'LoggingOptionsPayload', ], ], 'payload' => 'loggingOptionsPayload', ], 'SnsAction' => [ 'type' => 'structure', 'required' => [ 'targetArn', 'roleArn', ], 'members' => [ 'targetArn' => [ 'shape' => 'AwsArn', ], 'roleArn' => [ 'shape' => 'AwsArn', ], ], ], 'SqlParseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 406, ], 'exception' => true, ], 'SqsAction' => [ 'type' => 'structure', 'required' => [ 'roleArn', 'queueUrl', ], 'members' => [ 'roleArn' => [ 'shape' => 'AwsArn', ], 'queueUrl' => [ 'shape' => 'QueueUrl', ], 'useBase64' => [ 'shape' => 'UseBase64', ], ], ], 'StreamName' => [ 'type' => 'string', ], 'TableName' => [ 'type' => 'string', ], 'ThingArn' => [ 'type' => 'string', ], 'ThingAttribute' => [ 'type' => 'structure', 'members' => [ 'thingName' => [ 'shape' => 'ThingName', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'ThingAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThingAttribute', ], ], 'ThingName' => [ 'type' => 'string', 'min' => 1, 'max' => 128, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ThingNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThingName', ], ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'Topic' => [ 'type' => 'string', ], 'TopicPattern' => [ 'type' => 'string', ], 'TopicRule' => [ 'type' => 'structure', 'members' => [ 'ruleName' => [ 'shape' => 'RuleName', ], 'sql' => [ 'shape' => 'SQL', ], 'description' => [ 'shape' => 'Description', ], 'createdAt' => [ 'shape' => 'CreatedAtDate', ], 'actions' => [ 'shape' => 'ActionList', ], 'ruleDisabled' => [ 'shape' => 'IsDisabled', ], ], ], 'TopicRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicRuleListItem', ], ], 'TopicRuleListItem' => [ 'type' => 'structure', 'members' => [ 'ruleName' => [ 'shape' => 'RuleName', ], 'topicPattern' => [ 'shape' => 'TopicPattern', ], 'createdAt' => [ 'shape' => 'CreatedAtDate', ], 'ruleDisabled' => [ 'shape' => 'IsDisabled', ], ], ], 'TopicRulePayload' => [ 'type' => 'structure', 'required' => [ 'sql', 'actions', ], 'members' => [ 'sql' => [ 'shape' => 'SQL', ], 'description' => [ 'shape' => 'Description', ], 'actions' => [ 'shape' => 'ActionList', ], 'ruleDisabled' => [ 'shape' => 'IsDisabled', ], ], ], 'TransferAlreadyCompletedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], 'TransferCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateId', 'targetAwsAccount', ], 'members' => [ 'certificateId' => [ 'shape' => 'CertificateId', 'location' => 'uri', 'locationName' => 'certificateId', ], 'targetAwsAccount' => [ 'shape' => 'AwsAccountId', 'location' => 'querystring', 'locationName' => 'targetAwsAccount', ], ], ], 'TransferCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'transferredCertificateArn' => [ 'shape' => 'CertificateArn', ], ], ], 'TransferConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'UnauthorizedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], 'UpdateCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateId', 'newStatus', ], 'members' => [ 'certificateId' => [ 'shape' => 'CertificateId', 'location' => 'uri', 'locationName' => 'certificateId', ], 'newStatus' => [ 'shape' => 'CertificateStatus', 'location' => 'querystring', 'locationName' => 'newStatus', ], ], ], 'UpdateThingRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', 'attributePayload', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'attributePayload' => [ 'shape' => 'AttributePayload', ], ], ], 'UpdateThingResponse' => [ 'type' => 'structure', 'members' => [], ], 'UseBase64' => [ 'type' => 'boolean', ], 'VersionsLimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'errorMessage' => [ 'type' => 'string', ], ],]; diff --git a/src/data/iot/2015-05-28/docs-2.json b/src/data/iot/2015-05-28/docs-2.json new file mode 100644 index 0000000000..314ea5d6e3 --- /dev/null +++ b/src/data/iot/2015-05-28/docs-2.json @@ -0,0 +1,1070 @@ +{ + "version": "2.0", + "operations": { + "AcceptCertificateTransfer": "

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

", + "AttachPrincipalPolicy": "

Attaches the specified policy to the specified principal (certificate or other credential).

", + "AttachThingPrincipal": "

Attaches the specified principal to the specified thing.

", + "CancelCertificateTransfer": "

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer (transfer destinations can use RejectCertificateTransfer instead). After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. Once the destination account has accepted the transfer, the transfer may no longer be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

", + "CreateCertificateFromCsr": "

Creates an X.509 certificate using the specified certificate signing request.

Note Reusing the same certificate signing request (CSR) results in a distinct certificate.

", + "CreateKeysAndCertificate": "

Creates a 2048 bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate. It is important to keep track of the private key.

", + "CreatePolicy": "

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

", + "CreatePolicyVersion": "

Creates a new version of the specified AWS IoT policy.

", + "CreateThing": "

Creates a thing in the thing registry.

", + "CreateTopicRule": "

Creates a rule.

", + "DeleteCertificate": "

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it. To delete a certificate, first detach all policies using the DetachPrincipalPolicy operation.

In addition, a certificate cannot be deleted if it is in ACTIVE status. To delete a certificate, first change the status to INACTIVE using the UpdateCertificate operation.

", + "DeletePolicy": "

Deletes the specified policy.

A policy cannot be deleted if:

- it has non-default versions

- it is attached to any certificate

To delete a policy:

- First delete all the non-default versions of the policy using the DeletePolicyVersion API.

- Detach it from any certificate using the DetachPrincipalPolicy API.

When a policy is deleted, its default version is deleted with it.

", + "DeletePolicyVersion": "

Deletes the specified version of the specified policy. The default version of the policy cannot be deleted.

To delete the default version use the DeletePolicy API or mark the policy as non-default and then delete it.

", + "DeleteThing": "

Deletes the specified thing from the Thing Registry.

", + "DeleteTopicRule": "

Deletes the specified rule.

", + "DescribeCertificate": "

Gets information about the specified certificate.

", + "DescribeEndpoint": "

Returns a unique URL specific to the AWS account making the call. The URL points to the AWS IoT data plane endpoint. The customer-specific endpoint should be provided to all data plane operations.

", + "DescribeThing": "

Gets information about the specified thing.

", + "DetachPrincipalPolicy": "

Removes the specified policy from the specified certificate.

", + "DetachThingPrincipal": "

Detaches the specified principal from the specified thing.

", + "GetLoggingOptions": "

Gets the logging options.

", + "GetPolicy": "

Gets information about the specified policy with the policy document of the default version.

", + "GetPolicyVersion": "

Gets information about the specified policy version.

", + "GetTopicRule": "

Gets information about the specified rule.

", + "ListCertificates": "

Lists your certificates.

The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker.

", + "ListPolicies": "

Lists your policies.

", + "ListPolicyVersions": "

Lists the versions of the specified policy, and identifies the default version.

", + "ListPrincipalPolicies": "

Lists the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity format.

", + "ListPrincipalThings": "

Lists the things associated with the specified principal.

", + "ListThingPrincipals": "

Lists the principals associated with the specified thing.

", + "ListThings": "

Lists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: \"ListThings where AttributeName=Color and AttributeValue=Red\"

", + "ListTopicRules": "

Lists the rules for the specific topic.

", + "RejectCertificateTransfer": "

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. Once called, the certificate will be returned to the source's account in the INACTIVE state.

", + "ReplaceTopicRule": "

Replaces the specified rule. You must specify all parameters for the new rule.

", + "SetDefaultPolicyVersion": "

Sets the specified policy version as the default for the specified policy.

", + "SetLoggingOptions": "

Sets the logging options.

", + "TransferCertificate": "

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account, it is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. It can be deactivated using the UpdateCertificate API.

The certificate must not have any policies attached to it. These can be detached using the DetachPrincipalPolicy API.

", + "UpdateCertificate": "

Updates the status of the specified certificate. This operation is idempotent.

Moving a cert from the ACTIVE state (including REVOKED) will NOT disconnect currently-connected devices, although these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

", + "UpdateThing": "

Updates the data for a thing.

" + }, + "service": "AWS IoT (Beta)

AWS IoT is in beta and is subject to change

AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.

For more information about how AWS IoT works, see the Developer Guide.

", + "shapes": { + "AcceptCertificateTransferRequest": { + "base": "

The input for the AcceptCertificateTransfer operation.

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

Describes the actions associated with a rule.

", + "refs": { + "ActionList$member": null + } + }, + "ActionList": { + "base": null, + "refs": { + "TopicRule$actions": "

The actions associated with the rule.

", + "TopicRulePayload$actions": "

The actions associated with the rule.

" + } + }, + "AscendingOrder": { + "base": null, + "refs": { + "ListCertificatesRequest$ascendingOrder": "

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

", + "ListPoliciesRequest$ascendingOrder": "

Specifies the order for results. If true, the results are returned in ascending creation order.

", + "ListPrincipalPoliciesRequest$ascendingOrder": "

Specifies the order for results. If true, results are returned in ascending creation order.

" + } + }, + "AttachPrincipalPolicyRequest": { + "base": "

The input for the AttachPrincipalPolicy operation.

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

The input for the AttachThingPrincipal operation.

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

The output from the AttachThingPrincipal operation.

", + "refs": { + } + }, + "AttributeName": { + "base": null, + "refs": { + "Attributes$key": null, + "ListThingsRequest$attributeName": "

The attribute name.

" + } + }, + "AttributePayload": { + "base": "

The attribute payload, a JSON string containing up to three key-value pairs.

For example: {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\”}}

", + "refs": { + "CreateThingRequest$attributePayload": "

The attribute payload. Which consists of up to 3 name/value pairs in a JSON document. For example: {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\”}}

", + "UpdateThingRequest$attributePayload": "

The attribute payload, a JSON string containing up to three key-value pairs.

For example: {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\”}}

" + } + }, + "AttributeValue": { + "base": null, + "refs": { + "Attributes$value": null, + "ListThingsRequest$attributeValue": "

The attribute value.

" + } + }, + "Attributes": { + "base": null, + "refs": { + "AttributePayload$attributes": "

A JSON string containing up to three key-value pair in JSON format.

For example: {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\”}}

", + "DescribeThingResponse$attributes": "

The attributes which are name/value pairs in JSON format. For example:

{\\\"attributes\\\":{\\\"some-name1\\\":\\\"some-value1\\”}, {\\\"some-name2\\\":\\\"some-value2\\”}, {\\\"some-name3\\\":\\\"some-value3\\”}}

", + "ThingAttribute$attributes": "

The attributes.

" + } + }, + "AwsAccountId": { + "base": null, + "refs": { + "CertificateDescription$ownedBy": "

The ID of the AWS account that owns the certificate.

", + "TransferCertificateRequest$targetAwsAccount": "

The AWS account.

" + } + }, + "AwsArn": { + "base": null, + "refs": { + "DynamoDBAction$roleArn": "

The ARN of the IAM role that grants access.

", + "FirehoseAction$roleArn": null, + "GetLoggingOptionsResponse$roleArn": "

The ARN of the IAM role that grants access.

", + "KinesisAction$roleArn": "

The ARN of the IAM role that grants access.

", + "LoggingOptionsPayload$roleArn": "

The ARN of the IAM role that grants access.

", + "RepublishAction$roleArn": "

The ARN of the IAM role that grants access.

", + "S3Action$roleArn": "

The ARN of the IAM role that grants access.

", + "SnsAction$targetArn": "

The ARN of the SNS topic.

", + "SnsAction$roleArn": "

The ARN of the IAM role that grants access.

", + "SqsAction$roleArn": "

The ARN of the IAM role that grants access.

" + } + }, + "BucketName": { + "base": null, + "refs": { + "S3Action$bucketName": "

The S3 bucket.

" + } + }, + "CancelCertificateTransferRequest": { + "base": "

The input for the CancelCertificateTransfer operation.

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

Information about a certificate.

", + "refs": { + "Certificates$member": null + } + }, + "CertificateArn": { + "base": null, + "refs": { + "Certificate$certificateArn": "

The ARN of the certificate.

", + "CertificateDescription$certificateArn": "

The ARN of the certificate.

", + "CreateCertificateFromCsrResponse$certificateArn": "

The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.

", + "CreateKeysAndCertificateResponse$certificateArn": "

The ARN of the certificate.

", + "TransferCertificateResponse$transferredCertificateArn": "

The ARN of the certificate.

" + } + }, + "CertificateDescription": { + "base": "

Describes a certificate.

", + "refs": { + "DescribeCertificateResponse$certificateDescription": "

The description of the certificate.

" + } + }, + "CertificateId": { + "base": null, + "refs": { + "AcceptCertificateTransferRequest$certificateId": "

The ID of the certificate.

", + "CancelCertificateTransferRequest$certificateId": "

The ID of the certificate.

", + "Certificate$certificateId": "

The ID of the certificate.

", + "CertificateDescription$certificateId": "

The ID of the certificate.

", + "CreateCertificateFromCsrResponse$certificateId": "

The ID of the certificate. Certificate management operations only take a certificateId.

", + "CreateKeysAndCertificateResponse$certificateId": "

The ID of the certificate. AWS IoT issues a default subject name for the certificate (e.g., AWS IoT Certificate).

", + "DeleteCertificateRequest$certificateId": "

The ID of the certificate.

", + "DescribeCertificateRequest$certificateId": "

The ID of the certificate.

", + "RejectCertificateTransferRequest$certificateId": "

The ID of the certificate.

", + "TransferCertificateRequest$certificateId": "

The ID of the certificate.

", + "UpdateCertificateRequest$certificateId": "

The ID of the certificate.

" + } + }, + "CertificatePem": { + "base": null, + "refs": { + "CertificateDescription$certificatePem": "

The certificate data, in PEM format.

", + "CreateCertificateFromCsrResponse$certificatePem": "

The certificate data, in PEM format.

", + "CreateKeysAndCertificateResponse$certificatePem": "

The certificate data, in PEM format.

" + } + }, + "CertificateSigningRequest": { + "base": null, + "refs": { + "CreateCertificateFromCsrRequest$certificateSigningRequest": "

The certificate signing request (CSR).

" + } + }, + "CertificateStateException": { + "base": "

The certificate operation is not allowed.

", + "refs": { + } + }, + "CertificateStatus": { + "base": null, + "refs": { + "Certificate$status": "

The status of the certificate.

", + "CertificateDescription$status": "

The status of the certificate.

", + "UpdateCertificateRequest$newStatus": "

The new status.

" + } + }, + "Certificates": { + "base": null, + "refs": { + "ListCertificatesResponse$certificates": "

The descriptions of the certificates.

" + } + }, + "ClientId": { + "base": null, + "refs": { + "DescribeThingResponse$defaultClientId": "

The default client ID.

" + } + }, + "CreateCertificateFromCsrRequest": { + "base": "

The input for the CreateCertificateFromCsr operation.

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

The output from the CreateCertificateFromCsr operation.

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

The input for the CreateKeysAndCertificate operation.

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

The output of the CreateKeysAndCertificate operation.

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

The input for the CreatePolicy operation.

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

The output from the CreatePolicy operation.

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

The input for the CreatePolicyVersion operation.

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

The output of the CreatePolicyVersion operation.

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

The input for the CreateThing operation.

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

The output of the CreateThing operation.

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

The input for the CreateTopicRule operation.

", + "refs": { + } + }, + "CreatedAtDate": { + "base": null, + "refs": { + "TopicRule$createdAt": "

The date and time the rule was created.

", + "TopicRuleListItem$createdAt": "

The date and time the rule was created.

" + } + }, + "DateType": { + "base": null, + "refs": { + "Certificate$creationDate": "

The date and time the certificate was created.

", + "CertificateDescription$creationDate": "

The date and time the certificate was created.

", + "CertificateDescription$lastModifiedDate": "

The date and time the certificate was last modified.

", + "PolicyVersion$createDate": "

The date and time the policy was created.

" + } + }, + "DeleteCertificateRequest": { + "base": "

The input for the DeleteCertificate operation.

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

You can't delete the resource because it is attached to one or more resources.

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

The input for the DeletePolicy operation.

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

The input for the DeletePolicyVersion operation.

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

The input for the DeleteThing operation.

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

The output of the DeleteThing operation.

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

The input for the DeleteTopicRule operation.

", + "refs": { + } + }, + "DeliveryStreamName": { + "base": null, + "refs": { + "FirehoseAction$deliveryStreamName": null + } + }, + "DescribeCertificateRequest": { + "base": "

The input for the DescribeCertificate operation.

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

The output of the DescribeCertificate operation.

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

The input for the DescribeEndpoint operation.

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

The output from the DescribeEndpoint operation.

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

The input for the DescribeThing operation.

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

The output from the DescribeThing operation.

", + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "TopicRule$description": "

The description of the rule.

", + "TopicRulePayload$description": "

The description of the rule.

" + } + }, + "DetachPrincipalPolicyRequest": { + "base": "

The input for the DetachPrincipalPolicy operation.

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

The input for the DetachThingPrincipal operation.

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

The output from the DetachThingPrincipal operation.

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

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any expression that's valid in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

\"hashKeyValue\": \"${topic(3)}\"

The following field uses the timestamp:

\"rangeKeyValue\": \"${timestamp()}\"

", + "refs": { + "Action$dynamoDB": "

Write to a DynamoDB table.

" + } + }, + "EndpointAddress": { + "base": null, + "refs": { + "DescribeEndpointResponse$endpointAddress": "

The address.

" + } + }, + "FirehoseAction": { + "base": null, + "refs": { + "Action$firehose": null + } + }, + "FunctionArn": { + "base": null, + "refs": { + "LambdaAction$functionArn": "

The ARN of the Lambda function.

" + } + }, + "GetLoggingOptionsRequest": { + "base": "

The input for the GetLoggingOptions operation.

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

The output from the GetLoggingOptions operation.

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

The input for the GetPolicy operation.

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

The output from the GetPolicy operation.

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

The input for the GetPolicyVersion operation.

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

The output from the GetPolicyVersion operation.

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

The input for the GetTopicRule operation.

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

The output from the GetTopicRule operation.

", + "refs": { + } + }, + "HashKeyField": { + "base": null, + "refs": { + "DynamoDBAction$hashKeyField": "

The hash key name.

" + } + }, + "HashKeyValue": { + "base": null, + "refs": { + "DynamoDBAction$hashKeyValue": "

The hash key value.

" + } + }, + "InternalException": { + "base": "

An unexpected error has occurred.

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

An unexpected error has occurred.

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

The request is not valid.

", + "refs": { + } + }, + "IsDefaultVersion": { + "base": null, + "refs": { + "CreatePolicyVersionResponse$isDefaultVersion": "

Specifies whether the policy version is the default.

", + "GetPolicyVersionResponse$isDefaultVersion": "

Specifies whether the policy version is the default.

", + "PolicyVersion$isDefaultVersion": "

Specifies whether the policy version is the default.

" + } + }, + "IsDisabled": { + "base": null, + "refs": { + "ListTopicRulesRequest$ruleDisabled": "

Specifies whether the rule is disabled.

", + "TopicRule$ruleDisabled": "

Specifies whether the rule is disabled.

", + "TopicRuleListItem$ruleDisabled": "

Specifies whether the rule is disabled.

", + "TopicRulePayload$ruleDisabled": "

Specifies whether the rule is disabled.

" + } + }, + "Key": { + "base": null, + "refs": { + "S3Action$key": "

The object key.

" + } + }, + "KeyPair": { + "base": "

Describes a key pair.

", + "refs": { + "CreateKeysAndCertificateResponse$keyPair": "

The generated key pair.

" + } + }, + "KinesisAction": { + "base": "

Describes an action to write data to an Amazon Kinesis stream.

", + "refs": { + "Action$kinesis": "

Write data to a Kinesis stream.

" + } + }, + "LambdaAction": { + "base": "

Describes an action to invoke a Lamdba function.

", + "refs": { + "Action$lambda": "

Invoke a Lambda function.

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

The number of attached entities exceeds the limit.

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

The input for the ListCertificates operation.

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

The output of the ListCertificates operation.

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

The input for the ListPolicies operation.

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

The output from the ListPolicies operation.

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

The input for the ListPolicyVersions operation.

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

The output from the ListPolicyVersions operation.

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

The input for the ListPrincipalPolicies operation.

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

The output from the ListPrincipalPolicies operation.

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

The input for the ListPrincipalThings operation.

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

The output from the ListPrincipalThings operation.

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

The input for the ListThingPrincipal operation.

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

The output from the ListThingPrincipals operation.

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

The input for the ListThings operation.

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

The output from the ListThings operation.

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

The input for the ListTopicRules operation.

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

The output from the ListTopicRules operation.

", + "refs": { + } + }, + "LogLevel": { + "base": null, + "refs": { + "GetLoggingOptionsResponse$logLevel": "

The logging level.

", + "LoggingOptionsPayload$logLevel": "

The logging level.

" + } + }, + "LoggingOptionsPayload": { + "base": "

Describes the logging options payload.

", + "refs": { + "SetLoggingOptionsRequest$loggingOptionsPayload": "

The logging options payload.

" + } + }, + "MalformedPolicyException": { + "base": "

The policy documentation is not valid.

", + "refs": { + } + }, + "Marker": { + "base": null, + "refs": { + "ListCertificatesRequest$marker": "

The marker for the next set of results.

", + "ListCertificatesResponse$nextMarker": "

The marker for the next set of results, or null if there are no additional results.

", + "ListPoliciesRequest$marker": "

The marker for the next set of results.

", + "ListPoliciesResponse$nextMarker": "

The marker for the next set of results, or null if there are no additional results.

", + "ListPrincipalPoliciesRequest$marker": "

The marker for the next set of results.

", + "ListPrincipalPoliciesResponse$nextMarker": "

The marker for the next set of results, or null if there are no additional results.

" + } + }, + "MaxResults": { + "base": null, + "refs": { + "ListPrincipalThingsRequest$maxResults": null, + "ListThingsRequest$maxResults": "

The maximum number of results.

", + "ListTopicRulesRequest$maxResults": "

The maximum number of results to return.

" + } + }, + "NextToken": { + "base": null, + "refs": { + "ListPrincipalThingsRequest$nextToken": null, + "ListPrincipalThingsResponse$nextToken": "

A token used to retrieve the next value.

", + "ListThingsRequest$nextToken": "

The token for the next value.

", + "ListThingsResponse$nextToken": "

A token used to retrieve the next value.

", + "ListTopicRulesRequest$nextToken": "

A token used to retrieve the next value.

", + "ListTopicRulesResponse$nextToken": "

A token used to retrieve the next value.

" + } + }, + "PageSize": { + "base": null, + "refs": { + "ListCertificatesRequest$pageSize": "

The result page size.

", + "ListPoliciesRequest$pageSize": "

The result page size.

", + "ListPrincipalPoliciesRequest$pageSize": "

The result page size.

" + } + }, + "PartitionKey": { + "base": null, + "refs": { + "KinesisAction$partitionKey": "

The partition key.

" + } + }, + "PayloadField": { + "base": null, + "refs": { + "DynamoDBAction$payloadField": "

The action payload.

" + } + }, + "Policies": { + "base": null, + "refs": { + "ListPoliciesResponse$policies": "

The descriptions of the policies.

", + "ListPrincipalPoliciesResponse$policies": "

The policies.

" + } + }, + "Policy": { + "base": "

Describes an AWS IoT policy.

", + "refs": { + "Policies$member": null + } + }, + "PolicyArn": { + "base": null, + "refs": { + "CreatePolicyResponse$policyArn": "

The policy ARN.

", + "CreatePolicyVersionResponse$policyArn": "

The policy ARN.

", + "GetPolicyResponse$policyArn": "

The policy ARN.

", + "GetPolicyVersionResponse$policyArn": "

The policy ARN.

", + "Policy$policyArn": "

The policy ARN.

" + } + }, + "PolicyDocument": { + "base": null, + "refs": { + "CreatePolicyRequest$policyDocument": "

The JSON document that describes the policy. The length of the policyDocument must be a minimum length of 1, with a maximum length of 2048, excluding whitespace.

", + "CreatePolicyResponse$policyDocument": "

The JSON document that describes the policy.

", + "CreatePolicyVersionRequest$policyDocument": "

The JSON document that describes the policy.

", + "CreatePolicyVersionResponse$policyDocument": "

The JSON document that describes the policy.

", + "GetPolicyResponse$policyDocument": "

The JSON document that describes the policy.

", + "GetPolicyVersionResponse$policyDocument": "

The JSON document that describes the policy.

" + } + }, + "PolicyName": { + "base": null, + "refs": { + "AttachPrincipalPolicyRequest$policyName": "

The policy name.

", + "CreatePolicyRequest$policyName": "

The policy name.

", + "CreatePolicyResponse$policyName": "

The policy name.

", + "CreatePolicyVersionRequest$policyName": "

The policy name.

", + "DeletePolicyRequest$policyName": "

The name of the policy to delete.

", + "DeletePolicyVersionRequest$policyName": "

The name of the policy.

", + "DetachPrincipalPolicyRequest$policyName": "

The name of the policy to detach.

", + "GetPolicyRequest$policyName": "

The name of the policy.

", + "GetPolicyResponse$policyName": "

The policy name.

", + "GetPolicyVersionRequest$policyName": "

The name of the policy.

", + "GetPolicyVersionResponse$policyName": "

The policy name.

", + "ListPolicyVersionsRequest$policyName": "

The policy name.

", + "Policy$policyName": "

The policy name.

", + "SetDefaultPolicyVersionRequest$policyName": "

The policy name.

" + } + }, + "PolicyVersion": { + "base": "

Describes a policy version.

", + "refs": { + "PolicyVersions$member": null + } + }, + "PolicyVersionId": { + "base": null, + "refs": { + "CreatePolicyResponse$policyVersionId": "

The policy version ID.

", + "CreatePolicyVersionResponse$policyVersionId": "

The policy version ID.

", + "DeletePolicyVersionRequest$policyVersionId": "

The policy version ID.

", + "GetPolicyResponse$defaultVersionId": "

The default policy version ID.

", + "GetPolicyVersionRequest$policyVersionId": "

The policy version ID.

", + "GetPolicyVersionResponse$policyVersionId": "

The policy version ID.

", + "PolicyVersion$versionId": "

The policy version ID.

", + "SetDefaultPolicyVersionRequest$policyVersionId": "

The policy version ID.

" + } + }, + "PolicyVersions": { + "base": null, + "refs": { + "ListPolicyVersionsResponse$policyVersions": "

The policy versions.

" + } + }, + "Principal": { + "base": null, + "refs": { + "AttachPrincipalPolicyRequest$principal": "

The principal which can be a certificate ARN (as returned from the CreateCertificate operation) or a Cognito ID.

", + "AttachThingPrincipalRequest$principal": "

The principal (certificate or other credential).

", + "DetachPrincipalPolicyRequest$principal": "

The principal

If the principal is a certificate, specify the certificate ARN. If the principal is a Cognito identity specify the identity ID.

", + "DetachThingPrincipalRequest$principal": "

The principal.

", + "ListPrincipalPoliciesRequest$principal": "

The principal.

", + "ListPrincipalThingsRequest$principal": "

The principal.

" + } + }, + "PrincipalArn": { + "base": null, + "refs": { + "Principals$member": null + } + }, + "Principals": { + "base": null, + "refs": { + "ListThingPrincipalsResponse$principals": "

The principals.

" + } + }, + "PrivateKey": { + "base": null, + "refs": { + "KeyPair$PrivateKey": "

The private key.

" + } + }, + "PublicKey": { + "base": null, + "refs": { + "KeyPair$PublicKey": "

The public key.

" + } + }, + "QueueUrl": { + "base": null, + "refs": { + "SqsAction$queueUrl": "

The URL of the Amazon SQS queue.

" + } + }, + "RangeKeyField": { + "base": null, + "refs": { + "DynamoDBAction$rangeKeyField": "

The range key name.

" + } + }, + "RangeKeyValue": { + "base": null, + "refs": { + "DynamoDBAction$rangeKeyValue": "

The range key value.

" + } + }, + "RejectCertificateTransferRequest": { + "base": "

The input for the RejectCertificateTransfer operation.

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

The input for the ReplaceTopicRule operation.

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

Describes an action to republish to another topic.

", + "refs": { + "Action$republish": "

Publish to another MQTT topic.

" + } + }, + "ResourceAlreadyExistsException": { + "base": "

The resource already exists.

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

The specified resource does not exist.

", + "refs": { + } + }, + "RuleName": { + "base": null, + "refs": { + "CreateTopicRuleRequest$ruleName": "

The name of the rule.

", + "DeleteTopicRuleRequest$ruleName": "

The name of the rule.

", + "GetTopicRuleRequest$ruleName": "

The name of the rule.

", + "ReplaceTopicRuleRequest$ruleName": "

The name of the rule.

", + "TopicRule$ruleName": "

The name of the rule.

", + "TopicRuleListItem$ruleName": "

The name of the rule.

" + } + }, + "S3Action": { + "base": "

Describes an action to write data to an Amazon S3 bucket.

", + "refs": { + "Action$s3": "

Write to an S3 bucket.

" + } + }, + "SQL": { + "base": null, + "refs": { + "TopicRule$sql": "

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters properly.

", + "TopicRulePayload$sql": "

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.

" + } + }, + "ServiceUnavailableException": { + "base": "

The service is temporarily unavailable.

", + "refs": { + } + }, + "SetAsActive": { + "base": null, + "refs": { + "AcceptCertificateTransferRequest$setAsActive": "

Specifies whether the certificate is active.

", + "CreateCertificateFromCsrRequest$setAsActive": "

Specifies whether the certificate is active.

", + "CreateKeysAndCertificateRequest$setAsActive": "

Specifies whether the certificate is active.

" + } + }, + "SetAsDefault": { + "base": null, + "refs": { + "CreatePolicyVersionRequest$setAsDefault": "

Specifies whether the policy version is set as the default.

" + } + }, + "SetDefaultPolicyVersionRequest": { + "base": "

The input for the SetDefaultPolicyVersion operation.

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

The input for the SetLoggingOptions operation.

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

Describes an action to publish to an Amazon SNS topic.

", + "refs": { + "Action$sns": "

Publish to an SNS topic.

" + } + }, + "SqlParseException": { + "base": "

The Rule-SQL expression can't be parsed correctly.

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

Describes an action to publish data to an SQS queue.

", + "refs": { + "Action$sqs": "

Publish to an SQS queue.

" + } + }, + "StreamName": { + "base": null, + "refs": { + "KinesisAction$streamName": "

The name of the Kinesis stream.

" + } + }, + "TableName": { + "base": null, + "refs": { + "DynamoDBAction$tableName": "

The name of the DynamoDB table.

" + } + }, + "ThingArn": { + "base": null, + "refs": { + "CreateThingResponse$thingArn": "

The thing ARN.

" + } + }, + "ThingAttribute": { + "base": "

Describes a thing attribute.

", + "refs": { + "ThingAttributeList$member": null + } + }, + "ThingAttributeList": { + "base": null, + "refs": { + "ListThingsResponse$things": "

The things.

" + } + }, + "ThingName": { + "base": null, + "refs": { + "AttachThingPrincipalRequest$thingName": "

The name of the thing.

", + "CreateThingRequest$thingName": "

The name of the thing.

", + "CreateThingResponse$thingName": "

The name of the thing.

", + "DeleteThingRequest$thingName": "

The thing name.

", + "DescribeThingRequest$thingName": "

The name of the thing.

", + "DescribeThingResponse$thingName": "

The name of the thing.

", + "DetachThingPrincipalRequest$thingName": "

The name of the thing.

", + "ListThingPrincipalsRequest$thingName": "

The name of the thing.

", + "ThingAttribute$thingName": "

The name of the thing.

", + "ThingNameList$member": null, + "UpdateThingRequest$thingName": "

The thing name.

" + } + }, + "ThingNameList": { + "base": null, + "refs": { + "ListPrincipalThingsResponse$things": "

The things.

" + } + }, + "ThrottlingException": { + "base": "

The rate exceeds the limit.

", + "refs": { + } + }, + "Topic": { + "base": null, + "refs": { + "ListTopicRulesRequest$topic": "

The topic.

" + } + }, + "TopicPattern": { + "base": null, + "refs": { + "RepublishAction$topic": "

The name of the MQTT topic.

", + "TopicRuleListItem$topicPattern": "

The pattern for the topic names that apply.

" + } + }, + "TopicRule": { + "base": "

Describes a rule.

", + "refs": { + "GetTopicRuleResponse$rule": "

The rule.

" + } + }, + "TopicRuleList": { + "base": null, + "refs": { + "ListTopicRulesResponse$rules": "

The rules.

" + } + }, + "TopicRuleListItem": { + "base": "

Describes a rule.

", + "refs": { + "TopicRuleList$member": null + } + }, + "TopicRulePayload": { + "base": "

Describes a rule.

", + "refs": { + "CreateTopicRuleRequest$topicRulePayload": "

The rule payload.

", + "ReplaceTopicRuleRequest$topicRulePayload": "

The rule payload.

" + } + }, + "TransferAlreadyCompletedException": { + "base": "

You can't revert the certificate transfer because it has already completed.

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

The input for the TransferCertificate operation.

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

The output from the TransferCertificate operation.

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

You can't transfer the the certificate because authorization policies are still attached.

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

You are not authorized to perform this operation.

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

The input for the UpdateCertificate operation.

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

The input for the UpdateThing operation.

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

The output from the UpdateThing operation.

", + "refs": { + } + }, + "UseBase64": { + "base": null, + "refs": { + "SqsAction$useBase64": "

Specifies whether to use Base64 encoding.

" + } + }, + "VersionsLimitExceededException": { + "base": "

The number of policy versions exceeds the limit.

", + "refs": { + } + }, + "errorMessage": { + "base": null, + "refs": { + "CertificateStateException$message": "

The message for the exception.

", + "DeleteConflictException$message": "

The message for the exception.

", + "InternalException$message": "

The message for the exception.

", + "InternalFailureException$message": "

The message for the exception.

", + "InvalidRequestException$message": "

The message for the exception.

", + "LimitExceededException$message": "

The message for the exception.

", + "MalformedPolicyException$message": "

The message for the exception.

", + "ResourceAlreadyExistsException$message": "

The message for the exception.

", + "ResourceNotFoundException$message": "

The message for the exception.

", + "ServiceUnavailableException$message": "

The message for the exception.

", + "SqlParseException$message": "

The message for the exception.

", + "ThrottlingException$message": "

The message for the exception.

", + "TransferAlreadyCompletedException$message": "

The message for the exception.

", + "TransferConflictException$message": "

The message for the exception.

", + "UnauthorizedException$message": "

The message for the exception.

", + "VersionsLimitExceededException$message": "

The message for the exception.

" + } + } + } +} diff --git a/src/data/iot/2015-05-28/docs-2.json.php b/src/data/iot/2015-05-28/docs-2.json.php new file mode 100644 index 0000000000..7bf01ed49f --- /dev/null +++ b/src/data/iot/2015-05-28/docs-2.json.php @@ -0,0 +1,3 @@ + '2.0', 'operations' => [ 'AcceptCertificateTransfer' => '

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

', 'AttachPrincipalPolicy' => '

Attaches the specified policy to the specified principal (certificate or other credential].

', 'AttachThingPrincipal' => '

Attaches the specified principal to the specified thing.

', 'CancelCertificateTransfer' => '

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer (transfer destinations can use RejectCertificateTransfer instead]. After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. Once the destination account has accepted the transfer, the transfer may no longer be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

', 'CreateCertificateFromCsr' => '

Creates an X.509 certificate using the specified certificate signing request.

Note Reusing the same certificate signing request (CSR] results in a distinct certificate.

', 'CreateKeysAndCertificate' => '

Creates a 2048 bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate. It is important to keep track of the private key.

', 'CreatePolicy' => '

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy\'s default version.

', 'CreatePolicyVersion' => '

Creates a new version of the specified AWS IoT policy.

', 'CreateThing' => '

Creates a thing in the thing registry.

', 'CreateTopicRule' => '

Creates a rule.

', 'DeleteCertificate' => '

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it. To delete a certificate, first detach all policies using the DetachPrincipalPolicy operation.

In addition, a certificate cannot be deleted if it is in ACTIVE status. To delete a certificate, first change the status to INACTIVE using the UpdateCertificate operation.

', 'DeletePolicy' => '

Deletes the specified policy.

A policy cannot be deleted if:

- it has non-default versions

- it is attached to any certificate

To delete a policy:

- First delete all the non-default versions of the policy using the DeletePolicyVersion API.

- Detach it from any certificate using the DetachPrincipalPolicy API.

When a policy is deleted, its default version is deleted with it.

', 'DeletePolicyVersion' => '

Deletes the specified version of the specified policy. The default version of the policy cannot be deleted.

To delete the default version use the DeletePolicy API or mark the policy as non-default and then delete it.

', 'DeleteThing' => '

Deletes the specified thing from the Thing Registry.

', 'DeleteTopicRule' => '

Deletes the specified rule.

', 'DescribeCertificate' => '

Gets information about the specified certificate.

', 'DescribeEndpoint' => '

Returns a unique URL specific to the AWS account making the call. The URL points to the AWS IoT data plane endpoint. The customer-specific endpoint should be provided to all data plane operations.

', 'DescribeThing' => '

Gets information about the specified thing.

', 'DetachPrincipalPolicy' => '

Removes the specified policy from the specified certificate.

', 'DetachThingPrincipal' => '

Detaches the specified principal from the specified thing.

', 'GetLoggingOptions' => '

Gets the logging options.

', 'GetPolicy' => '

Gets information about the specified policy with the policy document of the default version.

', 'GetPolicyVersion' => '

Gets information about the specified policy version.

', 'GetTopicRule' => '

Gets information about the specified rule.

', 'ListCertificates' => '

Lists your certificates.

The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker.

', 'ListPolicies' => '

Lists your policies.

', 'ListPolicyVersions' => '

Lists the versions of the specified policy, and identifies the default version.

', 'ListPrincipalPolicies' => '

Lists the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity format.

', 'ListPrincipalThings' => '

Lists the things associated with the specified principal.

', 'ListThingPrincipals' => '

Lists the principals associated with the specified thing.

', 'ListThings' => '

Lists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: "ListThings where AttributeName=Color and AttributeValue=Red"

', 'ListTopicRules' => '

Lists the rules for the specific topic.

', 'RejectCertificateTransfer' => '

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. Once called, the certificate will be returned to the source\'s account in the INACTIVE state.

', 'ReplaceTopicRule' => '

Replaces the specified rule. You must specify all parameters for the new rule.

', 'SetDefaultPolicyVersion' => '

Sets the specified policy version as the default for the specified policy.

', 'SetLoggingOptions' => '

Sets the logging options.

', 'TransferCertificate' => '

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination\'s account, it is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. It can be deactivated using the UpdateCertificate API.

The certificate must not have any policies attached to it. These can be detached using the DetachPrincipalPolicy API.

', 'UpdateCertificate' => '

Updates the status of the specified certificate. This operation is idempotent.

Moving a cert from the ACTIVE state (including REVOKED] will NOT disconnect currently-connected devices, although these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

', 'UpdateThing' => '

Updates the data for a thing.

', ], 'service' => 'AWS IoT (Beta]

AWS IoT is in beta and is subject to change

AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances] and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each thing (Thing Registry], configure logging, and create and manage policies and credentials to authenticate things.

For more information about how AWS IoT works, see the Developer Guide.

', 'shapes' => [ 'AcceptCertificateTransferRequest' => [ 'base' => '

The input for the AcceptCertificateTransfer operation.

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

Describes the actions associated with a rule.

', 'refs' => [ 'ActionList$member' => NULL, ], ], 'ActionList' => [ 'base' => NULL, 'refs' => [ 'TopicRule$actions' => '

The actions associated with the rule.

', 'TopicRulePayload$actions' => '

The actions associated with the rule.

', ], ], 'AscendingOrder' => [ 'base' => NULL, 'refs' => [ 'ListCertificatesRequest$ascendingOrder' => '

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

', 'ListPoliciesRequest$ascendingOrder' => '

Specifies the order for results. If true, the results are returned in ascending creation order.

', 'ListPrincipalPoliciesRequest$ascendingOrder' => '

Specifies the order for results. If true, results are returned in ascending creation order.

', ], ], 'AttachPrincipalPolicyRequest' => [ 'base' => '

The input for the AttachPrincipalPolicy operation.

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

The input for the AttachThingPrincipal operation.

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

The output from the AttachThingPrincipal operation.

', 'refs' => [], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'Attributes$key' => NULL, 'ListThingsRequest$attributeName' => '

The attribute name.

', ], ], 'AttributePayload' => [ 'base' => '

The attribute payload, a JSON string containing up to three key-value pairs.

For example: {\\"attributes\\":{\\"string1\\":\\"string2\\”}}

', 'refs' => [ 'CreateThingRequest$attributePayload' => '

The attribute payload. Which consists of up to 3 name/value pairs in a JSON document. For example: {\\"attributes\\":{\\"string1\\":\\"string2\\”}}

', 'UpdateThingRequest$attributePayload' => '

The attribute payload, a JSON string containing up to three key-value pairs.

For example: {\\"attributes\\":{\\"string1\\":\\"string2\\”}}

', ], ], 'AttributeValue' => [ 'base' => NULL, 'refs' => [ 'Attributes$value' => NULL, 'ListThingsRequest$attributeValue' => '

The attribute value.

', ], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'AttributePayload$attributes' => '

A JSON string containing up to three key-value pair in JSON format.

For example: {\\"attributes\\":{\\"string1\\":\\"string2\\”}}

', 'DescribeThingResponse$attributes' => '

The attributes which are name/value pairs in JSON format. For example:

{\\"attributes\\":{\\"some-name1\\":\\"some-value1\\”}, {\\"some-name2\\":\\"some-value2\\”}, {\\"some-name3\\":\\"some-value3\\”}}

', 'ThingAttribute$attributes' => '

The attributes.

', ], ], 'AwsAccountId' => [ 'base' => NULL, 'refs' => [ 'CertificateDescription$ownedBy' => '

The ID of the AWS account that owns the certificate.

', 'TransferCertificateRequest$targetAwsAccount' => '

The AWS account.

', ], ], 'AwsArn' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$roleArn' => '

The ARN of the IAM role that grants access.

', 'FirehoseAction$roleArn' => NULL, 'GetLoggingOptionsResponse$roleArn' => '

The ARN of the IAM role that grants access.

', 'KinesisAction$roleArn' => '

The ARN of the IAM role that grants access.

', 'LoggingOptionsPayload$roleArn' => '

The ARN of the IAM role that grants access.

', 'RepublishAction$roleArn' => '

The ARN of the IAM role that grants access.

', 'S3Action$roleArn' => '

The ARN of the IAM role that grants access.

', 'SnsAction$targetArn' => '

The ARN of the SNS topic.

', 'SnsAction$roleArn' => '

The ARN of the IAM role that grants access.

', 'SqsAction$roleArn' => '

The ARN of the IAM role that grants access.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Action$bucketName' => '

The S3 bucket.

', ], ], 'CancelCertificateTransferRequest' => [ 'base' => '

The input for the CancelCertificateTransfer operation.

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

Information about a certificate.

', 'refs' => [ 'Certificates$member' => NULL, ], ], 'CertificateArn' => [ 'base' => NULL, 'refs' => [ 'Certificate$certificateArn' => '

The ARN of the certificate.

', 'CertificateDescription$certificateArn' => '

The ARN of the certificate.

', 'CreateCertificateFromCsrResponse$certificateArn' => '

The Amazon Resource Name (ARN] of the certificate. You can use the ARN as a principal for policy operations.

', 'CreateKeysAndCertificateResponse$certificateArn' => '

The ARN of the certificate.

', 'TransferCertificateResponse$transferredCertificateArn' => '

The ARN of the certificate.

', ], ], 'CertificateDescription' => [ 'base' => '

Describes a certificate.

', 'refs' => [ 'DescribeCertificateResponse$certificateDescription' => '

The description of the certificate.

', ], ], 'CertificateId' => [ 'base' => NULL, 'refs' => [ 'AcceptCertificateTransferRequest$certificateId' => '

The ID of the certificate.

', 'CancelCertificateTransferRequest$certificateId' => '

The ID of the certificate.

', 'Certificate$certificateId' => '

The ID of the certificate.

', 'CertificateDescription$certificateId' => '

The ID of the certificate.

', 'CreateCertificateFromCsrResponse$certificateId' => '

The ID of the certificate. Certificate management operations only take a certificateId.

', 'CreateKeysAndCertificateResponse$certificateId' => '

The ID of the certificate. AWS IoT issues a default subject name for the certificate (e.g., AWS IoT Certificate].

', 'DeleteCertificateRequest$certificateId' => '

The ID of the certificate.

', 'DescribeCertificateRequest$certificateId' => '

The ID of the certificate.

', 'RejectCertificateTransferRequest$certificateId' => '

The ID of the certificate.

', 'TransferCertificateRequest$certificateId' => '

The ID of the certificate.

', 'UpdateCertificateRequest$certificateId' => '

The ID of the certificate.

', ], ], 'CertificatePem' => [ 'base' => NULL, 'refs' => [ 'CertificateDescription$certificatePem' => '

The certificate data, in PEM format.

', 'CreateCertificateFromCsrResponse$certificatePem' => '

The certificate data, in PEM format.

', 'CreateKeysAndCertificateResponse$certificatePem' => '

The certificate data, in PEM format.

', ], ], 'CertificateSigningRequest' => [ 'base' => NULL, 'refs' => [ 'CreateCertificateFromCsrRequest$certificateSigningRequest' => '

The certificate signing request (CSR].

', ], ], 'CertificateStateException' => [ 'base' => '

The certificate operation is not allowed.

', 'refs' => [], ], 'CertificateStatus' => [ 'base' => NULL, 'refs' => [ 'Certificate$status' => '

The status of the certificate.

', 'CertificateDescription$status' => '

The status of the certificate.

', 'UpdateCertificateRequest$newStatus' => '

The new status.

', ], ], 'Certificates' => [ 'base' => NULL, 'refs' => [ 'ListCertificatesResponse$certificates' => '

The descriptions of the certificates.

', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'DescribeThingResponse$defaultClientId' => '

The default client ID.

', ], ], 'CreateCertificateFromCsrRequest' => [ 'base' => '

The input for the CreateCertificateFromCsr operation.

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

The output from the CreateCertificateFromCsr operation.

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

The input for the CreateKeysAndCertificate operation.

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

The output of the CreateKeysAndCertificate operation.

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

The input for the CreatePolicy operation.

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

The output from the CreatePolicy operation.

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

The input for the CreatePolicyVersion operation.

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

The output of the CreatePolicyVersion operation.

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

The input for the CreateThing operation.

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

The output of the CreateThing operation.

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

The input for the CreateTopicRule operation.

', 'refs' => [], ], 'CreatedAtDate' => [ 'base' => NULL, 'refs' => [ 'TopicRule$createdAt' => '

The date and time the rule was created.

', 'TopicRuleListItem$createdAt' => '

The date and time the rule was created.

', ], ], 'DateType' => [ 'base' => NULL, 'refs' => [ 'Certificate$creationDate' => '

The date and time the certificate was created.

', 'CertificateDescription$creationDate' => '

The date and time the certificate was created.

', 'CertificateDescription$lastModifiedDate' => '

The date and time the certificate was last modified.

', 'PolicyVersion$createDate' => '

The date and time the policy was created.

', ], ], 'DeleteCertificateRequest' => [ 'base' => '

The input for the DeleteCertificate operation.

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

You can\'t delete the resource because it is attached to one or more resources.

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

The input for the DeletePolicy operation.

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

The input for the DeletePolicyVersion operation.

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

The input for the DeleteThing operation.

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

The output of the DeleteThing operation.

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

The input for the DeleteTopicRule operation.

', 'refs' => [], ], 'DeliveryStreamName' => [ 'base' => NULL, 'refs' => [ 'FirehoseAction$deliveryStreamName' => NULL, ], ], 'DescribeCertificateRequest' => [ 'base' => '

The input for the DescribeCertificate operation.

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

The output of the DescribeCertificate operation.

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

The input for the DescribeEndpoint operation.

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

The output from the DescribeEndpoint operation.

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

The input for the DescribeThing operation.

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

The output from the DescribeThing operation.

', 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'TopicRule$description' => '

The description of the rule.

', 'TopicRulePayload$description' => '

The description of the rule.

', ], ], 'DetachPrincipalPolicyRequest' => [ 'base' => '

The input for the DetachPrincipalPolicy operation.

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

The input for the DetachThingPrincipal operation.

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

The output from the DetachThingPrincipal operation.

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

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any expression that\'s valid in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

"hashKeyValue": "${topic(3]}"

The following field uses the timestamp:

"rangeKeyValue": "${timestamp(]}"

', 'refs' => [ 'Action$dynamoDB' => '

Write to a DynamoDB table.

', ], ], 'EndpointAddress' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointResponse$endpointAddress' => '

The address.

', ], ], 'FirehoseAction' => [ 'base' => NULL, 'refs' => [ 'Action$firehose' => NULL, ], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'LambdaAction$functionArn' => '

The ARN of the Lambda function.

', ], ], 'GetLoggingOptionsRequest' => [ 'base' => '

The input for the GetLoggingOptions operation.

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

The output from the GetLoggingOptions operation.

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

The input for the GetPolicy operation.

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

The output from the GetPolicy operation.

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

The input for the GetPolicyVersion operation.

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

The output from the GetPolicyVersion operation.

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

The input for the GetTopicRule operation.

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

The output from the GetTopicRule operation.

', 'refs' => [], ], 'HashKeyField' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$hashKeyField' => '

The hash key name.

', ], ], 'HashKeyValue' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$hashKeyValue' => '

The hash key value.

', ], ], 'InternalException' => [ 'base' => '

An unexpected error has occurred.

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

An unexpected error has occurred.

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

The request is not valid.

', 'refs' => [], ], 'IsDefaultVersion' => [ 'base' => NULL, 'refs' => [ 'CreatePolicyVersionResponse$isDefaultVersion' => '

Specifies whether the policy version is the default.

', 'GetPolicyVersionResponse$isDefaultVersion' => '

Specifies whether the policy version is the default.

', 'PolicyVersion$isDefaultVersion' => '

Specifies whether the policy version is the default.

', ], ], 'IsDisabled' => [ 'base' => NULL, 'refs' => [ 'ListTopicRulesRequest$ruleDisabled' => '

Specifies whether the rule is disabled.

', 'TopicRule$ruleDisabled' => '

Specifies whether the rule is disabled.

', 'TopicRuleListItem$ruleDisabled' => '

Specifies whether the rule is disabled.

', 'TopicRulePayload$ruleDisabled' => '

Specifies whether the rule is disabled.

', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'S3Action$key' => '

The object key.

', ], ], 'KeyPair' => [ 'base' => '

Describes a key pair.

', 'refs' => [ 'CreateKeysAndCertificateResponse$keyPair' => '

The generated key pair.

', ], ], 'KinesisAction' => [ 'base' => '

Describes an action to write data to an Amazon Kinesis stream.

', 'refs' => [ 'Action$kinesis' => '

Write data to a Kinesis stream.

', ], ], 'LambdaAction' => [ 'base' => '

Describes an action to invoke a Lamdba function.

', 'refs' => [ 'Action$lambda' => '

Invoke a Lambda function.

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

The number of attached entities exceeds the limit.

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

The input for the ListCertificates operation.

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

The output of the ListCertificates operation.

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

The input for the ListPolicies operation.

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

The output from the ListPolicies operation.

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

The input for the ListPolicyVersions operation.

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

The output from the ListPolicyVersions operation.

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

The input for the ListPrincipalPolicies operation.

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

The output from the ListPrincipalPolicies operation.

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

The input for the ListPrincipalThings operation.

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

The output from the ListPrincipalThings operation.

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

The input for the ListThingPrincipal operation.

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

The output from the ListThingPrincipals operation.

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

The input for the ListThings operation.

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

The output from the ListThings operation.

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

The input for the ListTopicRules operation.

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

The output from the ListTopicRules operation.

', 'refs' => [], ], 'LogLevel' => [ 'base' => NULL, 'refs' => [ 'GetLoggingOptionsResponse$logLevel' => '

The logging level.

', 'LoggingOptionsPayload$logLevel' => '

The logging level.

', ], ], 'LoggingOptionsPayload' => [ 'base' => '

Describes the logging options payload.

', 'refs' => [ 'SetLoggingOptionsRequest$loggingOptionsPayload' => '

The logging options payload.

', ], ], 'MalformedPolicyException' => [ 'base' => '

The policy documentation is not valid.

', 'refs' => [], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'ListCertificatesRequest$marker' => '

The marker for the next set of results.

', 'ListCertificatesResponse$nextMarker' => '

The marker for the next set of results, or null if there are no additional results.

', 'ListPoliciesRequest$marker' => '

The marker for the next set of results.

', 'ListPoliciesResponse$nextMarker' => '

The marker for the next set of results, or null if there are no additional results.

', 'ListPrincipalPoliciesRequest$marker' => '

The marker for the next set of results.

', 'ListPrincipalPoliciesResponse$nextMarker' => '

The marker for the next set of results, or null if there are no additional results.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPrincipalThingsRequest$maxResults' => NULL, 'ListThingsRequest$maxResults' => '

The maximum number of results.

', 'ListTopicRulesRequest$maxResults' => '

The maximum number of results to return.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListPrincipalThingsRequest$nextToken' => NULL, 'ListPrincipalThingsResponse$nextToken' => '

A token used to retrieve the next value.

', 'ListThingsRequest$nextToken' => '

The token for the next value.

', 'ListThingsResponse$nextToken' => '

A token used to retrieve the next value.

', 'ListTopicRulesRequest$nextToken' => '

A token used to retrieve the next value.

', 'ListTopicRulesResponse$nextToken' => '

A token used to retrieve the next value.

', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'ListCertificatesRequest$pageSize' => '

The result page size.

', 'ListPoliciesRequest$pageSize' => '

The result page size.

', 'ListPrincipalPoliciesRequest$pageSize' => '

The result page size.

', ], ], 'PartitionKey' => [ 'base' => NULL, 'refs' => [ 'KinesisAction$partitionKey' => '

The partition key.

', ], ], 'PayloadField' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$payloadField' => '

The action payload.

', ], ], 'Policies' => [ 'base' => NULL, 'refs' => [ 'ListPoliciesResponse$policies' => '

The descriptions of the policies.

', 'ListPrincipalPoliciesResponse$policies' => '

The policies.

', ], ], 'Policy' => [ 'base' => '

Describes an AWS IoT policy.

', 'refs' => [ 'Policies$member' => NULL, ], ], 'PolicyArn' => [ 'base' => NULL, 'refs' => [ 'CreatePolicyResponse$policyArn' => '

The policy ARN.

', 'CreatePolicyVersionResponse$policyArn' => '

The policy ARN.

', 'GetPolicyResponse$policyArn' => '

The policy ARN.

', 'GetPolicyVersionResponse$policyArn' => '

The policy ARN.

', 'Policy$policyArn' => '

The policy ARN.

', ], ], 'PolicyDocument' => [ 'base' => NULL, 'refs' => [ 'CreatePolicyRequest$policyDocument' => '

The JSON document that describes the policy. The length of the policyDocument must be a minimum length of 1, with a maximum length of 2048, excluding whitespace.

', 'CreatePolicyResponse$policyDocument' => '

The JSON document that describes the policy.

', 'CreatePolicyVersionRequest$policyDocument' => '

The JSON document that describes the policy.

', 'CreatePolicyVersionResponse$policyDocument' => '

The JSON document that describes the policy.

', 'GetPolicyResponse$policyDocument' => '

The JSON document that describes the policy.

', 'GetPolicyVersionResponse$policyDocument' => '

The JSON document that describes the policy.

', ], ], 'PolicyName' => [ 'base' => NULL, 'refs' => [ 'AttachPrincipalPolicyRequest$policyName' => '

The policy name.

', 'CreatePolicyRequest$policyName' => '

The policy name.

', 'CreatePolicyResponse$policyName' => '

The policy name.

', 'CreatePolicyVersionRequest$policyName' => '

The policy name.

', 'DeletePolicyRequest$policyName' => '

The name of the policy to delete.

', 'DeletePolicyVersionRequest$policyName' => '

The name of the policy.

', 'DetachPrincipalPolicyRequest$policyName' => '

The name of the policy to detach.

', 'GetPolicyRequest$policyName' => '

The name of the policy.

', 'GetPolicyResponse$policyName' => '

The policy name.

', 'GetPolicyVersionRequest$policyName' => '

The name of the policy.

', 'GetPolicyVersionResponse$policyName' => '

The policy name.

', 'ListPolicyVersionsRequest$policyName' => '

The policy name.

', 'Policy$policyName' => '

The policy name.

', 'SetDefaultPolicyVersionRequest$policyName' => '

The policy name.

', ], ], 'PolicyVersion' => [ 'base' => '

Describes a policy version.

', 'refs' => [ 'PolicyVersions$member' => NULL, ], ], 'PolicyVersionId' => [ 'base' => NULL, 'refs' => [ 'CreatePolicyResponse$policyVersionId' => '

The policy version ID.

', 'CreatePolicyVersionResponse$policyVersionId' => '

The policy version ID.

', 'DeletePolicyVersionRequest$policyVersionId' => '

The policy version ID.

', 'GetPolicyResponse$defaultVersionId' => '

The default policy version ID.

', 'GetPolicyVersionRequest$policyVersionId' => '

The policy version ID.

', 'GetPolicyVersionResponse$policyVersionId' => '

The policy version ID.

', 'PolicyVersion$versionId' => '

The policy version ID.

', 'SetDefaultPolicyVersionRequest$policyVersionId' => '

The policy version ID.

', ], ], 'PolicyVersions' => [ 'base' => NULL, 'refs' => [ 'ListPolicyVersionsResponse$policyVersions' => '

The policy versions.

', ], ], 'Principal' => [ 'base' => NULL, 'refs' => [ 'AttachPrincipalPolicyRequest$principal' => '

The principal which can be a certificate ARN (as returned from the CreateCertificate operation] or a Cognito ID.

', 'AttachThingPrincipalRequest$principal' => '

The principal (certificate or other credential].

', 'DetachPrincipalPolicyRequest$principal' => '

The principal

If the principal is a certificate, specify the certificate ARN. If the principal is a Cognito identity specify the identity ID.

', 'DetachThingPrincipalRequest$principal' => '

The principal.

', 'ListPrincipalPoliciesRequest$principal' => '

The principal.

', 'ListPrincipalThingsRequest$principal' => '

The principal.

', ], ], 'PrincipalArn' => [ 'base' => NULL, 'refs' => [ 'Principals$member' => NULL, ], ], 'Principals' => [ 'base' => NULL, 'refs' => [ 'ListThingPrincipalsResponse$principals' => '

The principals.

', ], ], 'PrivateKey' => [ 'base' => NULL, 'refs' => [ 'KeyPair$PrivateKey' => '

The private key.

', ], ], 'PublicKey' => [ 'base' => NULL, 'refs' => [ 'KeyPair$PublicKey' => '

The public key.

', ], ], 'QueueUrl' => [ 'base' => NULL, 'refs' => [ 'SqsAction$queueUrl' => '

The URL of the Amazon SQS queue.

', ], ], 'RangeKeyField' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$rangeKeyField' => '

The range key name.

', ], ], 'RangeKeyValue' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$rangeKeyValue' => '

The range key value.

', ], ], 'RejectCertificateTransferRequest' => [ 'base' => '

The input for the RejectCertificateTransfer operation.

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

The input for the ReplaceTopicRule operation.

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

Describes an action to republish to another topic.

', 'refs' => [ 'Action$republish' => '

Publish to another MQTT topic.

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

The resource already exists.

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

The specified resource does not exist.

', 'refs' => [], ], 'RuleName' => [ 'base' => NULL, 'refs' => [ 'CreateTopicRuleRequest$ruleName' => '

The name of the rule.

', 'DeleteTopicRuleRequest$ruleName' => '

The name of the rule.

', 'GetTopicRuleRequest$ruleName' => '

The name of the rule.

', 'ReplaceTopicRuleRequest$ruleName' => '

The name of the rule.

', 'TopicRule$ruleName' => '

The name of the rule.

', 'TopicRuleListItem$ruleName' => '

The name of the rule.

', ], ], 'S3Action' => [ 'base' => '

Describes an action to write data to an Amazon S3 bucket.

', 'refs' => [ 'Action$s3' => '

Write to an S3 bucket.

', ], ], 'SQL' => [ 'base' => NULL, 'refs' => [ 'TopicRule$sql' => '

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters properly.

', 'TopicRulePayload$sql' => '

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.

', ], ], 'ServiceUnavailableException' => [ 'base' => '

The service is temporarily unavailable.

', 'refs' => [], ], 'SetAsActive' => [ 'base' => NULL, 'refs' => [ 'AcceptCertificateTransferRequest$setAsActive' => '

Specifies whether the certificate is active.

', 'CreateCertificateFromCsrRequest$setAsActive' => '

Specifies whether the certificate is active.

', 'CreateKeysAndCertificateRequest$setAsActive' => '

Specifies whether the certificate is active.

', ], ], 'SetAsDefault' => [ 'base' => NULL, 'refs' => [ 'CreatePolicyVersionRequest$setAsDefault' => '

Specifies whether the policy version is set as the default.

', ], ], 'SetDefaultPolicyVersionRequest' => [ 'base' => '

The input for the SetDefaultPolicyVersion operation.

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

The input for the SetLoggingOptions operation.

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

Describes an action to publish to an Amazon SNS topic.

', 'refs' => [ 'Action$sns' => '

Publish to an SNS topic.

', ], ], 'SqlParseException' => [ 'base' => '

The Rule-SQL expression can\'t be parsed correctly.

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

Describes an action to publish data to an SQS queue.

', 'refs' => [ 'Action$sqs' => '

Publish to an SQS queue.

', ], ], 'StreamName' => [ 'base' => NULL, 'refs' => [ 'KinesisAction$streamName' => '

The name of the Kinesis stream.

', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DynamoDBAction$tableName' => '

The name of the DynamoDB table.

', ], ], 'ThingArn' => [ 'base' => NULL, 'refs' => [ 'CreateThingResponse$thingArn' => '

The thing ARN.

', ], ], 'ThingAttribute' => [ 'base' => '

Describes a thing attribute.

', 'refs' => [ 'ThingAttributeList$member' => NULL, ], ], 'ThingAttributeList' => [ 'base' => NULL, 'refs' => [ 'ListThingsResponse$things' => '

The things.

', ], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'AttachThingPrincipalRequest$thingName' => '

The name of the thing.

', 'CreateThingRequest$thingName' => '

The name of the thing.

', 'CreateThingResponse$thingName' => '

The name of the thing.

', 'DeleteThingRequest$thingName' => '

The thing name.

', 'DescribeThingRequest$thingName' => '

The name of the thing.

', 'DescribeThingResponse$thingName' => '

The name of the thing.

', 'DetachThingPrincipalRequest$thingName' => '

The name of the thing.

', 'ListThingPrincipalsRequest$thingName' => '

The name of the thing.

', 'ThingAttribute$thingName' => '

The name of the thing.

', 'ThingNameList$member' => NULL, 'UpdateThingRequest$thingName' => '

The thing name.

', ], ], 'ThingNameList' => [ 'base' => NULL, 'refs' => [ 'ListPrincipalThingsResponse$things' => '

The things.

', ], ], 'ThrottlingException' => [ 'base' => '

The rate exceeds the limit.

', 'refs' => [], ], 'Topic' => [ 'base' => NULL, 'refs' => [ 'ListTopicRulesRequest$topic' => '

The topic.

', ], ], 'TopicPattern' => [ 'base' => NULL, 'refs' => [ 'RepublishAction$topic' => '

The name of the MQTT topic.

', 'TopicRuleListItem$topicPattern' => '

The pattern for the topic names that apply.

', ], ], 'TopicRule' => [ 'base' => '

Describes a rule.

', 'refs' => [ 'GetTopicRuleResponse$rule' => '

The rule.

', ], ], 'TopicRuleList' => [ 'base' => NULL, 'refs' => [ 'ListTopicRulesResponse$rules' => '

The rules.

', ], ], 'TopicRuleListItem' => [ 'base' => '

Describes a rule.

', 'refs' => [ 'TopicRuleList$member' => NULL, ], ], 'TopicRulePayload' => [ 'base' => '

Describes a rule.

', 'refs' => [ 'CreateTopicRuleRequest$topicRulePayload' => '

The rule payload.

', 'ReplaceTopicRuleRequest$topicRulePayload' => '

The rule payload.

', ], ], 'TransferAlreadyCompletedException' => [ 'base' => '

You can\'t revert the certificate transfer because it has already completed.

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

The input for the TransferCertificate operation.

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

The output from the TransferCertificate operation.

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

You can\'t transfer the the certificate because authorization policies are still attached.

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

You are not authorized to perform this operation.

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

The input for the UpdateCertificate operation.

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

The input for the UpdateThing operation.

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

The output from the UpdateThing operation.

', 'refs' => [], ], 'UseBase64' => [ 'base' => NULL, 'refs' => [ 'SqsAction$useBase64' => '

Specifies whether to use Base64 encoding.

', ], ], 'VersionsLimitExceededException' => [ 'base' => '

The number of policy versions exceeds the limit.

', 'refs' => [], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'CertificateStateException$message' => '

The message for the exception.

', 'DeleteConflictException$message' => '

The message for the exception.

', 'InternalException$message' => '

The message for the exception.

', 'InternalFailureException$message' => '

The message for the exception.

', 'InvalidRequestException$message' => '

The message for the exception.

', 'LimitExceededException$message' => '

The message for the exception.

', 'MalformedPolicyException$message' => '

The message for the exception.

', 'ResourceAlreadyExistsException$message' => '

The message for the exception.

', 'ResourceNotFoundException$message' => '

The message for the exception.

', 'ServiceUnavailableException$message' => '

The message for the exception.

', 'SqlParseException$message' => '

The message for the exception.

', 'ThrottlingException$message' => '

The message for the exception.

', 'TransferAlreadyCompletedException$message' => '

The message for the exception.

', 'TransferConflictException$message' => '

The message for the exception.

', 'UnauthorizedException$message' => '

The message for the exception.

', 'VersionsLimitExceededException$message' => '

The message for the exception.

', ], ], ],]; diff --git a/src/data/lambda/2015-03-31/api-2.json b/src/data/lambda/2015-03-31/api-2.json index fc4c882979..f2c30ec999 100644 --- a/src/data/lambda/2015-03-31/api-2.json +++ b/src/data/lambda/2015-03-31/api-2.json @@ -12,7 +12,7 @@ "name":"AddPermission", "http":{ "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions/HEAD/policy", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy", "responseCode":201 }, "input":{"shape":"AddPermissionRequest"}, @@ -50,6 +50,43 @@ } ] }, + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", + "responseCode":201 + }, + "input":{"shape":"CreateAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true + } + ] + }, "CreateEventSourceMapping":{ "name":"CreateEventSourceMapping", "http":{ @@ -124,6 +161,32 @@ } ] }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":204 + }, + "input":{"shape":"DeleteAliasRequest"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true + } + ] + }, "DeleteEventSourceMapping":{ "name":"DeleteEventSourceMapping", "http":{ @@ -175,6 +238,48 @@ "error":{"httpStatusCode":404}, "exception":true }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true + } + ] + }, + "GetAlias":{ + "name":"GetAlias", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":200 + }, + "input":{"shape":"GetAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, @@ -218,7 +323,7 @@ "name":"GetFunction", "http":{ "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions/HEAD", + "requestUri":"/2015-03-31/functions/{FunctionName}", "responseCode":200 }, "input":{"shape":"GetFunctionRequest"}, @@ -238,6 +343,11 @@ "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true } ] }, @@ -245,7 +355,7 @@ "name":"GetFunctionConfiguration", "http":{ "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions/HEAD/configuration", + "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", "responseCode":200 }, "input":{"shape":"GetFunctionConfigurationRequest"}, @@ -265,6 +375,11 @@ "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true } ] }, @@ -272,7 +387,7 @@ "name":"GetPolicy", "http":{ "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions/HEAD/policy", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy", "responseCode":200 }, "input":{"shape":"GetPolicyRequest"}, @@ -292,6 +407,11 @@ "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true } ] }, @@ -333,6 +453,11 @@ "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true } ] }, @@ -370,6 +495,38 @@ ], "deprecated":true }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", + "responseCode":200 + }, + "input":{"shape":"ListAliasesRequest"}, + "output":{"shape":"ListAliasesResponse"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true + } + ] + }, "ListEventSourceMappings":{ "name":"ListEventSourceMappings", "http":{ @@ -424,11 +581,80 @@ } ] }, + "ListVersionsByFunction":{ + "name":"ListVersionsByFunction", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/versions", + "responseCode":200 + }, + "input":{"shape":"ListVersionsByFunctionRequest"}, + "output":{"shape":"ListVersionsByFunctionResponse"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true + } + ] + }, + "PublishVersion":{ + "name":"PublishVersion", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/versions", + "responseCode":201 + }, + "input":{"shape":"PublishVersionRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"CodeStorageExceededException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, "RemovePermission":{ "name":"RemovePermission", "http":{ "method":"DELETE", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions/HEAD/policy/{StatementId}", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy/{StatementId}", "responseCode":204 }, "input":{"shape":"RemovePermissionRequest"}, @@ -443,6 +669,43 @@ "error":{"httpStatusCode":404}, "exception":true }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true + } + ] + }, + "UpdateAlias":{ + "name":"UpdateAlias", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":200 + }, + "input":{"shape":"UpdateAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, @@ -479,6 +742,11 @@ "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true } ] }, @@ -486,7 +754,7 @@ "name":"UpdateFunctionCode", "http":{ "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions/HEAD/code", + "requestUri":"/2015-03-31/functions/{FunctionName}/code", "responseCode":200 }, "input":{"shape":"UpdateFunctionCodeRequest"}, @@ -523,7 +791,7 @@ "name":"UpdateFunctionConfiguration", "http":{ "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions/HEAD/configuration", + "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", "responseCode":200 }, "input":{"shape":"UpdateFunctionConfigurationRequest"}, @@ -575,7 +843,12 @@ "Action":{"shape":"Action"}, "Principal":{"shape":"Principal"}, "SourceArn":{"shape":"Arn"}, - "SourceAccount":{"shape":"SourceOwner"} + "SourceAccount":{"shape":"SourceOwner"}, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } } }, "AddPermissionResponse":{ @@ -584,6 +857,25 @@ "Statement":{"shape":"String"} } }, + "Alias":{ + "type":"string", + "min":1, + "max":128, + "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_]+)" + }, + "AliasConfiguration":{ + "type":"structure", + "members":{ + "AliasArn":{"shape":"FunctionArn"}, + "Name":{"shape":"Alias"}, + "FunctionVersion":{"shape":"Version"}, + "Description":{"shape":"Description"} + } + }, + "AliasList":{ + "type":"list", + "member":{"shape":"AliasConfiguration"} + }, "Arn":{ "type":"string", "pattern":"arn:aws:([a-zA-Z0-9\\-])+:([a-z]{2}-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" @@ -598,6 +890,7 @@ "type":"blob", "streaming":true }, + "Boolean":{"type":"boolean"}, "CodeStorageExceededException":{ "type":"structure", "members":{ @@ -607,6 +900,24 @@ "error":{"httpStatusCode":400}, "exception":true }, + "CreateAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name", + "FunctionVersion" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{"shape":"Alias"}, + "FunctionVersion":{"shape":"Version"}, + "Description":{"shape":"Description"} + } + }, "CreateEventSourceMappingRequest":{ "type":"structure", "required":[ @@ -636,13 +947,33 @@ "Runtime":{"shape":"Runtime"}, "Role":{"shape":"RoleArn"}, "Handler":{"shape":"Handler"}, + "Code":{"shape":"FunctionCode"}, "Description":{"shape":"Description"}, "Timeout":{"shape":"Timeout"}, "MemorySize":{"shape":"MemorySize"}, - "Code":{"shape":"FunctionCode"} + "Publish":{"shape":"Boolean"} } }, "Date":{"type":"timestamp"}, + "DeleteAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "location":"uri", + "locationName":"Name" + } + } + }, "DeleteEventSourceMappingRequest":{ "type":"structure", "required":["UUID"], @@ -662,6 +993,11 @@ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" } } }, @@ -697,7 +1033,7 @@ }, "FunctionArn":{ "type":"string", - "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?" + "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" }, "FunctionCode":{ "type":"structure", @@ -727,7 +1063,9 @@ "Description":{"shape":"Description"}, "Timeout":{"shape":"Timeout"}, "MemorySize":{"shape":"MemorySize"}, - "LastModified":{"shape":"Timestamp"} + "LastModified":{"shape":"Timestamp"}, + "CodeSha256":{"shape":"String"}, + "Version":{"shape":"Version"} } }, "FunctionList":{ @@ -737,8 +1075,27 @@ "FunctionName":{ "type":"string", "min":1, - "max":111, - "pattern":"(arn:aws:lambda:)?([a-z]{2}-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)" + "max":140, + "pattern":"(arn:aws:lambda:)?([a-z]{2}-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "GetAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "location":"uri", + "locationName":"Name" + } + } }, "GetEventSourceMappingRequest":{ "type":"structure", @@ -759,6 +1116,11 @@ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" } } }, @@ -770,6 +1132,11 @@ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" } } }, @@ -788,7 +1155,8 @@ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName" - } + }, + "Qualifier":{"shape":"Qualifier"} } }, "GetPolicyResponse":{ @@ -846,7 +1214,12 @@ "location":"header", "locationName":"X-Amz-Client-Context" }, - "Payload":{"shape":"Blob"} + "Payload":{"shape":"Blob"}, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } }, "payload":"Payload" }, @@ -906,6 +1279,39 @@ }, "deprecated":true }, + "ListAliasesRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "FunctionVersion":{ + "shape":"Version", + "location":"querystring", + "locationName":"FunctionVersion" + }, + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListAliasesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "Aliases":{"shape":"AliasList"} + } + }, "ListEventSourceMappingsRequest":{ "type":"structure", "members":{ @@ -960,6 +1366,34 @@ "Functions":{"shape":"FunctionList"} } }, + "ListVersionsByFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListVersionsByFunctionResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "Versions":{"shape":"FunctionList"} + } + }, "LogType":{ "type":"string", "enum":[ @@ -991,6 +1425,25 @@ "type":"string", "pattern":".*" }, + "PublishVersionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "CodeSha256":{"shape":"String"}, + "Description":{"shape":"Description"} + } + }, + "Qualifier":{ + "type":"string", + "min":1, + "max":128, + "pattern":"(|[a-zA-Z0-9$_]+)" + }, "RemovePermissionRequest":{ "type":"structure", "required":[ @@ -1007,6 +1460,11 @@ "shape":"StatementId", "location":"uri", "locationName":"StatementId" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" } } }, @@ -1045,7 +1503,8 @@ "type":"string", "enum":[ "nodejs", - "java8" + "java8", + "python2.7" ] }, "S3Bucket":{ @@ -1086,8 +1545,7 @@ "String":{"type":"string"}, "Timeout":{ "type":"integer", - "min":1, - "max":60 + "min":1 }, "Timestamp":{"type":"string"}, "TooManyRequestsException":{ @@ -1113,6 +1571,27 @@ "error":{"httpStatusCode":415}, "exception":true }, + "UpdateAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "location":"uri", + "locationName":"Name" + }, + "FunctionVersion":{"shape":"Version"}, + "Description":{"shape":"Description"} + } + }, "UpdateEventSourceMappingRequest":{ "type":"structure", "required":["UUID"], @@ -1139,7 +1618,8 @@ "ZipFile":{"shape":"Blob"}, "S3Bucket":{"shape":"S3Bucket"}, "S3Key":{"shape":"S3Key"}, - "S3ObjectVersion":{"shape":"S3ObjectVersion"} + "S3ObjectVersion":{"shape":"S3ObjectVersion"}, + "Publish":{"shape":"Boolean"} } }, "UpdateFunctionConfigurationRequest":{ @@ -1157,6 +1637,12 @@ "Timeout":{"shape":"Timeout"}, "MemorySize":{"shape":"MemorySize"} } + }, + "Version":{ + "type":"string", + "min":1, + "max":1024, + "pattern":"(\\$LATEST|[0-9]+)" } } } diff --git a/src/data/lambda/2015-03-31/api-2.json.php b/src/data/lambda/2015-03-31/api-2.json.php index bcb55b8ac6..2d7f8aad14 100644 --- a/src/data/lambda/2015-03-31/api-2.json.php +++ b/src/data/lambda/2015-03-31/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2015-03-31', 'endpointPrefix' => 'lambda', 'serviceFullName' => 'AWS Lambda', 'signatureVersion' => 'v4', 'protocol' => 'rest-json', ], 'operations' => [ 'AddPermission' => [ 'name' => 'AddPermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions/HEAD/policy', 'responseCode' => 201, ], 'input' => [ 'shape' => 'AddPermissionRequest', ], 'output' => [ 'shape' => 'AddPermissionResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'PolicyLengthExceededException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'CreateEventSourceMapping' => [ 'name' => 'CreateEventSourceMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/event-source-mappings/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'CreateFunction' => [ 'name' => 'CreateFunction', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateFunctionRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'CodeStorageExceededException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'DeleteEventSourceMapping' => [ 'name' => 'DeleteEventSourceMapping', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-03-31/event-source-mappings/{UUID}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'DeleteFunction' => [ 'name' => 'DeleteFunction', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-03-31/functions/{FunctionName}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteFunctionRequest', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'GetEventSourceMapping' => [ 'name' => 'GetEventSourceMapping', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/event-source-mappings/{UUID}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'GetFunction' => [ 'name' => 'GetFunction', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions/HEAD', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionRequest', ], 'output' => [ 'shape' => 'GetFunctionResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'GetFunctionConfiguration' => [ 'name' => 'GetFunctionConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions/HEAD/configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionConfigurationRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'GetPolicy' => [ 'name' => 'GetPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions/HEAD/policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetPolicyRequest', ], 'output' => [ 'shape' => 'GetPolicyResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'Invoke' => [ 'name' => 'Invoke', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions/{FunctionName}/invocations', ], 'input' => [ 'shape' => 'InvocationRequest', ], 'output' => [ 'shape' => 'InvocationResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestContentException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'RequestTooLargeException', 'error' => [ 'httpStatusCode' => 413, ], 'exception' => true, ], [ 'shape' => 'UnsupportedMediaTypeException', 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'InvokeAsync' => [ 'name' => 'InvokeAsync', 'http' => [ 'method' => 'POST', 'requestUri' => '/2014-11-13/functions/{FunctionName}/invoke-async/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'InvokeAsyncRequest', 'deprecated' => true, ], 'output' => [ 'shape' => 'InvokeAsyncResponse', 'deprecated' => true, ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestContentException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], 'deprecated' => true, ], 'ListEventSourceMappings' => [ 'name' => 'ListEventSourceMappings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/event-source-mappings/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListEventSourceMappingsRequest', ], 'output' => [ 'shape' => 'ListEventSourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'ListFunctions' => [ 'name' => 'ListFunctions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFunctionsRequest', ], 'output' => [ 'shape' => 'ListFunctionsResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'RemovePermission' => [ 'name' => 'RemovePermission', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions/HEAD/policy/{StatementId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'RemovePermissionRequest', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'UpdateEventSourceMapping' => [ 'name' => 'UpdateEventSourceMapping', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-03-31/event-source-mappings/{UUID}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'UpdateFunctionCode' => [ 'name' => 'UpdateFunctionCode', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions/HEAD/code', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateFunctionCodeRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'CodeStorageExceededException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'UpdateFunctionConfiguration' => [ 'name' => 'UpdateFunctionConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions/HEAD/configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateFunctionConfigurationRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], ], 'shapes' => [ 'Action' => [ 'type' => 'string', 'pattern' => '(lambda:[*]|lambda:[a-zA-Z]+|[*]]', ], 'AddPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'StatementId', 'Action', 'Principal', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'StatementId' => [ 'shape' => 'StatementId', ], 'Action' => [ 'shape' => 'Action', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceArn' => [ 'shape' => 'Arn', ], 'SourceAccount' => [ 'shape' => 'SourceOwner', ], ], ], 'AddPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'Statement' => [ 'shape' => 'String', ], ], ], 'Arn' => [ 'type' => 'string', 'pattern' => 'arn:aws:([a-zA-Z0-9\\-]]+:([a-z]{2}-[a-z]+-\\d{1}]?:(\\d{12}]?:(.*]', ], 'BatchSize' => [ 'type' => 'integer', 'min' => 1, 'max' => 10000, ], 'Blob' => [ 'type' => 'blob', ], 'BlobStream' => [ 'type' => 'blob', 'streaming' => true, ], 'CodeStorageExceededException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'CreateEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'EventSourceArn', 'FunctionName', 'StartingPosition', ], 'members' => [ 'EventSourceArn' => [ 'shape' => 'Arn', ], 'FunctionName' => [ 'shape' => 'FunctionName', ], 'Enabled' => [ 'shape' => 'Enabled', ], 'BatchSize' => [ 'shape' => 'BatchSize', ], 'StartingPosition' => [ 'shape' => 'EventSourcePosition', ], ], ], 'CreateFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'Runtime', 'Role', 'Handler', 'Code', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', ], 'Runtime' => [ 'shape' => 'Runtime', ], 'Role' => [ 'shape' => 'RoleArn', ], 'Handler' => [ 'shape' => 'Handler', ], 'Description' => [ 'shape' => 'Description', ], 'Timeout' => [ 'shape' => 'Timeout', ], 'MemorySize' => [ 'shape' => 'MemorySize', ], 'Code' => [ 'shape' => 'FunctionCode', ], ], ], 'Date' => [ 'type' => 'timestamp', ], 'DeleteEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'UUID', ], 'members' => [ 'UUID' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'UUID', ], ], ], 'DeleteFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], ], ], 'Description' => [ 'type' => 'string', 'min' => 0, 'max' => 256, ], 'Enabled' => [ 'type' => 'boolean', ], 'EventSourceMappingConfiguration' => [ 'type' => 'structure', 'members' => [ 'UUID' => [ 'shape' => 'String', ], 'BatchSize' => [ 'shape' => 'BatchSize', ], 'EventSourceArn' => [ 'shape' => 'Arn', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', ], 'LastModified' => [ 'shape' => 'Date', ], 'LastProcessingResult' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'String', ], 'StateTransitionReason' => [ 'shape' => 'String', ], ], ], 'EventSourceMappingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSourceMappingConfiguration', ], ], 'EventSourcePosition' => [ 'type' => 'string', 'enum' => [ 'TRIM_HORIZON', 'LATEST', ], ], 'FunctionArn' => [ 'type' => 'string', 'pattern' => 'arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}]?', ], 'FunctionCode' => [ 'type' => 'structure', 'members' => [ 'ZipFile' => [ 'shape' => 'Blob', ], 'S3Bucket' => [ 'shape' => 'S3Bucket', ], 'S3Key' => [ 'shape' => 'S3Key', ], 'S3ObjectVersion' => [ 'shape' => 'S3ObjectVersion', ], ], ], 'FunctionCodeLocation' => [ 'type' => 'structure', 'members' => [ 'RepositoryType' => [ 'shape' => 'String', ], 'Location' => [ 'shape' => 'String', ], ], ], 'FunctionConfiguration' => [ 'type' => 'structure', 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', ], 'Runtime' => [ 'shape' => 'Runtime', ], 'Role' => [ 'shape' => 'RoleArn', ], 'Handler' => [ 'shape' => 'Handler', ], 'CodeSize' => [ 'shape' => 'Long', ], 'Description' => [ 'shape' => 'Description', ], 'Timeout' => [ 'shape' => 'Timeout', ], 'MemorySize' => [ 'shape' => 'MemorySize', ], 'LastModified' => [ 'shape' => 'Timestamp', ], ], ], 'FunctionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FunctionConfiguration', ], ], 'FunctionName' => [ 'type' => 'string', 'min' => 1, 'max' => 111, 'pattern' => '(arn:aws:lambda:]?([a-z]{2}-[a-z]+-\\d{1}:]?(\\d{12}:]?(function:]?([a-zA-Z0-9-_]+]', ], 'GetEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'UUID', ], 'members' => [ 'UUID' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'UUID', ], ], ], 'GetFunctionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], ], ], 'GetFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], ], ], 'GetFunctionResponse' => [ 'type' => 'structure', 'members' => [ 'Configuration' => [ 'shape' => 'FunctionConfiguration', ], 'Code' => [ 'shape' => 'FunctionCodeLocation', ], ], ], 'GetPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], ], ], 'GetPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'String', ], ], ], 'Handler' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[^\\s]+', ], 'HttpStatus' => [ 'type' => 'integer', ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestContentException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvocationRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'InvocationType' => [ 'shape' => 'InvocationType', 'location' => 'header', 'locationName' => 'X-Amz-Invocation-Type', ], 'LogType' => [ 'shape' => 'LogType', 'location' => 'header', 'locationName' => 'X-Amz-Log-Type', ], 'ClientContext' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'X-Amz-Client-Context', ], 'Payload' => [ 'shape' => 'Blob', ], ], 'payload' => 'Payload', ], 'InvocationResponse' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'Integer', 'location' => 'statusCode', ], 'FunctionError' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'X-Amz-Function-Error', ], 'LogResult' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'X-Amz-Log-Result', ], 'Payload' => [ 'shape' => 'Blob', ], ], 'payload' => 'Payload', ], 'InvocationType' => [ 'type' => 'string', 'enum' => [ 'Event', 'RequestResponse', 'DryRun', ], ], 'InvokeAsyncRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'InvokeArgs', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'InvokeArgs' => [ 'shape' => 'BlobStream', ], ], 'deprecated' => true, 'payload' => 'InvokeArgs', ], 'InvokeAsyncResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'HttpStatus', 'location' => 'statusCode', ], ], 'deprecated' => true, ], 'ListEventSourceMappingsRequest' => [ 'type' => 'structure', 'members' => [ 'EventSourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'EventSourceArn', ], 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'querystring', 'locationName' => 'FunctionName', ], 'Marker' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'Marker', ], 'MaxItems' => [ 'shape' => 'MaxListItems', 'location' => 'querystring', 'locationName' => 'MaxItems', ], ], ], 'ListEventSourceMappingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'String', ], 'EventSourceMappings' => [ 'shape' => 'EventSourceMappingsList', ], ], ], 'ListFunctionsRequest' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'Marker', ], 'MaxItems' => [ 'shape' => 'MaxListItems', 'location' => 'querystring', 'locationName' => 'MaxItems', ], ], ], 'ListFunctionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'String', ], 'Functions' => [ 'shape' => 'FunctionList', ], ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'None', 'Tail', ], ], 'Long' => [ 'type' => 'long', ], 'MaxListItems' => [ 'type' => 'integer', 'min' => 1, 'max' => 10000, ], 'MemorySize' => [ 'type' => 'integer', 'min' => 128, 'max' => 1536, ], 'PolicyLengthExceededException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'Principal' => [ 'type' => 'string', 'pattern' => '.*', ], 'RemovePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'StatementId', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'StatementId' => [ 'shape' => 'StatementId', 'location' => 'uri', 'locationName' => 'StatementId', ], ], ], 'RequestTooLargeException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 413, ], 'exception' => true, ], 'ResourceConflictException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'RoleArn' => [ 'type' => 'string', 'pattern' => 'arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+', ], 'Runtime' => [ 'type' => 'string', 'enum' => [ 'nodejs', 'java8', ], ], 'S3Bucket' => [ 'type' => 'string', 'min' => 3, 'max' => 63, 'pattern' => '^[0-9A-Za-z\\.\\-_]*(? [ 'type' => 'string', 'min' => 1, 'max' => 1024, ], 'S3ObjectVersion' => [ 'type' => 'string', 'min' => 1, 'max' => 1024, ], 'ServiceException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'SourceOwner' => [ 'type' => 'string', 'pattern' => '\\d{12}', ], 'StatementId' => [ 'type' => 'string', 'min' => 1, 'max' => 100, 'pattern' => '([a-zA-Z0-9-_]+]', ], 'String' => [ 'type' => 'string', ], 'Timeout' => [ 'type' => 'integer', 'min' => 1, 'max' => 60, ], 'Timestamp' => [ 'type' => 'string', ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'retryAfterSeconds' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'Retry-After', ], 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'UnsupportedMediaTypeException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], 'UpdateEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'UUID', ], 'members' => [ 'UUID' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'UUID', ], 'FunctionName' => [ 'shape' => 'FunctionName', ], 'Enabled' => [ 'shape' => 'Enabled', ], 'BatchSize' => [ 'shape' => 'BatchSize', ], ], ], 'UpdateFunctionCodeRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'ZipFile' => [ 'shape' => 'Blob', ], 'S3Bucket' => [ 'shape' => 'S3Bucket', ], 'S3Key' => [ 'shape' => 'S3Key', ], 'S3ObjectVersion' => [ 'shape' => 'S3ObjectVersion', ], ], ], 'UpdateFunctionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Role' => [ 'shape' => 'RoleArn', ], 'Handler' => [ 'shape' => 'Handler', ], 'Description' => [ 'shape' => 'Description', ], 'Timeout' => [ 'shape' => 'Timeout', ], 'MemorySize' => [ 'shape' => 'MemorySize', ], ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2015-03-31', 'endpointPrefix' => 'lambda', 'serviceFullName' => 'AWS Lambda', 'signatureVersion' => 'v4', 'protocol' => 'rest-json', ], 'operations' => [ 'AddPermission' => [ 'name' => 'AddPermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions/{FunctionName}/policy', 'responseCode' => 201, ], 'input' => [ 'shape' => 'AddPermissionRequest', ], 'output' => [ 'shape' => 'AddPermissionResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'PolicyLengthExceededException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'CreateAlias' => [ 'name' => 'CreateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions/{FunctionName}/aliases', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateAliasRequest', ], 'output' => [ 'shape' => 'AliasConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'CreateEventSourceMapping' => [ 'name' => 'CreateEventSourceMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/event-source-mappings/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'CreateEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'CreateFunction' => [ 'name' => 'CreateFunction', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions', 'responseCode' => 201, ], 'input' => [ 'shape' => 'CreateFunctionRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'CodeStorageExceededException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'DeleteAlias' => [ 'name' => 'DeleteAlias', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-03-31/functions/{FunctionName}/aliases/{Name}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteAliasRequest', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'DeleteEventSourceMapping' => [ 'name' => 'DeleteEventSourceMapping', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-03-31/event-source-mappings/{UUID}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'DeleteEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'DeleteFunction' => [ 'name' => 'DeleteFunction', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-03-31/functions/{FunctionName}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteFunctionRequest', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], ], ], 'GetAlias' => [ 'name' => 'GetAlias', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/aliases/{Name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAliasRequest', ], 'output' => [ 'shape' => 'AliasConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'GetEventSourceMapping' => [ 'name' => 'GetEventSourceMapping', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/event-source-mappings/{UUID}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'GetFunction' => [ 'name' => 'GetFunction', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionRequest', ], 'output' => [ 'shape' => 'GetFunctionResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'GetFunctionConfiguration' => [ 'name' => 'GetFunctionConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFunctionConfigurationRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'GetPolicy' => [ 'name' => 'GetPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/policy', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetPolicyRequest', ], 'output' => [ 'shape' => 'GetPolicyResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'Invoke' => [ 'name' => 'Invoke', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions/{FunctionName}/invocations', ], 'input' => [ 'shape' => 'InvocationRequest', ], 'output' => [ 'shape' => 'InvocationResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestContentException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'RequestTooLargeException', 'error' => [ 'httpStatusCode' => 413, ], 'exception' => true, ], [ 'shape' => 'UnsupportedMediaTypeException', 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'InvokeAsync' => [ 'name' => 'InvokeAsync', 'http' => [ 'method' => 'POST', 'requestUri' => '/2014-11-13/functions/{FunctionName}/invoke-async/', 'responseCode' => 202, ], 'input' => [ 'shape' => 'InvokeAsyncRequest', 'deprecated' => true, ], 'output' => [ 'shape' => 'InvokeAsyncResponse', 'deprecated' => true, ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidRequestContentException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], 'deprecated' => true, ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/aliases', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'ListEventSourceMappings' => [ 'name' => 'ListEventSourceMappings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/event-source-mappings/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListEventSourceMappingsRequest', ], 'output' => [ 'shape' => 'ListEventSourceMappingsResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'ListFunctions' => [ 'name' => 'ListFunctions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFunctionsRequest', ], 'output' => [ 'shape' => 'ListFunctionsResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'ListVersionsByFunction' => [ 'name' => 'ListVersionsByFunction', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListVersionsByFunctionRequest', ], 'output' => [ 'shape' => 'ListVersionsByFunctionResponse', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'PublishVersion' => [ 'name' => 'PublishVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-03-31/functions/{FunctionName}/versions', 'responseCode' => 201, ], 'input' => [ 'shape' => 'PublishVersionRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'CodeStorageExceededException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'RemovePermission' => [ 'name' => 'RemovePermission', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-03-31/functions/{FunctionName}/policy/{StatementId}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'RemovePermissionRequest', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'UpdateAlias' => [ 'name' => 'UpdateAlias', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-03-31/functions/{FunctionName}/aliases/{Name}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAliasRequest', ], 'output' => [ 'shape' => 'AliasConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], 'UpdateEventSourceMapping' => [ 'name' => 'UpdateEventSourceMapping', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-03-31/event-source-mappings/{UUID}', 'responseCode' => 202, ], 'input' => [ 'shape' => 'UpdateEventSourceMappingRequest', ], 'output' => [ 'shape' => 'EventSourceMappingConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'ResourceConflictException', 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], ], ], 'UpdateFunctionCode' => [ 'name' => 'UpdateFunctionCode', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-03-31/functions/{FunctionName}/code', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateFunctionCodeRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], [ 'shape' => 'CodeStorageExceededException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], ], ], 'UpdateFunctionConfiguration' => [ 'name' => 'UpdateFunctionConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-03-31/functions/{FunctionName}/configuration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateFunctionConfigurationRequest', ], 'output' => [ 'shape' => 'FunctionConfiguration', ], 'errors' => [ [ 'shape' => 'ServiceException', 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], [ 'shape' => 'ResourceNotFoundException', 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], [ 'shape' => 'InvalidParameterValueException', 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], [ 'shape' => 'TooManyRequestsException', 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], ], ], ], 'shapes' => [ 'Action' => [ 'type' => 'string', 'pattern' => '(lambda:[*]|lambda:[a-zA-Z]+|[*]]', ], 'AddPermissionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'StatementId', 'Action', 'Principal', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'StatementId' => [ 'shape' => 'StatementId', ], 'Action' => [ 'shape' => 'Action', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceArn' => [ 'shape' => 'Arn', ], 'SourceAccount' => [ 'shape' => 'SourceOwner', ], 'Qualifier' => [ 'shape' => 'Qualifier', 'location' => 'querystring', 'locationName' => 'Qualifier', ], ], ], 'AddPermissionResponse' => [ 'type' => 'structure', 'members' => [ 'Statement' => [ 'shape' => 'String', ], ], ], 'Alias' => [ 'type' => 'string', 'min' => 1, 'max' => 128, 'pattern' => '(?!^[0-9]+$]([a-zA-Z0-9-_]+]', ], 'AliasConfiguration' => [ 'type' => 'structure', 'members' => [ 'AliasArn' => [ 'shape' => 'FunctionArn', ], 'Name' => [ 'shape' => 'Alias', ], 'FunctionVersion' => [ 'shape' => 'Version', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'AliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AliasConfiguration', ], ], 'Arn' => [ 'type' => 'string', 'pattern' => 'arn:aws:([a-zA-Z0-9\\-]]+:([a-z]{2}-[a-z]+-\\d{1}]?:(\\d{12}]?:(.*]', ], 'BatchSize' => [ 'type' => 'integer', 'min' => 1, 'max' => 10000, ], 'Blob' => [ 'type' => 'blob', ], 'BlobStream' => [ 'type' => 'blob', 'streaming' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'CodeStorageExceededException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'CreateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'Name', 'FunctionVersion', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Name' => [ 'shape' => 'Alias', ], 'FunctionVersion' => [ 'shape' => 'Version', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'CreateEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'EventSourceArn', 'FunctionName', 'StartingPosition', ], 'members' => [ 'EventSourceArn' => [ 'shape' => 'Arn', ], 'FunctionName' => [ 'shape' => 'FunctionName', ], 'Enabled' => [ 'shape' => 'Enabled', ], 'BatchSize' => [ 'shape' => 'BatchSize', ], 'StartingPosition' => [ 'shape' => 'EventSourcePosition', ], ], ], 'CreateFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'Runtime', 'Role', 'Handler', 'Code', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', ], 'Runtime' => [ 'shape' => 'Runtime', ], 'Role' => [ 'shape' => 'RoleArn', ], 'Handler' => [ 'shape' => 'Handler', ], 'Code' => [ 'shape' => 'FunctionCode', ], 'Description' => [ 'shape' => 'Description', ], 'Timeout' => [ 'shape' => 'Timeout', ], 'MemorySize' => [ 'shape' => 'MemorySize', ], 'Publish' => [ 'shape' => 'Boolean', ], ], ], 'Date' => [ 'type' => 'timestamp', ], 'DeleteAliasRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'Name', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Name' => [ 'shape' => 'Alias', 'location' => 'uri', 'locationName' => 'Name', ], ], ], 'DeleteEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'UUID', ], 'members' => [ 'UUID' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'UUID', ], ], ], 'DeleteFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Qualifier' => [ 'shape' => 'Qualifier', 'location' => 'querystring', 'locationName' => 'Qualifier', ], ], ], 'Description' => [ 'type' => 'string', 'min' => 0, 'max' => 256, ], 'Enabled' => [ 'type' => 'boolean', ], 'EventSourceMappingConfiguration' => [ 'type' => 'structure', 'members' => [ 'UUID' => [ 'shape' => 'String', ], 'BatchSize' => [ 'shape' => 'BatchSize', ], 'EventSourceArn' => [ 'shape' => 'Arn', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', ], 'LastModified' => [ 'shape' => 'Date', ], 'LastProcessingResult' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'String', ], 'StateTransitionReason' => [ 'shape' => 'String', ], ], ], 'EventSourceMappingsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSourceMappingConfiguration', ], ], 'EventSourcePosition' => [ 'type' => 'string', 'enum' => [ 'TRIM_HORIZON', 'LATEST', ], ], 'FunctionArn' => [ 'type' => 'string', 'pattern' => 'arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+]]?', ], 'FunctionCode' => [ 'type' => 'structure', 'members' => [ 'ZipFile' => [ 'shape' => 'Blob', ], 'S3Bucket' => [ 'shape' => 'S3Bucket', ], 'S3Key' => [ 'shape' => 'S3Key', ], 'S3ObjectVersion' => [ 'shape' => 'S3ObjectVersion', ], ], ], 'FunctionCodeLocation' => [ 'type' => 'structure', 'members' => [ 'RepositoryType' => [ 'shape' => 'String', ], 'Location' => [ 'shape' => 'String', ], ], ], 'FunctionConfiguration' => [ 'type' => 'structure', 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', ], 'Runtime' => [ 'shape' => 'Runtime', ], 'Role' => [ 'shape' => 'RoleArn', ], 'Handler' => [ 'shape' => 'Handler', ], 'CodeSize' => [ 'shape' => 'Long', ], 'Description' => [ 'shape' => 'Description', ], 'Timeout' => [ 'shape' => 'Timeout', ], 'MemorySize' => [ 'shape' => 'MemorySize', ], 'LastModified' => [ 'shape' => 'Timestamp', ], 'CodeSha256' => [ 'shape' => 'String', ], 'Version' => [ 'shape' => 'Version', ], ], ], 'FunctionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FunctionConfiguration', ], ], 'FunctionName' => [ 'type' => 'string', 'min' => 1, 'max' => 140, 'pattern' => '(arn:aws:lambda:]?([a-z]{2}-[a-z]+-\\d{1}:]?(\\d{12}:]?(function:]?([a-zA-Z0-9-_]+](:(\\$LATEST|[a-zA-Z0-9-_]+]]?', ], 'GetAliasRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'Name', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Name' => [ 'shape' => 'Alias', 'location' => 'uri', 'locationName' => 'Name', ], ], ], 'GetEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'UUID', ], 'members' => [ 'UUID' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'UUID', ], ], ], 'GetFunctionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Qualifier' => [ 'shape' => 'Qualifier', 'location' => 'querystring', 'locationName' => 'Qualifier', ], ], ], 'GetFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Qualifier' => [ 'shape' => 'Qualifier', 'location' => 'querystring', 'locationName' => 'Qualifier', ], ], ], 'GetFunctionResponse' => [ 'type' => 'structure', 'members' => [ 'Configuration' => [ 'shape' => 'FunctionConfiguration', ], 'Code' => [ 'shape' => 'FunctionCodeLocation', ], ], ], 'GetPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Qualifier' => [ 'shape' => 'Qualifier', ], ], ], 'GetPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'String', ], ], ], 'Handler' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[^\\s]+', ], 'HttpStatus' => [ 'type' => 'integer', ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestContentException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvocationRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'InvocationType' => [ 'shape' => 'InvocationType', 'location' => 'header', 'locationName' => 'X-Amz-Invocation-Type', ], 'LogType' => [ 'shape' => 'LogType', 'location' => 'header', 'locationName' => 'X-Amz-Log-Type', ], 'ClientContext' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'X-Amz-Client-Context', ], 'Payload' => [ 'shape' => 'Blob', ], 'Qualifier' => [ 'shape' => 'Qualifier', 'location' => 'querystring', 'locationName' => 'Qualifier', ], ], 'payload' => 'Payload', ], 'InvocationResponse' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'Integer', 'location' => 'statusCode', ], 'FunctionError' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'X-Amz-Function-Error', ], 'LogResult' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'X-Amz-Log-Result', ], 'Payload' => [ 'shape' => 'Blob', ], ], 'payload' => 'Payload', ], 'InvocationType' => [ 'type' => 'string', 'enum' => [ 'Event', 'RequestResponse', 'DryRun', ], ], 'InvokeAsyncRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'InvokeArgs', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'InvokeArgs' => [ 'shape' => 'BlobStream', ], ], 'deprecated' => true, 'payload' => 'InvokeArgs', ], 'InvokeAsyncResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'HttpStatus', 'location' => 'statusCode', ], ], 'deprecated' => true, ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'FunctionVersion' => [ 'shape' => 'Version', 'location' => 'querystring', 'locationName' => 'FunctionVersion', ], 'Marker' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'Marker', ], 'MaxItems' => [ 'shape' => 'MaxListItems', 'location' => 'querystring', 'locationName' => 'MaxItems', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'String', ], 'Aliases' => [ 'shape' => 'AliasList', ], ], ], 'ListEventSourceMappingsRequest' => [ 'type' => 'structure', 'members' => [ 'EventSourceArn' => [ 'shape' => 'Arn', 'location' => 'querystring', 'locationName' => 'EventSourceArn', ], 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'querystring', 'locationName' => 'FunctionName', ], 'Marker' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'Marker', ], 'MaxItems' => [ 'shape' => 'MaxListItems', 'location' => 'querystring', 'locationName' => 'MaxItems', ], ], ], 'ListEventSourceMappingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'String', ], 'EventSourceMappings' => [ 'shape' => 'EventSourceMappingsList', ], ], ], 'ListFunctionsRequest' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'Marker', ], 'MaxItems' => [ 'shape' => 'MaxListItems', 'location' => 'querystring', 'locationName' => 'MaxItems', ], ], ], 'ListFunctionsResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'String', ], 'Functions' => [ 'shape' => 'FunctionList', ], ], ], 'ListVersionsByFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Marker' => [ 'shape' => 'String', 'location' => 'querystring', 'locationName' => 'Marker', ], 'MaxItems' => [ 'shape' => 'MaxListItems', 'location' => 'querystring', 'locationName' => 'MaxItems', ], ], ], 'ListVersionsByFunctionResponse' => [ 'type' => 'structure', 'members' => [ 'NextMarker' => [ 'shape' => 'String', ], 'Versions' => [ 'shape' => 'FunctionList', ], ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'None', 'Tail', ], ], 'Long' => [ 'type' => 'long', ], 'MaxListItems' => [ 'type' => 'integer', 'min' => 1, 'max' => 10000, ], 'MemorySize' => [ 'type' => 'integer', 'min' => 128, 'max' => 1536, ], 'PolicyLengthExceededException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'Principal' => [ 'type' => 'string', 'pattern' => '.*', ], 'PublishVersionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'CodeSha256' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'Qualifier' => [ 'type' => 'string', 'min' => 1, 'max' => 128, 'pattern' => '(|[a-zA-Z0-9$_]+]', ], 'RemovePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'StatementId', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'StatementId' => [ 'shape' => 'StatementId', 'location' => 'uri', 'locationName' => 'StatementId', ], 'Qualifier' => [ 'shape' => 'Qualifier', 'location' => 'querystring', 'locationName' => 'Qualifier', ], ], ], 'RequestTooLargeException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 413, ], 'exception' => true, ], 'ResourceConflictException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'RoleArn' => [ 'type' => 'string', 'pattern' => 'arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+', ], 'Runtime' => [ 'type' => 'string', 'enum' => [ 'nodejs', 'java8', 'python2.7', ], ], 'S3Bucket' => [ 'type' => 'string', 'min' => 3, 'max' => 63, 'pattern' => '^[0-9A-Za-z\\.\\-_]*(? [ 'type' => 'string', 'min' => 1, 'max' => 1024, ], 'S3ObjectVersion' => [ 'type' => 'string', 'min' => 1, 'max' => 1024, ], 'ServiceException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'SourceOwner' => [ 'type' => 'string', 'pattern' => '\\d{12}', ], 'StatementId' => [ 'type' => 'string', 'min' => 1, 'max' => 100, 'pattern' => '([a-zA-Z0-9-_]+]', ], 'String' => [ 'type' => 'string', ], 'Timeout' => [ 'type' => 'integer', 'min' => 1, ], 'Timestamp' => [ 'type' => 'string', ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'retryAfterSeconds' => [ 'shape' => 'String', 'location' => 'header', 'locationName' => 'Retry-After', ], 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'UnsupportedMediaTypeException' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], 'UpdateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', 'Name', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Name' => [ 'shape' => 'Alias', 'location' => 'uri', 'locationName' => 'Name', ], 'FunctionVersion' => [ 'shape' => 'Version', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'UpdateEventSourceMappingRequest' => [ 'type' => 'structure', 'required' => [ 'UUID', ], 'members' => [ 'UUID' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'UUID', ], 'FunctionName' => [ 'shape' => 'FunctionName', ], 'Enabled' => [ 'shape' => 'Enabled', ], 'BatchSize' => [ 'shape' => 'BatchSize', ], ], ], 'UpdateFunctionCodeRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'ZipFile' => [ 'shape' => 'Blob', ], 'S3Bucket' => [ 'shape' => 'S3Bucket', ], 'S3Key' => [ 'shape' => 'S3Key', ], 'S3ObjectVersion' => [ 'shape' => 'S3ObjectVersion', ], 'Publish' => [ 'shape' => 'Boolean', ], ], ], 'UpdateFunctionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'FunctionName', ], 'members' => [ 'FunctionName' => [ 'shape' => 'FunctionName', 'location' => 'uri', 'locationName' => 'FunctionName', ], 'Role' => [ 'shape' => 'RoleArn', ], 'Handler' => [ 'shape' => 'Handler', ], 'Description' => [ 'shape' => 'Description', ], 'Timeout' => [ 'shape' => 'Timeout', ], 'MemorySize' => [ 'shape' => 'MemorySize', ], ], ], 'Version' => [ 'type' => 'string', 'min' => 1, 'max' => 1024, 'pattern' => '(\\$LATEST|[0-9]+]', ], ],]; diff --git a/src/data/lambda/2015-03-31/docs-2.json b/src/data/lambda/2015-03-31/docs-2.json index e3e5f304cc..2d7b7e6714 100644 --- a/src/data/lambda/2015-03-31/docs-2.json +++ b/src/data/lambda/2015-03-31/docs-2.json @@ -1,20 +1,27 @@ { "version": "2.0", "operations": { - "AddPermission": "

Adds a permission to the access policy associated with the specified AWS Lambda function. In a \"push event\" model, the access policy attached to the Lambda function grants Amazon S3 or a user application permission for the Lambda lambda:Invoke action. For information about the push model, see AWS Lambda: How it Works. Each Lambda function has one access policy associated with it. You can use the AddPermission API to add a permission to the policy. You have one access policy but it can have multiple permission statements.

This operation requires permission for the lambda:AddPermission action.

", + "AddPermission": "

Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use \"push\" model. In \"push\" model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.

For information about the push model, see AWS Lambda: How it Works.

If you are using versioning feature (see AWS Lambda Function Versioning and Aliases), a Lambda function can have multiple ARNs that can be used to invoke the function. Note that, each permission you add to resource policy using this API is specific to an ARN, specified using the Qualifier parameter

This operation requires permission for the lambda:AddPermission action.

", + "CreateAlias": "

Creates an alias to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:CreateAlias action.

", "CreateEventSourceMapping": "

Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and a Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which Lambda function to invoke) for the event source mapping in the request body.

Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.

This operation requires permission for the lambda:CreateEventSourceMapping action.

", "CreateFunction": "

Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.

This operation requires permission for the lambda:CreateFunction action.

", + "DeleteAlias": "

Deletes specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:DeleteAlias action.

", "DeleteEventSourceMapping": "

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:DeleteEventSourceMapping action.

", - "DeleteFunction": "

Deletes the specified Lambda function code and configuration.

When you delete a function the associated access policy is also deleted. You will need to delete the event source mappings explicitly.

This operation requires permission for the lambda:DeleteFunction action.

", + "DeleteFunction": "

Deletes the specified Lambda function code and configuration.

If you don't specify a function version, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions.

When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.

For information about function versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:DeleteFunction action.

", + "GetAlias": "

Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:GetAlias action.

", "GetEventSourceMapping": "

Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).

This operation requires permission for the lambda:GetEventSourceMapping action.

", - "GetFunction": "

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

This operation requires permission for the lambda:GetFunction action.

", - "GetFunctionConfiguration": "

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

", - "GetPolicy": "

Returns the access policy, containing a list of permissions granted via the AddPermission API, associated with the specified bucket.

You need permission for the lambda:GetPolicy action.

", - "Invoke": "

Invokes a specified Lambda function.

This operation requires permission for the lambda:InvokeFunction action.

", + "GetFunction": "

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunction action.

", + "GetFunctionConfiguration": "

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

You can use the optional Qualifier parameter to retrieve configuration information for a specific Lambda function version. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

", + "GetPolicy": "

Returns the resource policy, containing a list of permissions that apply to a specific to an ARN that you specify via the Qualifier paramter.

For informration about adding permissions, see AddPermission.

You need permission for the lambda:GetPolicy action.

", + "Invoke": "

Invokes a specific Lambda function version.

If you don't provide the Qualifier parameter, it uses the unqualified function ARN which results in invocation of the $LATEST version of the Lambda function (when you create a Lambda function, the $LATEST is the version). The AWS Lambda versioning and aliases feature allows you to publish multiple versions of a Lambda function and also create aliases for each function version. So each your Lambda function version can be invoked using multiple ARNs. For more information, see AWS Lambda Function Versioning and Aliases. Using the Qualifier parameter, you can specify a function version or alias name to invoke specific function version. If you specify function version, the API uses the qualified function ARN to invoke a specific function version. If you specify alias name, the API uses the alias ARN to invoke the function version to which the alias points.

This operation requires permission for the lambda:InvokeFunction action.

", "InvokeAsync": "This API is deprecated. We recommend you use Invoke API (see Invoke).

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.

This operation requires permission for the lambda:InvokeFunction action.

", + "ListAliases": "

Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:ListAliases action.

", "ListEventSourceMappings": "

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping), where you identify a stream as an event source. This list does not include Amazon S3 event sources.

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSourceMappings action.

", "ListFunctions": "

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

", - "RemovePermission": "

You can remove individual permissions from an access policy associated with a Lambda function by providing a Statement ID.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

", + "ListVersionsByFunction": "

List all versions of a function.

", + "PublishVersion": "

Publishes a version of your function from the current snapshot of HEAD. That is, AWS Lambda takes a snapshot of the function code and configuration information from HEAD and publishes a new version. The code and handler of this specific Lambda function version cannot be modified after publication, but you can modify the configuration information.

", + "RemovePermission": "

You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you addded the permission. The API removes corresponding permission that is associated with the specific ARN identified by the Qualifier parameter.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

", + "UpdateAlias": "

Using this API you can update function version to which the alias points to and alias description. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:UpdateAlias action.

", "UpdateEventSourceMapping": "

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

", "UpdateFunctionCode": "

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

This operation requires permission for the lambda:UpdateFunctionCode action.

", "UpdateFunctionConfiguration": "

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

" @@ -37,6 +44,28 @@ "refs": { } }, + "Alias": { + "base": null, + "refs": { + "AliasConfiguration$Name": "

Alias name.

", + "CreateAliasRequest$Name": "

Name for the alias your creating.

", + "DeleteAliasRequest$Name": "

Name of the alias to delete.

", + "GetAliasRequest$Name": "

Name of the alias for which you want to retrieve information.

", + "UpdateAliasRequest$Name": "

The alias name.

" + } + }, + "AliasConfiguration": { + "base": "

Provides configuration information about a Lambda function version alias.

", + "refs": { + "AliasList$member": null + } + }, + "AliasList": { + "base": null, + "refs": { + "ListAliasesResponse$Aliases": "

An list of alises.

" + } + }, "Arn": { "base": null, "refs": { @@ -69,7 +98,19 @@ "InvokeAsyncRequest$InvokeArgs": "

JSON that you want to provide to your Lambda function as input.

" } }, + "Boolean": { + "base": null, + "refs": { + "CreateFunctionRequest$Publish": "

This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.

", + "UpdateFunctionCodeRequest$Publish": "

This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.

" + } + }, "CodeStorageExceededException": { + "base": "

You have exceeded your maximum total code size per account. Limits

", + "refs": { + } + }, + "CreateAliasRequest": { "base": null, "refs": { } @@ -90,6 +131,11 @@ "EventSourceMappingConfiguration$LastModified": "

The UTC time string indicating the last time the event mapping was updated.

" } }, + "DeleteAliasRequest": { + "base": null, + "refs": { + } + }, "DeleteEventSourceMappingRequest": { "base": null, "refs": { @@ -103,15 +149,19 @@ "Description": { "base": null, "refs": { + "AliasConfiguration$Description": "

Alias description.

", + "CreateAliasRequest$Description": "

Description of the alias.

", "CreateFunctionRequest$Description": "

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

", "FunctionConfiguration$Description": "

The user-provided description.

", + "PublishVersionRequest$Description": "

The description for the version you are publishing. If not provided, AWS Lambda copies the description from the HEAD version.

", + "UpdateAliasRequest$Description": "

You can optionally change the description of the alias using this parameter.

", "UpdateFunctionConfigurationRequest$Description": "

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

" } }, "Enabled": { "base": null, "refs": { - "CreateEventSourceMappingRequest$Enabled": "

Indicates whether AWS Lambda should begin polling the event source, the default is not enabled.

", + "CreateEventSourceMappingRequest$Enabled": "

Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.

", "UpdateEventSourceMappingRequest$Enabled": "

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

" } }, @@ -136,6 +186,7 @@ "FunctionArn": { "base": null, "refs": { + "AliasConfiguration$AliasArn": "

Lambda function ARN that is qualified using alias name as the suffix. For example, if you create an alias \"BETA\" pointing to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

", "EventSourceMappingConfiguration$FunctionArn": "

The Lambda function to invoke when AWS Lambda detects an event on the stream.

", "FunctionConfiguration$FunctionArn": "

The Amazon Resource Name (ARN) assigned to the function.

" } @@ -162,29 +213,42 @@ "FunctionList": { "base": null, "refs": { - "ListFunctionsResponse$Functions": "

A list of Lambda functions.

" + "ListFunctionsResponse$Functions": "

A list of Lambda functions.

", + "ListVersionsByFunctionResponse$Versions": "

A list of Lambda function versions.

" } }, "FunctionName": { "base": null, "refs": { - "AddPermissionRequest$FunctionName": "

Name of the Lambda function whose access policy you are updating by adding a new permission.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", + "AddPermissionRequest$FunctionName": "

Name of the Lambda function whose resource policy you are updating by adding a new permission.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", + "CreateAliasRequest$FunctionName": "

Name of the Lambda function for which you want to create an alias.

", "CreateEventSourceMappingRequest$FunctionName": "

The Lambda function to invoke when AWS Lambda detects an event on the stream.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "CreateFunctionRequest$FunctionName": "

The name you want to assign to the function you are uploading. You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as Invoke.

", + "DeleteAliasRequest$FunctionName": "

The Lambda function name for which the alias is created.

", "DeleteFunctionRequest$FunctionName": "

The Lambda function to delete.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "FunctionConfiguration$FunctionName": "

The name of the function.

", + "GetAliasRequest$FunctionName": "

Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function. So you must specify the function name.

", "GetFunctionConfigurationRequest$FunctionName": "

The name of the Lambda function for which you want to retrieve the configuration information.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "GetFunctionRequest$FunctionName": "

The Lambda function name.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", - "GetPolicyRequest$FunctionName": "

Function name whose access policy you want to retrieve.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", + "GetPolicyRequest$FunctionName": "

Function name whose resource policy you want to retrieve.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "InvocationRequest$FunctionName": "

The Lambda function name.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "InvokeAsyncRequest$FunctionName": "

The Lambda function name.

", + "ListAliasesRequest$FunctionName": "

Lambda function name for which the alias is created.

", "ListEventSourceMappingsRequest$FunctionName": "

The name of the Lambda function.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", - "RemovePermissionRequest$FunctionName": "

Lambda function whose access policy you want to remove a permission from.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", + "ListVersionsByFunctionRequest$FunctionName": "

Function name whose versions to list. You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", + "PublishVersionRequest$FunctionName": "

The Lambda function name. You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", + "RemovePermissionRequest$FunctionName": "

Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", + "UpdateAliasRequest$FunctionName": "

The function name for which the alias is created.

", "UpdateEventSourceMappingRequest$FunctionName": "

The Lambda function to which you want the stream records sent.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "UpdateFunctionCodeRequest$FunctionName": "

The existing Lambda function name whose code you want to replace.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "UpdateFunctionConfigurationRequest$FunctionName": "

The name of the Lambda function.

You can specify an unqualified function name (for example, \"Thumbnail\") or you can specify Amazon Resource Name (ARN) of the function (for example, \"arn:aws:lambda:us-west-2:account-id:function:ThumbNail\"). AWS Lambda also allows you to specify only the account ID qualifier (for example, \"account-id:Thumbnail\"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

" } }, + "GetAliasRequest": { + "base": null, + "refs": { + } + }, "GetEventSourceMappingRequest": { "base": null, "refs": { @@ -271,6 +335,16 @@ "refs": { } }, + "ListAliasesRequest": { + "base": null, + "refs": { + } + }, + "ListAliasesResponse": { + "base": null, + "refs": { + } + }, "ListEventSourceMappingsRequest": { "base": null, "refs": { @@ -291,6 +365,16 @@ "refs": { } }, + "ListVersionsByFunctionRequest": { + "base": null, + "refs": { + } + }, + "ListVersionsByFunctionResponse": { + "base": null, + "refs": { + } + }, "LogType": { "base": null, "refs": { @@ -306,8 +390,10 @@ "MaxListItems": { "base": null, "refs": { + "ListAliasesRequest$MaxItems": "

Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.

", "ListEventSourceMappingsRequest$MaxItems": "

Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

", - "ListFunctionsRequest$MaxItems": "

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

" + "ListFunctionsRequest$MaxItems": "

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

", + "ListVersionsByFunctionRequest$MaxItems": "

Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.

" } }, "MemorySize": { @@ -329,13 +415,30 @@ "AddPermissionRequest$Principal": "

The principal who is getting this permission. It can be Amazon S3 service Principal (\"s3.amazonaws.com\") if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as \"sns.amazonaws.com\". For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.

" } }, + "PublishVersionRequest": { + "base": null, + "refs": { + } + }, + "Qualifier": { + "base": null, + "refs": { + "AddPermissionRequest$Qualifier": "

You can specify this optional query parameter to specify function version or alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:2

If you specify alias name, for example \"PROD\", then the permission is valid only for requests made using the alias ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:PROD

If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.

arn:aws:lambda:aws-region:acct-id:function:function-name

", + "DeleteFunctionRequest$Qualifier": "

Using this optional parameter you can specify a function version (but not the $LATEST version) to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the $LATEST, that is, you cannot specify $LATEST as the value of this parameter. The $LATEST version can be deleted only when you want to delete all the function versions and aliases.

You can only specify a function version and not alias name using this parameter. You cannot delete a function version using its alias.

If you don't specify this parameter, AWS Lambda will delete the function, including all its versions and aliases.

", + "GetFunctionConfigurationRequest$Qualifier": "

Using this optional parameter you can specify function version or alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. if you specify alias name, the API uses alias ARN and returns information about the function version to which the alias points.

If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.

", + "GetFunctionRequest$Qualifier": "

Using this optional parameter to specify a function version or alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify alias name, the API uses alias ARN and returns information about the function version to which the alias points. If you don't provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function.

", + "GetPolicyRequest$Qualifier": "

You can specify this optional query parameter to specify function version or alias name in which case this API will return all permissions associated with the specific ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.

", + "InvocationRequest$Qualifier": "

You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

", + "RemovePermissionRequest$Qualifier": "

You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

" + } + }, "RemovePermissionRequest": { "base": null, "refs": { } }, "RequestTooLargeException": { - "base": null, + "base": "

The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits

", "refs": { } }, @@ -416,8 +519,9 @@ "EventSourceMappingConfiguration$StateTransitionReason": "

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

", "FunctionCodeLocation$RepositoryType": "

The repository from which you can download the function.

", "FunctionCodeLocation$Location": "

The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

", + "FunctionConfiguration$CodeSha256": "

It is the SHA256 hash of your function deployment package.

", "GetEventSourceMappingRequest$UUID": "

The AWS Lambda assigned ID of the event source mapping.

", - "GetPolicyResponse$Policy": "

The access policy associated with the specified function. The response returns the same as a string using \"\\\" as an escape character in the JSON.

", + "GetPolicyResponse$Policy": "

The resource policy associated with the specified function. The response returns the same as a string using \"\\\" as an escape character in the JSON.

", "InvalidParameterValueException$Type": null, "InvalidParameterValueException$message": null, "InvalidRequestContentException$Type": null, @@ -425,12 +529,17 @@ "InvocationRequest$ClientContext": "

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

", "InvocationResponse$FunctionError": "

Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.

", "InvocationResponse$LogResult": "

It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is \"RequestResponse\" and the logs were requested.

", + "ListAliasesRequest$Marker": "

Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing.

", + "ListAliasesResponse$NextMarker": "

A string, present if there are more aliases.

", "ListEventSourceMappingsRequest$Marker": "

Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off.

", "ListEventSourceMappingsResponse$NextMarker": "

A string, present if there are more event source mappings.

", "ListFunctionsRequest$Marker": "

Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

", "ListFunctionsResponse$NextMarker": "

A string, present if there are more functions.

", + "ListVersionsByFunctionRequest$Marker": "

Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing.

", + "ListVersionsByFunctionResponse$NextMarker": "

A string, present if there are more function versions.

", "PolicyLengthExceededException$Type": null, "PolicyLengthExceededException$message": null, + "PublishVersionRequest$CodeSha256": "

The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the HEAD version for the publication to succeed.

", "RequestTooLargeException$Type": null, "RequestTooLargeException$message": null, "ResourceConflictException$Type": null, @@ -467,6 +576,11 @@ } }, "UnsupportedMediaTypeException": { + "base": "

The content type of the Invoke request body is not JSON.

", + "refs": { + } + }, + "UpdateAliasRequest": { "base": null, "refs": { } @@ -485,6 +599,16 @@ "base": null, "refs": { } + }, + "Version": { + "base": null, + "refs": { + "AliasConfiguration$FunctionVersion": "

Function version to which the alias points.

", + "CreateAliasRequest$FunctionVersion": "

Lambda function version for which you are creating the alias.

", + "FunctionConfiguration$Version": "

The version of the Lambda function.

", + "ListAliasesRequest$FunctionVersion": "

If you specify this optional parameter, the API returns only the aliases pointing to the specific Lambda function version, otherwise returns all aliases created for the Lambda function.

", + "UpdateAliasRequest$FunctionVersion": "

Using this parameter you can optionally change the Lambda function version to which the alias to points to.

" + } } } } diff --git a/src/data/lambda/2015-03-31/docs-2.json.php b/src/data/lambda/2015-03-31/docs-2.json.php index f1d3fa1a2d..389f5ecda4 100644 --- a/src/data/lambda/2015-03-31/docs-2.json.php +++ b/src/data/lambda/2015-03-31/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'operations' => [ 'AddPermission' => '

Adds a permission to the access policy associated with the specified AWS Lambda function. In a "push event" model, the access policy attached to the Lambda function grants Amazon S3 or a user application permission for the Lambda lambda:Invoke action. For information about the push model, see AWS Lambda: How it Works. Each Lambda function has one access policy associated with it. You can use the AddPermission API to add a permission to the policy. You have one access policy but it can have multiple permission statements.

This operation requires permission for the lambda:AddPermission action.

', 'CreateEventSourceMapping' => '

Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and a Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which Lambda function to invoke] for the event source mapping in the request body.

Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.

This operation requires permission for the lambda:CreateEventSourceMapping action.

', 'CreateFunction' => '

Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.

This operation requires permission for the lambda:CreateFunction action.

', 'DeleteEventSourceMapping' => '

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:DeleteEventSourceMapping action.

', 'DeleteFunction' => '

Deletes the specified Lambda function code and configuration.

When you delete a function the associated access policy is also deleted. You will need to delete the event source mappings explicitly.

This operation requires permission for the lambda:DeleteFunction action.

', 'GetEventSourceMapping' => '

Returns configuration information for the specified event source mapping (see CreateEventSourceMapping].

This operation requires permission for the lambda:GetEventSourceMapping action.

', 'GetFunction' => '

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

This operation requires permission for the lambda:GetFunction action.

', 'GetFunctionConfiguration' => '

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

', 'GetPolicy' => '

Returns the access policy, containing a list of permissions granted via the AddPermission API, associated with the specified bucket.

You need permission for the lambda:GetPolicy action.

', 'Invoke' => '

Invokes a specified Lambda function.

This operation requires permission for the lambda:InvokeFunction action.

', 'InvokeAsync' => 'This API is deprecated. We recommend you use Invoke API (see Invoke].

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.

This operation requires permission for the lambda:InvokeFunction action.

', 'ListEventSourceMappings' => '

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping], where you identify a stream as an event source. This list does not include Amazon S3 event sources.

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSourceMappings action.

', 'ListFunctions' => '

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

', 'RemovePermission' => '

You can remove individual permissions from an access policy associated with a Lambda function by providing a Statement ID.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

', 'UpdateEventSourceMapping' => '

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

', 'UpdateFunctionCode' => '

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

This operation requires permission for the lambda:UpdateFunctionCode action.

', 'UpdateFunctionConfiguration' => '

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function\'s code.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

', ], 'service' => 'AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

', 'shapes' => [ 'Action' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$Action' => '

The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with "lambda:" followed by the API name (see Operations]. For example, "lambda:CreateFunction". You can use wildcard ("lambda:*"] to grant permission for all AWS Lambda actions.

', ], ], 'AddPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceArn' => '

This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN] as its value. This ensures that only events generated from the specified bucket can invoke the function.

If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3.', 'CreateEventSourceMappingRequest$EventSourceArn' => '

The Amazon Resource Name (ARN] of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

', 'EventSourceMappingConfiguration$EventSourceArn' => '

The Amazon Resource Name (ARN] of the Amazon Kinesis stream that is the source of events.

', 'ListEventSourceMappingsRequest$EventSourceArn' => '

The Amazon Resource Name (ARN] of the Amazon Kinesis stream.

', ], ], 'BatchSize' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$BatchSize' => '

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.

', 'EventSourceMappingConfiguration$BatchSize' => '

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

', 'UpdateEventSourceMappingRequest$BatchSize' => '

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

', ], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$ZipFile' => '

A base64-encoded .zip file containing your deployment package. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide.

', 'InvocationRequest$Payload' => '

JSON that you want to provide to your Lambda function as input.

', 'InvocationResponse$Payload' => '

It is the JSON representation of the object returned by the Lambda function. In This is present only if the invocation type is "RequestResponse".

In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message.

', 'UpdateFunctionCodeRequest$ZipFile' => '

Based64-encoded .zip file containing your packaged source code.

', ], ], 'BlobStream' => [ 'base' => NULL, 'refs' => [ 'InvokeAsyncRequest$InvokeArgs' => '

JSON that you want to provide to your Lambda function as input.

', ], ], 'CodeStorageExceededException' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'EventSourceMappingConfiguration$LastModified' => '

The UTC time string indicating the last time the event mapping was updated.

', ], ], 'DeleteEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Description' => '

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

', 'FunctionConfiguration$Description' => '

The user-provided description.

', 'UpdateFunctionConfigurationRequest$Description' => '

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

', ], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$Enabled' => '

Indicates whether AWS Lambda should begin polling the event source, the default is not enabled.

', 'UpdateEventSourceMappingRequest$Enabled' => '

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

', ], ], 'EventSourceMappingConfiguration' => [ 'base' => '

Describes mapping between an Amazon Kinesis stream and a Lambda function.

', 'refs' => [ 'EventSourceMappingsList$member' => NULL, ], ], 'EventSourceMappingsList' => [ 'base' => NULL, 'refs' => [ 'ListEventSourceMappingsResponse$EventSourceMappings' => '

An array of EventSourceMappingConfiguration objects.

', ], ], 'EventSourcePosition' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$StartingPosition' => '

The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.

', ], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'EventSourceMappingConfiguration$FunctionArn' => '

The Lambda function to invoke when AWS Lambda detects an event on the stream.

', 'FunctionConfiguration$FunctionArn' => '

The Amazon Resource Name (ARN] assigned to the function.

', ], ], 'FunctionCode' => [ 'base' => '

The code for the Lambda function.

', 'refs' => [ 'CreateFunctionRequest$Code' => '

The code for the Lambda function.

', ], ], 'FunctionCodeLocation' => [ 'base' => '

The object for the Lambda function location.

', 'refs' => [ 'GetFunctionResponse$Code' => NULL, ], ], 'FunctionConfiguration' => [ 'base' => '

A complex type that describes function metadata.

', 'refs' => [ 'FunctionList$member' => NULL, 'GetFunctionResponse$Configuration' => NULL, ], ], 'FunctionList' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsResponse$Functions' => '

A list of Lambda functions.

', ], ], 'FunctionName' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$FunctionName' => '

Name of the Lambda function whose access policy you are updating by adding a new permission.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'CreateEventSourceMappingRequest$FunctionName' => '

The Lambda function to invoke when AWS Lambda detects an event on the stream.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'CreateFunctionRequest$FunctionName' => '

The name you want to assign to the function you are uploading. You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as Invoke.

', 'DeleteFunctionRequest$FunctionName' => '

The Lambda function to delete.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'FunctionConfiguration$FunctionName' => '

The name of the function.

', 'GetFunctionConfigurationRequest$FunctionName' => '

The name of the Lambda function for which you want to retrieve the configuration information.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'GetFunctionRequest$FunctionName' => '

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'GetPolicyRequest$FunctionName' => '

Function name whose access policy you want to retrieve.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'InvocationRequest$FunctionName' => '

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'InvokeAsyncRequest$FunctionName' => '

The Lambda function name.

', 'ListEventSourceMappingsRequest$FunctionName' => '

The name of the Lambda function.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'RemovePermissionRequest$FunctionName' => '

Lambda function whose access policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'UpdateEventSourceMappingRequest$FunctionName' => '

The Lambda function to which you want the stream records sent.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'UpdateFunctionCodeRequest$FunctionName' => '

The existing Lambda function name whose code you want to replace.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'UpdateFunctionConfigurationRequest$FunctionName' => '

The name of the Lambda function.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', ], ], 'GetEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionResponse' => [ 'base' => '

This response contains the object for the Lambda function location (see API_FunctionCodeLocation

', 'refs' => [], ], 'GetPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Handler' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Handler' => '

The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information, see Lambda Function Handler (Java].

', 'FunctionConfiguration$Handler' => '

The function Lambda calls to begin executing your function.

', 'UpdateFunctionConfigurationRequest$Handler' => '

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

', ], ], 'HttpStatus' => [ 'base' => NULL, 'refs' => [ 'InvokeAsyncResponse$Status' => '

It will be 202 upon success.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'InvocationResponse$StatusCode' => '

The HTTP status code will be in the 200 range for successful request. For the "RequestResonse" invocation type this status code will be 200. For the "Event" invocation type this status code will be 202. For the "DryRun" invocation type the status code will be 204.

', ], ], 'InvalidParameterValueException' => [ 'base' => '

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

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

The request body could not be parsed as JSON.

', 'refs' => [], ], 'InvocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvocationResponse' => [ 'base' => '

Upon success, returns an empty response. Otherwise, throws an exception.

', 'refs' => [], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$InvocationType' => '

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

', ], ], 'InvokeAsyncRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeAsyncResponse' => [ 'base' => '

Upon success, it returns empty response. Otherwise, throws an exception.

', 'refs' => [], ], 'ListEventSourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventSourceMappingsResponse' => [ 'base' => '

Contains a list of event sources (see API_EventSourceMappingConfiguration]

', 'refs' => [], ], 'ListFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsResponse' => [ 'base' => '

Contains a list of AWS Lambda function configurations (see FunctionConfiguration.

', 'refs' => [], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$LogType' => '

You can set this optional parameter to "Tail" in the request only if you specify the InvocationType parameter with value "RequestResponse". In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-results header.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$CodeSize' => '

The size, in bytes, of the function .zip file you uploaded.

', ], ], 'MaxListItems' => [ 'base' => NULL, 'refs' => [ 'ListEventSourceMappingsRequest$MaxItems' => '

Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

', 'ListFunctionsRequest$MaxItems' => '

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

', ], ], 'MemorySize' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$MemorySize' => '

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

', 'FunctionConfiguration$MemorySize' => '

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

', 'UpdateFunctionConfigurationRequest$MemorySize' => '

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

', ], ], 'PolicyLengthExceededException' => [ 'base' => '

Lambda function access policy is limited to 20 KB.

', 'refs' => [], ], 'Principal' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$Principal' => '

The principal who is getting this permission. It can be Amazon S3 service Principal ("s3.amazonaws.com"] if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as "sns.amazonaws.com". For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.

', ], ], 'RemovePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestTooLargeException' => [ 'base' => NULL, 'refs' => [], ], 'ResourceConflictException' => [ 'base' => '

The resource already exists.

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

The resource (for example, a Lambda function or access policy statement] specified in the request does not exist.

', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Role' => '

The Amazon Resource Name (ARN] of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS] resources. For more information, see AWS Lambda: How it Works

', 'FunctionConfiguration$Role' => '

The Amazon Resource Name (ARN] of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS] resources.

', 'UpdateFunctionConfigurationRequest$Role' => '

The Amazon Resource Name (ARN] of the IAM role that Lambda will assume when it executes your function.

', ], ], 'Runtime' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Runtime' => '

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports "java" and "nodejs" as the runtime.

', 'FunctionConfiguration$Runtime' => '

The runtime environment for the Lambda function.

', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Bucket' => '

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.

', 'UpdateFunctionCodeRequest$S3Bucket' => '

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Key' => '

The Amazon S3 object (the deployment package] key name you want to upload.

', 'UpdateFunctionCodeRequest$S3Key' => '

The Amazon S3 object (the deployment package] key name you want to upload.

', ], ], 'S3ObjectVersion' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3ObjectVersion' => '

The Amazon S3 object (the deployment package] version you want to upload.

', 'UpdateFunctionCodeRequest$S3ObjectVersion' => '

The Amazon S3 object (the deployment package] version you want to upload.

', ], ], 'ServiceException' => [ 'base' => '

The AWS Lambda service encountered an internal error.

', 'refs' => [], ], 'SourceOwner' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceAccount' => '

The AWS account ID (without a hyphen] of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner\'s account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket]. You can also use this condition to specify all sources (that is, you don\'t specify the SourceArn] owned by a specific account.

', ], ], 'StatementId' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$StatementId' => '

A unique statement identifier.

', 'RemovePermissionRequest$StatementId' => '

Statement ID of the permission to remove.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddPermissionResponse$Statement' => '

The permission statement you specified in the request. The response returns the same as a string using "\\" as an escape character in the JSON.

', 'CodeStorageExceededException$Type' => NULL, 'CodeStorageExceededException$message' => NULL, 'DeleteEventSourceMappingRequest$UUID' => '

The event source mapping ID.

', 'EventSourceMappingConfiguration$UUID' => '

The AWS Lambda assigned opaque identifier for the mapping.

', 'EventSourceMappingConfiguration$LastProcessingResult' => '

The result of the last AWS Lambda invocation of your Lambda function.

', 'EventSourceMappingConfiguration$State' => '

The state of the event source mapping. It can be "Creating", "Enabled", "Disabled", "Enabling", "Disabling", "Updating", or "Deleting".

', 'EventSourceMappingConfiguration$StateTransitionReason' => '

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

', 'FunctionCodeLocation$RepositoryType' => '

The repository from which you can download the function.

', 'FunctionCodeLocation$Location' => '

The presigned URL you can use to download the function\'s .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

', 'GetEventSourceMappingRequest$UUID' => '

The AWS Lambda assigned ID of the event source mapping.

', 'GetPolicyResponse$Policy' => '

The access policy associated with the specified function. The response returns the same as a string using "\\" as an escape character in the JSON.

', 'InvalidParameterValueException$Type' => NULL, 'InvalidParameterValueException$message' => NULL, 'InvalidRequestContentException$Type' => NULL, 'InvalidRequestContentException$message' => NULL, 'InvocationRequest$ClientContext' => '

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

', 'InvocationResponse$FunctionError' => '

Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.

', 'InvocationResponse$LogResult' => '

It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is "RequestResponse" and the logs were requested.

', 'ListEventSourceMappingsRequest$Marker' => '

Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off.

', 'ListEventSourceMappingsResponse$NextMarker' => '

A string, present if there are more event source mappings.

', 'ListFunctionsRequest$Marker' => '

Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

', 'ListFunctionsResponse$NextMarker' => '

A string, present if there are more functions.

', 'PolicyLengthExceededException$Type' => NULL, 'PolicyLengthExceededException$message' => NULL, 'RequestTooLargeException$Type' => NULL, 'RequestTooLargeException$message' => NULL, 'ResourceConflictException$Type' => NULL, 'ResourceConflictException$message' => NULL, 'ResourceNotFoundException$Type' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ServiceException$Type' => NULL, 'ServiceException$Message' => NULL, 'TooManyRequestsException$retryAfterSeconds' => '

The number of seconds the caller should wait before retrying.

', 'TooManyRequestsException$Type' => NULL, 'TooManyRequestsException$message' => NULL, 'UnsupportedMediaTypeException$Type' => NULL, 'UnsupportedMediaTypeException$message' => NULL, 'UpdateEventSourceMappingRequest$UUID' => '

The event source mapping identifier.

', ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Timeout' => '

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

', 'FunctionConfiguration$Timeout' => '

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

', 'UpdateFunctionConfigurationRequest$Timeout' => '

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$LastModified' => '

The timestamp of the last time you updated the function.

', ], ], 'TooManyRequestsException' => [ 'base' => NULL, 'refs' => [], ], 'UnsupportedMediaTypeException' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFunctionCodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFunctionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], ],]; +return [ 'version' => '2.0', 'operations' => [ 'AddPermission' => '

Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use "push" model. In "push" model, event sources (such as Amazon S3 and custom applications] invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.

For information about the push model, see AWS Lambda: How it Works.

If you are using versioning feature (see AWS Lambda Function Versioning and Aliases], a Lambda function can have multiple ARNs that can be used to invoke the function. Note that, each permission you add to resource policy using this API is specific to an ARN, specified using the Qualifier parameter

This operation requires permission for the lambda:AddPermission action.

', 'CreateAlias' => '

Creates an alias to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:CreateAlias action.

', 'CreateEventSourceMapping' => '

Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and a Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which Lambda function to invoke] for the event source mapping in the request body.

Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.

This operation requires permission for the lambda:CreateEventSourceMapping action.

', 'CreateFunction' => '

Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.

This operation requires permission for the lambda:CreateFunction action.

', 'DeleteAlias' => '

Deletes specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:DeleteAlias action.

', 'DeleteEventSourceMapping' => '

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:DeleteEventSourceMapping action.

', 'DeleteFunction' => '

Deletes the specified Lambda function code and configuration.

If you don\'t specify a function version, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions.

When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.

For information about function versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:DeleteFunction action.

', 'GetAlias' => '

Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:GetAlias action.

', 'GetEventSourceMapping' => '

Returns configuration information for the specified event source mapping (see CreateEventSourceMapping].

This operation requires permission for the lambda:GetEventSourceMapping action.

', 'GetFunction' => '

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don\'t specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunction action.

', 'GetFunctionConfiguration' => '

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

You can use the optional Qualifier parameter to retrieve configuration information for a specific Lambda function version. If you don\'t provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

', 'GetPolicy' => '

Returns the resource policy, containing a list of permissions that apply to a specific to an ARN that you specify via the Qualifier paramter.

For informration about adding permissions, see AddPermission.

You need permission for the lambda:GetPolicy action.

', 'Invoke' => '

Invokes a specific Lambda function version.

If you don\'t provide the Qualifier parameter, it uses the unqualified function ARN which results in invocation of the $LATEST version of the Lambda function (when you create a Lambda function, the $LATEST is the version]. The AWS Lambda versioning and aliases feature allows you to publish multiple versions of a Lambda function and also create aliases for each function version. So each your Lambda function version can be invoked using multiple ARNs. For more information, see AWS Lambda Function Versioning and Aliases. Using the Qualifier parameter, you can specify a function version or alias name to invoke specific function version. If you specify function version, the API uses the qualified function ARN to invoke a specific function version. If you specify alias name, the API uses the alias ARN to invoke the function version to which the alias points.

This operation requires permission for the lambda:InvokeFunction action.

', 'InvokeAsync' => 'This API is deprecated. We recommend you use Invoke API (see Invoke].

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.

This operation requires permission for the lambda:InvokeFunction action.

', 'ListAliases' => '

Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:ListAliases action.

', 'ListEventSourceMappings' => '

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping], where you identify a stream as an event source. This list does not include Amazon S3 event sources.

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSourceMappings action.

', 'ListFunctions' => '

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

', 'ListVersionsByFunction' => '

List all versions of a function.

', 'PublishVersion' => '

Publishes a version of your function from the current snapshot of HEAD. That is, AWS Lambda takes a snapshot of the function code and configuration information from HEAD and publishes a new version. The code and handler of this specific Lambda function version cannot be modified after publication, but you can modify the configuration information.

', 'RemovePermission' => '

You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you addded the permission. The API removes corresponding permission that is associated with the specific ARN identified by the Qualifier parameter.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

', 'UpdateAlias' => '

Using this API you can update function version to which the alias points to and alias description. For more information, see Introduction to AWS Lambda Aliases

This requires permission for the lambda:UpdateAlias action.

', 'UpdateEventSourceMapping' => '

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

', 'UpdateFunctionCode' => '

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

This operation requires permission for the lambda:UpdateFunctionCode action.

', 'UpdateFunctionConfiguration' => '

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function\'s code.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

', ], 'service' => 'AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

', 'shapes' => [ 'Action' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$Action' => '

The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with "lambda:" followed by the API name (see Operations]. For example, "lambda:CreateFunction". You can use wildcard ("lambda:*"] to grant permission for all AWS Lambda actions.

', ], ], 'AddPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddPermissionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Alias' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$Name' => '

Alias name.

', 'CreateAliasRequest$Name' => '

Name for the alias your creating.

', 'DeleteAliasRequest$Name' => '

Name of the alias to delete.

', 'GetAliasRequest$Name' => '

Name of the alias for which you want to retrieve information.

', 'UpdateAliasRequest$Name' => '

The alias name.

', ], ], 'AliasConfiguration' => [ 'base' => '

Provides configuration information about a Lambda function version alias.

', 'refs' => [ 'AliasList$member' => NULL, ], ], 'AliasList' => [ 'base' => NULL, 'refs' => [ 'ListAliasesResponse$Aliases' => '

An list of alises.

', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceArn' => '

This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN] as its value. This ensures that only events generated from the specified bucket can invoke the function.

If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3.', 'CreateEventSourceMappingRequest$EventSourceArn' => '

The Amazon Resource Name (ARN] of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

', 'EventSourceMappingConfiguration$EventSourceArn' => '

The Amazon Resource Name (ARN] of the Amazon Kinesis stream that is the source of events.

', 'ListEventSourceMappingsRequest$EventSourceArn' => '

The Amazon Resource Name (ARN] of the Amazon Kinesis stream.

', ], ], 'BatchSize' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$BatchSize' => '

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.

', 'EventSourceMappingConfiguration$BatchSize' => '

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

', 'UpdateEventSourceMappingRequest$BatchSize' => '

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

', ], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$ZipFile' => '

A base64-encoded .zip file containing your deployment package. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide.

', 'InvocationRequest$Payload' => '

JSON that you want to provide to your Lambda function as input.

', 'InvocationResponse$Payload' => '

It is the JSON representation of the object returned by the Lambda function. In This is present only if the invocation type is "RequestResponse".

In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message.

', 'UpdateFunctionCodeRequest$ZipFile' => '

Based64-encoded .zip file containing your packaged source code.

', ], ], 'BlobStream' => [ 'base' => NULL, 'refs' => [ 'InvokeAsyncRequest$InvokeArgs' => '

JSON that you want to provide to your Lambda function as input.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Publish' => '

This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.

', 'UpdateFunctionCodeRequest$Publish' => '

This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.

', ], ], 'CodeStorageExceededException' => [ 'base' => '

You have exceeded your maximum total code size per account. Limits

', 'refs' => [], ], 'CreateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'EventSourceMappingConfiguration$LastModified' => '

The UTC time string indicating the last time the event mapping was updated.

', ], ], 'DeleteAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$Description' => '

Alias description.

', 'CreateAliasRequest$Description' => '

Description of the alias.

', 'CreateFunctionRequest$Description' => '

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

', 'FunctionConfiguration$Description' => '

The user-provided description.

', 'PublishVersionRequest$Description' => '

The description for the version you are publishing. If not provided, AWS Lambda copies the description from the HEAD version.

', 'UpdateAliasRequest$Description' => '

You can optionally change the description of the alias using this parameter.

', 'UpdateFunctionConfigurationRequest$Description' => '

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

', ], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$Enabled' => '

Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.

', 'UpdateEventSourceMappingRequest$Enabled' => '

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

', ], ], 'EventSourceMappingConfiguration' => [ 'base' => '

Describes mapping between an Amazon Kinesis stream and a Lambda function.

', 'refs' => [ 'EventSourceMappingsList$member' => NULL, ], ], 'EventSourceMappingsList' => [ 'base' => NULL, 'refs' => [ 'ListEventSourceMappingsResponse$EventSourceMappings' => '

An array of EventSourceMappingConfiguration objects.

', ], ], 'EventSourcePosition' => [ 'base' => NULL, 'refs' => [ 'CreateEventSourceMappingRequest$StartingPosition' => '

The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.

', ], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$AliasArn' => '

Lambda function ARN that is qualified using alias name as the suffix. For example, if you create an alias "BETA" pointing to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

', 'EventSourceMappingConfiguration$FunctionArn' => '

The Lambda function to invoke when AWS Lambda detects an event on the stream.

', 'FunctionConfiguration$FunctionArn' => '

The Amazon Resource Name (ARN] assigned to the function.

', ], ], 'FunctionCode' => [ 'base' => '

The code for the Lambda function.

', 'refs' => [ 'CreateFunctionRequest$Code' => '

The code for the Lambda function.

', ], ], 'FunctionCodeLocation' => [ 'base' => '

The object for the Lambda function location.

', 'refs' => [ 'GetFunctionResponse$Code' => NULL, ], ], 'FunctionConfiguration' => [ 'base' => '

A complex type that describes function metadata.

', 'refs' => [ 'FunctionList$member' => NULL, 'GetFunctionResponse$Configuration' => NULL, ], ], 'FunctionList' => [ 'base' => NULL, 'refs' => [ 'ListFunctionsResponse$Functions' => '

A list of Lambda functions.

', 'ListVersionsByFunctionResponse$Versions' => '

A list of Lambda function versions.

', ], ], 'FunctionName' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$FunctionName' => '

Name of the Lambda function whose resource policy you are updating by adding a new permission.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'CreateAliasRequest$FunctionName' => '

Name of the Lambda function for which you want to create an alias.

', 'CreateEventSourceMappingRequest$FunctionName' => '

The Lambda function to invoke when AWS Lambda detects an event on the stream.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'CreateFunctionRequest$FunctionName' => '

The name you want to assign to the function you are uploading. You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as Invoke.

', 'DeleteAliasRequest$FunctionName' => '

The Lambda function name for which the alias is created.

', 'DeleteFunctionRequest$FunctionName' => '

The Lambda function to delete.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'FunctionConfiguration$FunctionName' => '

The name of the function.

', 'GetAliasRequest$FunctionName' => '

Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function. So you must specify the function name.

', 'GetFunctionConfigurationRequest$FunctionName' => '

The name of the Lambda function for which you want to retrieve the configuration information.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'GetFunctionRequest$FunctionName' => '

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'GetPolicyRequest$FunctionName' => '

Function name whose resource policy you want to retrieve.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'InvocationRequest$FunctionName' => '

The Lambda function name.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'InvokeAsyncRequest$FunctionName' => '

The Lambda function name.

', 'ListAliasesRequest$FunctionName' => '

Lambda function name for which the alias is created.

', 'ListEventSourceMappingsRequest$FunctionName' => '

The name of the Lambda function.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'ListVersionsByFunctionRequest$FunctionName' => '

Function name whose versions to list. You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'PublishVersionRequest$FunctionName' => '

The Lambda function name. You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'RemovePermissionRequest$FunctionName' => '

Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'UpdateAliasRequest$FunctionName' => '

The function name for which the alias is created.

', 'UpdateEventSourceMappingRequest$FunctionName' => '

The Lambda function to which you want the stream records sent.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'UpdateFunctionCodeRequest$FunctionName' => '

The existing Lambda function name whose code you want to replace.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', 'UpdateFunctionConfigurationRequest$FunctionName' => '

The name of the Lambda function.

You can specify an unqualified function name (for example, "Thumbnail"] or you can specify Amazon Resource Name (ARN] of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"]. AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"]. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

', ], ], 'GetAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFunctionResponse' => [ 'base' => '

This response contains the object for the Lambda function location (see API_FunctionCodeLocation

', 'refs' => [], ], 'GetPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Handler' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Handler' => '

The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information, see Lambda Function Handler (Java].

', 'FunctionConfiguration$Handler' => '

The function Lambda calls to begin executing your function.

', 'UpdateFunctionConfigurationRequest$Handler' => '

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

', ], ], 'HttpStatus' => [ 'base' => NULL, 'refs' => [ 'InvokeAsyncResponse$Status' => '

It will be 202 upon success.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'InvocationResponse$StatusCode' => '

The HTTP status code will be in the 200 range for successful request. For the "RequestResonse" invocation type this status code will be 200. For the "Event" invocation type this status code will be 202. For the "DryRun" invocation type the status code will be 204.

', ], ], 'InvalidParameterValueException' => [ 'base' => '

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

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

The request body could not be parsed as JSON.

', 'refs' => [], ], 'InvocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvocationResponse' => [ 'base' => '

Upon success, returns an empty response. Otherwise, throws an exception.

', 'refs' => [], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$InvocationType' => '

By default, the Invoke API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

', ], ], 'InvokeAsyncRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeAsyncResponse' => [ 'base' => '

Upon success, it returns empty response. Otherwise, throws an exception.

', 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEventSourceMappingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventSourceMappingsResponse' => [ 'base' => '

Contains a list of event sources (see API_EventSourceMappingConfiguration]

', 'refs' => [], ], 'ListFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFunctionsResponse' => [ 'base' => '

Contains a list of AWS Lambda function configurations (see FunctionConfiguration.

', 'refs' => [], ], 'ListVersionsByFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVersionsByFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'InvocationRequest$LogType' => '

You can set this optional parameter to "Tail" in the request only if you specify the InvocationType parameter with value "RequestResponse". In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-results header.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$CodeSize' => '

The size, in bytes, of the function .zip file you uploaded.

', ], ], 'MaxListItems' => [ 'base' => NULL, 'refs' => [ 'ListAliasesRequest$MaxItems' => '

Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.

', 'ListEventSourceMappingsRequest$MaxItems' => '

Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

', 'ListFunctionsRequest$MaxItems' => '

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

', 'ListVersionsByFunctionRequest$MaxItems' => '

Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.

', ], ], 'MemorySize' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$MemorySize' => '

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

', 'FunctionConfiguration$MemorySize' => '

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

', 'UpdateFunctionConfigurationRequest$MemorySize' => '

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

', ], ], 'PolicyLengthExceededException' => [ 'base' => '

Lambda function access policy is limited to 20 KB.

', 'refs' => [], ], 'Principal' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$Principal' => '

The principal who is getting this permission. It can be Amazon S3 service Principal ("s3.amazonaws.com"] if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as "sns.amazonaws.com". For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.

', ], ], 'PublishVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'Qualifier' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$Qualifier' => '

You can specify this optional query parameter to specify function version or alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:2

If you specify alias name, for example "PROD", then the permission is valid only for requests made using the alias ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:PROD

If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.

arn:aws:lambda:aws-region:acct-id:function:function-name

', 'DeleteFunctionRequest$Qualifier' => '

Using this optional parameter you can specify a function version (but not the $LATEST version] to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the $LATEST, that is, you cannot specify $LATEST as the value of this parameter. The $LATEST version can be deleted only when you want to delete all the function versions and aliases.

You can only specify a function version and not alias name using this parameter. You cannot delete a function version using its alias.

If you don\'t specify this parameter, AWS Lambda will delete the function, including all its versions and aliases.

', 'GetFunctionConfigurationRequest$Qualifier' => '

Using this optional parameter you can specify function version or alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. if you specify alias name, the API uses alias ARN and returns information about the function version to which the alias points.

If you don\'t specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.

', 'GetFunctionRequest$Qualifier' => '

Using this optional parameter to specify a function version or alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify alias name, the API uses alias ARN and returns information about the function version to which the alias points. If you don\'t provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function.

', 'GetPolicyRequest$Qualifier' => '

You can specify this optional query parameter to specify function version or alias name in which case this API will return all permissions associated with the specific ARN. If you don\'t provide this parameter, the API will return permissions that apply to the unqualified function ARN.

', 'InvocationRequest$Qualifier' => '

You can use this optional paramter to specify a Lambda function version or alias name. If you specify function version, the API uses qualified function ARN to invoke a specific Lambda function. If you specify alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don\'t provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

', 'RemovePermissionRequest$Qualifier' => '

You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don\'t specify this parameter, the API removes permission associated with the unqualified function ARN.

', ], ], 'RemovePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RequestTooLargeException' => [ 'base' => '

The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits

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

The resource already exists.

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

The resource (for example, a Lambda function or access policy statement] specified in the request does not exist.

', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Role' => '

The Amazon Resource Name (ARN] of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS] resources. For more information, see AWS Lambda: How it Works

', 'FunctionConfiguration$Role' => '

The Amazon Resource Name (ARN] of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS] resources.

', 'UpdateFunctionConfigurationRequest$Role' => '

The Amazon Resource Name (ARN] of the IAM role that Lambda will assume when it executes your function.

', ], ], 'Runtime' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Runtime' => '

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports "java" and "nodejs" as the runtime.

', 'FunctionConfiguration$Runtime' => '

The runtime environment for the Lambda function.

', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Bucket' => '

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.

', 'UpdateFunctionCodeRequest$S3Bucket' => '

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3Key' => '

The Amazon S3 object (the deployment package] key name you want to upload.

', 'UpdateFunctionCodeRequest$S3Key' => '

The Amazon S3 object (the deployment package] key name you want to upload.

', ], ], 'S3ObjectVersion' => [ 'base' => NULL, 'refs' => [ 'FunctionCode$S3ObjectVersion' => '

The Amazon S3 object (the deployment package] version you want to upload.

', 'UpdateFunctionCodeRequest$S3ObjectVersion' => '

The Amazon S3 object (the deployment package] version you want to upload.

', ], ], 'ServiceException' => [ 'base' => '

The AWS Lambda service encountered an internal error.

', 'refs' => [], ], 'SourceOwner' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$SourceAccount' => '

The AWS account ID (without a hyphen] of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner\'s account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket]. You can also use this condition to specify all sources (that is, you don\'t specify the SourceArn] owned by a specific account.

', ], ], 'StatementId' => [ 'base' => NULL, 'refs' => [ 'AddPermissionRequest$StatementId' => '

A unique statement identifier.

', 'RemovePermissionRequest$StatementId' => '

Statement ID of the permission to remove.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddPermissionResponse$Statement' => '

The permission statement you specified in the request. The response returns the same as a string using "\\" as an escape character in the JSON.

', 'CodeStorageExceededException$Type' => NULL, 'CodeStorageExceededException$message' => NULL, 'DeleteEventSourceMappingRequest$UUID' => '

The event source mapping ID.

', 'EventSourceMappingConfiguration$UUID' => '

The AWS Lambda assigned opaque identifier for the mapping.

', 'EventSourceMappingConfiguration$LastProcessingResult' => '

The result of the last AWS Lambda invocation of your Lambda function.

', 'EventSourceMappingConfiguration$State' => '

The state of the event source mapping. It can be "Creating", "Enabled", "Disabled", "Enabling", "Disabling", "Updating", or "Deleting".

', 'EventSourceMappingConfiguration$StateTransitionReason' => '

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

', 'FunctionCodeLocation$RepositoryType' => '

The repository from which you can download the function.

', 'FunctionCodeLocation$Location' => '

The presigned URL you can use to download the function\'s .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

', 'FunctionConfiguration$CodeSha256' => '

It is the SHA256 hash of your function deployment package.

', 'GetEventSourceMappingRequest$UUID' => '

The AWS Lambda assigned ID of the event source mapping.

', 'GetPolicyResponse$Policy' => '

The resource policy associated with the specified function. The response returns the same as a string using "\\" as an escape character in the JSON.

', 'InvalidParameterValueException$Type' => NULL, 'InvalidParameterValueException$message' => NULL, 'InvalidRequestContentException$Type' => NULL, 'InvalidRequestContentException$message' => NULL, 'InvocationRequest$ClientContext' => '

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, go to PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

', 'InvocationResponse$FunctionError' => '

Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.

', 'InvocationResponse$LogResult' => '

It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is "RequestResponse" and the logs were requested.

', 'ListAliasesRequest$Marker' => '

Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing.

', 'ListAliasesResponse$NextMarker' => '

A string, present if there are more aliases.

', 'ListEventSourceMappingsRequest$Marker' => '

Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off.

', 'ListEventSourceMappingsResponse$NextMarker' => '

A string, present if there are more event source mappings.

', 'ListFunctionsRequest$Marker' => '

Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

', 'ListFunctionsResponse$NextMarker' => '

A string, present if there are more functions.

', 'ListVersionsByFunctionRequest$Marker' => '

Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing.

', 'ListVersionsByFunctionResponse$NextMarker' => '

A string, present if there are more function versions.

', 'PolicyLengthExceededException$Type' => NULL, 'PolicyLengthExceededException$message' => NULL, 'PublishVersionRequest$CodeSha256' => '

The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the HEAD version for the publication to succeed.

', 'RequestTooLargeException$Type' => NULL, 'RequestTooLargeException$message' => NULL, 'ResourceConflictException$Type' => NULL, 'ResourceConflictException$message' => NULL, 'ResourceNotFoundException$Type' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ServiceException$Type' => NULL, 'ServiceException$Message' => NULL, 'TooManyRequestsException$retryAfterSeconds' => '

The number of seconds the caller should wait before retrying.

', 'TooManyRequestsException$Type' => NULL, 'TooManyRequestsException$message' => NULL, 'UnsupportedMediaTypeException$Type' => NULL, 'UnsupportedMediaTypeException$message' => NULL, 'UpdateEventSourceMappingRequest$UUID' => '

The event source mapping identifier.

', ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'CreateFunctionRequest$Timeout' => '

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

', 'FunctionConfiguration$Timeout' => '

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

', 'UpdateFunctionConfigurationRequest$Timeout' => '

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'FunctionConfiguration$LastModified' => '

The timestamp of the last time you updated the function.

', ], ], 'TooManyRequestsException' => [ 'base' => NULL, 'refs' => [], ], 'UnsupportedMediaTypeException' => [ 'base' => '

The content type of the Invoke request body is not JSON.

', 'refs' => [], ], 'UpdateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventSourceMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFunctionCodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFunctionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'AliasConfiguration$FunctionVersion' => '

Function version to which the alias points.

', 'CreateAliasRequest$FunctionVersion' => '

Lambda function version for which you are creating the alias.

', 'FunctionConfiguration$Version' => '

The version of the Lambda function.

', 'ListAliasesRequest$FunctionVersion' => '

If you specify this optional parameter, the API returns only the aliases pointing to the specific Lambda function version, otherwise returns all aliases created for the Lambda function.

', 'UpdateAliasRequest$FunctionVersion' => '

Using this parameter you can optionally change the Lambda function version to which the alias to points to.

', ], ], ],]; diff --git a/src/data/manifest.json b/src/data/manifest.json index 60c7ddfa4c..91e76895f2 100644 --- a/src/data/manifest.json +++ b/src/data/manifest.json @@ -226,6 +226,20 @@ "2015-08-18": "2015-08-18" } }, + "data.iot": { + "namespace": "IotDataPlane", + "versions": { + "latest": "2015-05-28", + "2015-05-28": "2015-05-28" + } + }, + "iot": { + "namespace": "Iot", + "versions": { + "latest": "2015-05-28", + "2015-05-28": "2015-05-28" + } + }, "kinesis": { "namespace": "Kinesis", "versions": { diff --git a/src/data/manifest.json.php b/src/data/manifest.json.php index 6b615e358c..d7e2cb8696 100644 --- a/src/data/manifest.json.php +++ b/src/data/manifest.json.php @@ -1,3 +1,3 @@ [ 'namespace' => 'AutoScaling', 'versions' => [ 'latest' => '2011-01-01', '2011-01-01' => '2011-01-01', ], ], 'cloudformation' => [ 'namespace' => 'CloudFormation', 'versions' => [ 'latest' => '2010-05-15', '2010-05-15' => '2010-05-15', ], ], 'cloudfront' => [ 'namespace' => 'CloudFront', 'versions' => [ 'latest' => '2015-07-27', '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', ], ], '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', ], ], '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', ], ], 'cognito-identity' => [ 'namespace' => 'CognitoIdentity', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'cognito-sync' => [ 'namespace' => 'CognitoSync', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'config' => [ 'namespace' => 'ConfigService', 'versions' => [ 'latest' => '2014-11-12', '2014-11-12' => '2014-11-12', ], ], 'datapipeline' => [ 'namespace' => 'DataPipeline', 'versions' => [ 'latest' => '2012-10-29', '2012-10-29' => '2012-10-29', ], ], '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', ], ], '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', ], ], 'ec2' => [ 'namespace' => 'Ec2', 'versions' => [ 'latest' => '2015-10-01', '2015-10-01' => '2015-10-01', '2015-04-15' => '2015-10-01', ], ], 'ecs' => [ 'namespace' => 'Ecs', 'versions' => [ 'latest' => '2014-11-13', '2014-11-13' => '2014-11-13', ], ], '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', ], ], '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', ], ], 'es' => [ 'namespace' => 'ElasticsearchService', 'versions' => [ 'latest' => '2015-01-01', '2015-01-01' => '2015-01-01', ], ], 'firehose' => [ 'namespace' => 'Firehose', 'versions' => [ 'latest' => '2015-08-04', '2015-08-04' => '2015-08-04', ], ], 'glacier' => [ 'namespace' => 'Glacier', 'versions' => [ 'latest' => '2012-06-01', '2012-06-01' => '2012-06-01', ], ], 'iam' => [ 'namespace' => 'Iam', 'versions' => [ 'latest' => '2010-05-08', '2010-05-08' => '2010-05-08', ], ], 'inspector' => [ 'namespace' => 'Inspector', 'versions' => [ 'latest' => '2015-08-18', '2015-08-18' => '2015-08-18', ], ], 'kinesis' => [ 'namespace' => 'Kinesis', 'versions' => [ 'latest' => '2013-12-02', '2013-12-02' => '2013-12-02', ], ], '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', ], ], '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', ], ], 'marketplacecommerceanalytics' => [ 'namespace' => 'MarketplaceCommerceAnalytics', 'versions' => [ 'latest' => '2015-07-01', '2015-07-01' => '2015-07-01', ], ], 'monitoring' => [ 'namespace' => 'CloudWatch', 'versions' => [ 'latest' => '2010-08-01', '2010-08-01' => '2010-08-01', ], ], 'opsworks' => [ 'namespace' => 'OpsWorks', 'versions' => [ 'latest' => '2013-02-18', '2013-02-18' => '2013-02-18', ], ], 'rds' => [ 'namespace' => 'Rds', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', ], ], 'redshift' => [ 'namespace' => 'Redshift', 'versions' => [ 'latest' => '2012-12-01', '2012-12-01' => '2012-12-01', ], ], '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', ], ], 's3' => [ 'namespace' => 'S3', 'versions' => [ 'latest' => '2006-03-01', '2006-03-01' => '2006-03-01', ], ], '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', ], ], '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', ], ], 'waf' => [ 'namespace' => 'Waf', 'versions' => [ 'latest' => '2015-08-24', '2015-08-24' => '2015-08-24', ], ], 'workspaces' => [ 'namespace' => 'WorkSpaces', 'versions' => [ 'latest' => '2015-04-08', '2015-04-08' => '2015-04-08', ], ],]; +return [ 'autoscaling' => [ 'namespace' => 'AutoScaling', 'versions' => [ 'latest' => '2011-01-01', '2011-01-01' => '2011-01-01', ], ], 'cloudformation' => [ 'namespace' => 'CloudFormation', 'versions' => [ 'latest' => '2010-05-15', '2010-05-15' => '2010-05-15', ], ], 'cloudfront' => [ 'namespace' => 'CloudFront', 'versions' => [ 'latest' => '2015-07-27', '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', ], ], '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', ], ], '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', ], ], 'cognito-identity' => [ 'namespace' => 'CognitoIdentity', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'cognito-sync' => [ 'namespace' => 'CognitoSync', 'versions' => [ 'latest' => '2014-06-30', '2014-06-30' => '2014-06-30', ], ], 'config' => [ 'namespace' => 'ConfigService', 'versions' => [ 'latest' => '2014-11-12', '2014-11-12' => '2014-11-12', ], ], 'datapipeline' => [ 'namespace' => 'DataPipeline', 'versions' => [ 'latest' => '2012-10-29', '2012-10-29' => '2012-10-29', ], ], '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', ], ], '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', ], ], 'ec2' => [ 'namespace' => 'Ec2', 'versions' => [ 'latest' => '2015-10-01', '2015-10-01' => '2015-10-01', '2015-04-15' => '2015-10-01', ], ], 'ecs' => [ 'namespace' => 'Ecs', 'versions' => [ 'latest' => '2014-11-13', '2014-11-13' => '2014-11-13', ], ], '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', ], ], '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', ], ], 'es' => [ 'namespace' => 'ElasticsearchService', 'versions' => [ 'latest' => '2015-01-01', '2015-01-01' => '2015-01-01', ], ], 'firehose' => [ 'namespace' => 'Firehose', 'versions' => [ 'latest' => '2015-08-04', '2015-08-04' => '2015-08-04', ], ], 'glacier' => [ 'namespace' => 'Glacier', 'versions' => [ 'latest' => '2012-06-01', '2012-06-01' => '2012-06-01', ], ], 'iam' => [ 'namespace' => 'Iam', 'versions' => [ 'latest' => '2010-05-08', '2010-05-08' => '2010-05-08', ], ], 'inspector' => [ 'namespace' => 'Inspector', 'versions' => [ 'latest' => '2015-08-18', '2015-08-18' => '2015-08-18', ], ], 'data.iot' => [ 'namespace' => 'IotDataPlane', 'versions' => [ 'latest' => '2015-05-28', '2015-05-28' => '2015-05-28', ], ], 'iot' => [ 'namespace' => 'Iot', 'versions' => [ 'latest' => '2015-05-28', '2015-05-28' => '2015-05-28', ], ], 'kinesis' => [ 'namespace' => 'Kinesis', 'versions' => [ 'latest' => '2013-12-02', '2013-12-02' => '2013-12-02', ], ], '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', ], ], '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', ], ], 'marketplacecommerceanalytics' => [ 'namespace' => 'MarketplaceCommerceAnalytics', 'versions' => [ 'latest' => '2015-07-01', '2015-07-01' => '2015-07-01', ], ], 'monitoring' => [ 'namespace' => 'CloudWatch', 'versions' => [ 'latest' => '2010-08-01', '2010-08-01' => '2010-08-01', ], ], 'opsworks' => [ 'namespace' => 'OpsWorks', 'versions' => [ 'latest' => '2013-02-18', '2013-02-18' => '2013-02-18', ], ], 'rds' => [ 'namespace' => 'Rds', 'versions' => [ 'latest' => '2014-10-31', '2014-10-31' => '2014-10-31', ], ], 'redshift' => [ 'namespace' => 'Redshift', 'versions' => [ 'latest' => '2012-12-01', '2012-12-01' => '2012-12-01', ], ], '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', ], ], 's3' => [ 'namespace' => 'S3', 'versions' => [ 'latest' => '2006-03-01', '2006-03-01' => '2006-03-01', ], ], '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', ], ], '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', ], ], 'waf' => [ 'namespace' => 'Waf', 'versions' => [ 'latest' => '2015-08-24', '2015-08-24' => '2015-08-24', ], ], 'workspaces' => [ 'namespace' => 'WorkSpaces', 'versions' => [ 'latest' => '2015-04-08', '2015-04-08' => '2015-04-08', ], ],];