Deletes the DomainName resource.
" }, + "DeleteGatewayResponse":{ + "name":"DeleteGatewayResponse", + "http":{ + "method":"DELETE", + "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}", + "responseCode":202 + }, + "input":{"shape":"DeleteGatewayResponseRequest"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"} + ], + "documentation":"Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
" + }, "DeleteIntegration":{ "name":"DeleteIntegration", "http":{ @@ -892,10 +909,42 @@ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Exports a deployed version of a RestApi in a specified format.
" }, + "GetGatewayResponse":{ + "name":"GetGatewayResponse", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}" + }, + "input":{"shape":"GetGatewayResponseRequest"}, + "output":{"shape":"GatewayResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Gets a GatewayResponse of a specified response type on the given RestApi.
" + }, + "GetGatewayResponses":{ + "name":"GetGatewayResponses", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/gatewayresponses" + }, + "input":{"shape":"GetGatewayResponsesRequest"}, + "output":{"shape":"GatewayResponses"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
" + }, "GetIntegration":{ "name":"GetIntegration", "http":{ @@ -1108,6 +1157,7 @@ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Generates a client SDK for a RestApi and Stage.
" @@ -1304,6 +1354,24 @@ ], "documentation":"A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
" }, + "PutGatewayResponse":{ + "name":"PutGatewayResponse", + "http":{ + "method":"PUT", + "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}", + "responseCode":201 + }, + "input":{"shape":"PutGatewayResponseRequest"}, + "output":{"shape":"GatewayResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
" + }, "PutIntegration":{ "name":"PutIntegration", "http":{ @@ -1320,7 +1388,7 @@ {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Represents a put integration.
" + "documentation":"Sets up a method's integration.
" }, "PutIntegrationResponse":{ "name":"PutIntegrationResponse", @@ -1578,6 +1646,22 @@ ], "documentation":"Changes information about the DomainName resource.
" }, + "UpdateGatewayResponse":{ + "name":"UpdateGatewayResponse", + "http":{ + "method":"PATCH", + "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}" + }, + "input":{"shape":"UpdateGatewayResponseRequest"}, + "output":{"shape":"GatewayResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Updates a GatewayResponse of a specified response type on the given RestApi.
" + }, "UpdateIntegration":{ "name":"UpdateIntegration", "http":{ @@ -1746,7 +1830,7 @@ {"shape":"BadRequestException"}, {"shape":"NotFoundException"} ], - "documentation":"Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
" + "documentation":"Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
" }, "UpdateUsagePlan":{ "name":"UpdateUsagePlan", @@ -1855,7 +1939,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfApiKey", - "documentation":"The current page of any ApiKey resources in the collection of ApiKey resources.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -1939,7 +2023,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfAuthorizer", - "documentation":"Gets the current list of Authorizer resources in the collection.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -1962,11 +2046,11 @@ }, "restApiId":{ "shape":"String", - "documentation":"The name of the API.
" + "documentation":"The string identifier of the associated RestApi.
" }, "stage":{ "shape":"String", - "documentation":"The name of the API's stage.
" + "documentation":"The name of the associated stage.
" } }, "documentation":"Represents the base path that callers of the API must provide as part of the URL after the domain name.
BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.The current page of any BasePathMapping resources in the collection of base path mapping resources.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -2042,7 +2126,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfClientCertificate", - "documentation":"The current page of any ClientCertificate resources in the collection of ClientCertificate resources.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -2108,7 +2192,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier under which the Authorizer will be created.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2170,7 +2254,7 @@ }, "restApiId":{ "shape":"String", - "documentation":"The name of the API that you want to apply this mapping to.
" + "documentation":"The string identifier of the associated RestApi.
" }, "stage":{ "shape":"String", @@ -2185,7 +2269,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi resource identifier for the Deployment resource to create.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2226,7 +2310,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of an API of the to-be-created documentation part.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2250,7 +2334,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] Specifies the API identifier of the to-be-created documentation version.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2339,7 +2423,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of the RestApi for which the RequestValidator is created.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2368,7 +2452,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi for the resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2422,7 +2506,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi resource for the Stage resource to create.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2531,7 +2615,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Authorizer resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2588,7 +2672,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi resource for the Deployment resource to delete.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2610,7 +2694,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] Specifies the identifier of an API of the to-be-deleted documentation part.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2632,7 +2716,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of an API of a to-be-deleted documentation snapshot.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2658,6 +2742,28 @@ }, "documentation":"A request to delete the DomainName resource.
" }, + "DeleteGatewayResponseRequest":{ + "type":"structure", + "required":[ + "restApiId", + "responseType" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"The string identifier of the associated RestApi.
", + "location":"uri", + "locationName":"restapi_id" + }, + "responseType":{ + "shape":"GatewayResponseType", + "documentation":"The response type of the associated GatewayResponse. Valid values are
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
" + }, "DeleteIntegrationRequest":{ "type":"structure", "required":[ @@ -2668,7 +2774,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a delete integration request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2698,7 +2804,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a delete integration response request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2733,7 +2839,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Method resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2763,7 +2869,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the MethodResponse resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2797,7 +2903,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi under which the model will be deleted.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2819,7 +2925,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of the RestApi from which the given RequestValidator is deleted.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2841,7 +2947,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Resource resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2860,7 +2966,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The ID of the RestApi you want to delete.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" } @@ -2876,7 +2982,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi resource for the Stage resource to delete.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -2922,7 +3028,7 @@ "locationName":"usageplanId" } }, - "documentation":"The DELETE request to delete a uasge plan of a given plan Id.
" + "documentation":"The DELETE request to delete a usage plan of a given plan Id.
" }, "Deployment":{ "type":"structure", @@ -2952,7 +3058,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfDeployment", - "documentation":"The current page of any Deployment resources in the collection of deployment resources.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -3044,7 +3150,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfDocumentationPart", - "documentation":"The current page of DocumentationPart resources in the DocumentationParts collection.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -3074,7 +3180,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfDocumentationVersion", - "documentation":"The current page of DocumentationVersion items from the DocumentationVersions collection of an API.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -3112,7 +3218,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfDomainName", - "documentation":"The current page of any DomainName resources in the collection of DomainName resources.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -3151,7 +3257,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The API identifier of the stage to flush.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3173,7 +3279,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The API identifier of the stage to flush its cache.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3186,6 +3292,69 @@ }, "documentation":"Requests Amazon API Gateway to flush a stage's cache.
" }, + "GatewayResponse":{ + "type":"structure", + "members":{ + "responseType":{ + "shape":"GatewayResponseType", + "documentation":"The response type of the associated GatewayResponse. Valid values are
The HTTP status code for this GatewayResponse.
" + }, + "responseParameters":{ + "shape":"MapOfStringToString", + "documentation":"Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
" + }, + "responseTemplates":{ + "shape":"MapOfStringToString", + "documentation":"Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" + }, + "defaultResponse":{ + "shape":"Boolean", + "documentation":"A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by Amazon API Gateway without any customization by an API developer.
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
This example shows how to get a gateway response of the MISSING_AUTHNETICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45 The response type is specified as a URL path.
The successful operation returns the 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"'404'\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }Returns the entire collection, because of no pagination support.
", + "locationName":"item" + } + }, + "documentation":"The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
This example request shows how to retrieve the GatewayResponses collection from an API.
GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515 The successful operation returns the 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"first\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"gatewayresponse:by-type\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"item\": [ { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } ] }, \"_embedded\": { \"item\": [ { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_FAILURE\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"RESOURCE_NOT_FOUND\", \"statusCode\": \"404\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"REQUEST_TOO_LARGE\", \"statusCode\": \"413\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"THROTTLED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNSUPPORTED_MEDIA_TYPE\", \"statusCode\": \"415\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_5XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_4XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_PARAMETERS\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_BODY\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"EXPIRED_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"ACCESS_DENIED\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_API_KEY\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNAUTHORIZED\", \"statusCode\": \"401\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"API_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"QUOTA_EXCEEDED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_TIMEOUT\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_SIGNATURE\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_FAILURE\", \"statusCode\": \"500\" } ] } }The maximum number of ApiKeys to get information about.
", + "documentation":"The maximum number of returned results per page.
", "location":"querystring", "locationName":"limit" }, @@ -3266,7 +3435,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Authorizer resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3285,7 +3454,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Authorizers resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3391,7 +3560,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi resource for the Deployment resource to get information about.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3416,7 +3585,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi resource for the collection of Deployment resources to get information about.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3444,13 +3613,13 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of an API of the to-be-retrieved documentation part.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, "documentationPartId":{ "shape":"String", - "documentation":"[Required] The identifier of the to-be-retrieved documentation part.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"part_id" } @@ -3463,7 +3632,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of the API of the to-be-retrieved documentation parts.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3509,7 +3678,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of the API of the to-be-retrieved documentation snapshot.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3528,7 +3697,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of an API of the to-be-retrieved documentation versions.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3588,7 +3757,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi to be exported.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3618,6 +3787,53 @@ }, "documentation":"Request a new export of a RestApi for a particular Stage.
" }, + "GetGatewayResponseRequest":{ + "type":"structure", + "required":[ + "restApiId", + "responseType" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"The string identifier of the associated RestApi.
", + "location":"uri", + "locationName":"restapi_id" + }, + "responseType":{ + "shape":"GatewayResponseType", + "documentation":"The response type of the associated GatewayResponse. Valid values are
Gets a GatewayResponse of a specified response type on the given RestApi.
" + }, + "GetGatewayResponsesRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"The string identifier of the associated RestApi.
", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"The maximum number of returned results per page. The GatewayResponses collection does not support pagination and the limit does not apply here.
", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
" + }, "GetIntegrationRequest":{ "type":"structure", "required":[ @@ -3628,7 +3844,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a get integration request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3658,7 +3874,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a get integration response request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3693,7 +3909,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Method resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3723,7 +3939,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the MethodResponse resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3785,7 +4001,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The ID of the RestApi under which the model exists.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3804,7 +4020,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3832,7 +4048,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of the RestApi to which the specified RequestValidator belongs.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3851,7 +4067,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of a RestApi to which the RequestValidators collection belongs.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3879,7 +4095,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3904,7 +4120,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -3970,7 +4186,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi that the SDK will use.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4034,7 +4250,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi resource for the Stage resource to get information about.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4053,7 +4269,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The stages' API identifiers.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4239,7 +4455,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of an API of the to-be-imported documentation parts.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4275,12 +4491,12 @@ }, "parameters":{ "shape":"MapOfStringToString", - "documentation":"Custom header parameters as part of the request.
", + "documentation":"Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json.
The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
" + "documentation":"The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
" } }, "documentation":"A POST request to import an API to Amazon API Gateway using an input of an API definition file.
", @@ -4427,6 +4643,10 @@ "type":"list", "member":{"shape":"DomainName"} }, + "ListOfGatewayResponse":{ + "type":"list", + "member":{"shape":"GatewayResponse"} + }, "ListOfLong":{ "type":"list", "member":{"shape":"Long"} @@ -4691,7 +4911,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfModel", - "documentation":"Gets the current Model resource in the collection.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -4746,6 +4966,40 @@ "value":{"shape":"MapOfMethodSnapshot"} }, "ProviderARN":{"type":"string"}, + "PutGatewayResponseRequest":{ + "type":"structure", + "required":[ + "restApiId", + "responseType" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"The string identifier of the associated RestApi.
", + "location":"uri", + "locationName":"restapi_id" + }, + "responseType":{ + "shape":"GatewayResponseType", + "documentation":"The response type of the associated GatewayResponse. Valid values are
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
" + }, + "responseTemplates":{ + "shape":"MapOfStringToString", + "documentation":"Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" + } + }, + "documentation":"Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
" + }, "PutIntegrationRequest":{ "type":"structure", "required":[ @@ -4757,7 +5011,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a put integration request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4784,7 +5038,7 @@ }, "uri":{ "shape":"String", - "documentation":"Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
" + "documentation":"Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
Represents a put integration request.
" + "documentation":"Sets up a method's integration.
" }, "PutIntegrationResponseRequest":{ "type":"structure", @@ -4828,7 +5082,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a put integration response request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4880,7 +5134,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the new Method resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4938,7 +5192,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Method resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -4987,7 +5241,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi to be updated.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5005,12 +5259,12 @@ }, "parameters":{ "shape":"MapOfStringToString", - "documentation":"Custom headers supplied as part of the request.
", + "documentation":"Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json.
The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
" + "documentation":"The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
" } }, "documentation":"A PUT request to update an existing API, with external API definitions specified as the request body.
", @@ -5070,7 +5324,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfRequestValidator", - "documentation":"The current page of RequestValidator resources in the RequestValidators collection.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -5108,7 +5362,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfResource", - "documentation":"Gets the current Resource resource in the collection.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -5154,7 +5408,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfRestApi", - "documentation":"An array of links to the current page of RestApi resources.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -5237,7 +5491,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfSdkType", - "documentation":"The set of SdkType items that comprise this view of the SdkTypes collection.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -5316,11 +5570,11 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"A list of Stage resources that are associated with the ApiKey resource.
" + "documentation":"The string identifier of the associated RestApi.
" }, "stageName":{ "shape":"String", - "documentation":"The stage name in the RestApi that the stage key references.
" + "documentation":"The stage name associated with the stage key.
" } }, "documentation":"A reference to a unique stage identified in the format {restApiId}/{stage}.
An individual Stage resource.
" + "documentation":"The current page of elements from this collection.
" } }, "documentation":"A list of Stage resources that are associated with the ApiKey resource.
" @@ -5360,7 +5614,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a test invoke authorizer request's RestApi identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5434,7 +5688,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies a test invoke method request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5579,7 +5833,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Authorizer resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5648,7 +5902,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The replacement identifier of the RestApi resource for the Deployment resource to change information about.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5674,7 +5928,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of an API of the to-be-updated documentation part.
", + "documentation":"[Required] The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5700,7 +5954,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of an API of the to-be-updated documentation version.
", + "documentation":"[Required] The string identifier of the associated RestApi..
", "location":"uri", "locationName":"restapi_id" }, @@ -5734,6 +5988,32 @@ }, "documentation":"A request to change information about the DomainName resource.
" }, + "UpdateGatewayResponseRequest":{ + "type":"structure", + "required":[ + "restApiId", + "responseType" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"The string identifier of the associated RestApi.
", + "location":"uri", + "locationName":"restapi_id" + }, + "responseType":{ + "shape":"GatewayResponseType", + "documentation":"The response type of the associated GatewayResponse. Valid values are
A list of update operations to be applied to the specified resource and in the order specified in this list.
" + } + }, + "documentation":"Updates a GatewayResponse of a specified response type on the given RestApi.
" + }, "UpdateIntegrationRequest":{ "type":"structure", "required":[ @@ -5744,7 +6024,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Represents an update integration request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5778,7 +6058,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"Specifies an update integration response request's API identifier.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5817,7 +6097,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Method resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5851,7 +6131,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the MethodResponse resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5889,7 +6169,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier under which the model exists.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5915,7 +6195,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"[Required] The identifier of the RestApi for which the given RequestValidator is updated.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5941,7 +6221,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The RestApi identifier for the Resource resource.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5964,7 +6244,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The ID of the RestApi you want to update.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -5984,7 +6264,7 @@ "members":{ "restApiId":{ "shape":"String", - "documentation":"The identifier of the RestApi resource for the Stage resource to change information about.
", + "documentation":"The string identifier of the associated RestApi.
", "location":"uri", "locationName":"restapi_id" }, @@ -6042,7 +6322,7 @@ "documentation":"A list of update operations to be applied to the specified resource and in the order specified in this list.
" } }, - "documentation":"The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a specified API key.
" + "documentation":"The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
" }, "Usage":{ "type":"structure", @@ -6130,7 +6410,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfUsagePlanKey", - "documentation":"Gets the current item of the usage plan keys collection.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, @@ -6142,7 +6422,7 @@ "position":{"shape":"String"}, "items":{ "shape":"ListOfUsagePlan", - "documentation":"Gets the current item when enumerating the collection of UsagePlan.
", + "documentation":"The current page of elements from this collection.
", "locationName":"item" } }, diff --git a/botocore/data/athena/2017-05-18/paginators-1.json b/botocore/data/athena/2017-05-18/paginators-1.json index ea142457..ce96fb1b 100644 --- a/botocore/data/athena/2017-05-18/paginators-1.json +++ b/botocore/data/athena/2017-05-18/paginators-1.json @@ -1,3 +1,22 @@ { - "pagination": {} + "pagination": { + "ListNamedQueries": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "NamedQueryIds" + }, + "ListQueryExecutions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "QueryExecutionIds" + }, + "GetQueryResults": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ResultSet" + } + } } diff --git a/botocore/data/autoscaling/2011-01-01/service-2.json b/botocore/data/autoscaling/2011-01-01/service-2.json index 731a14d4..22fed40f 100644 --- a/botocore/data/autoscaling/2011-01-01/service-2.json +++ b/botocore/data/autoscaling/2011-01-01/service-2.json @@ -108,7 +108,8 @@ "errors":[ {"shape":"LimitExceededFault"}, {"shape":"AlreadyExistsFault"}, - {"shape":"ResourceContentionFault"} + {"shape":"ResourceContentionFault"}, + {"shape":"ResourceInUseFault"} ], "documentation":"Creates or updates tags for the specified Auto Scaling group.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.
" }, @@ -199,7 +200,8 @@ }, "input":{"shape":"DeleteTagsType"}, "errors":[ - {"shape":"ResourceContentionFault"} + {"shape":"ResourceContentionFault"}, + {"shape":"ResourceInUseFault"} ], "documentation":"Deletes the specified tags.
" }, @@ -506,7 +508,7 @@ "errors":[ {"shape":"ResourceContentionFault"} ], - "documentation":"Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling User Guide.
" + "documentation":"Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling User Guide.
" }, "DetachLoadBalancerTargetGroups":{ "name":"DetachLoadBalancerTargetGroups", @@ -578,7 +580,7 @@ "errors":[ {"shape":"ResourceContentionFault"} ], - "documentation":"Moves the specified instances into the standby state.
For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Auto Scaling User Guide.
" + "documentation":"Moves the specified instances into Standby mode.
For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.
" }, "ExecutePolicy":{ "name":"ExecutePolicy", @@ -607,7 +609,7 @@ "errors":[ {"shape":"ResourceContentionFault"} ], - "documentation":"Moves the specified instances out of the standby state.
For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Auto Scaling User Guide.
" + "documentation":"Moves the specified instances out of Standby mode.
For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.
" }, "PutLifecycleHook":{ "name":"PutLifecycleHook", @@ -782,7 +784,7 @@ {"shape":"ScalingActivityInProgressFault"}, {"shape":"ResourceContentionFault"} ], - "documentation":"Updates the configuration for the specified Auto Scaling group.
The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.
To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.
Note the following:
If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize.
All other optional parameters are left unchanged if not specified.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to False, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.
The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.
Note the following:
If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize.
All other optional parameters are left unchanged if not specified.
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribeScalingActivities.
" }, "Activity":{ "type":"structure", @@ -868,7 +871,8 @@ "shape":"Activity", "documentation":"A scaling activity.
" } - } + }, + "documentation":"Contains the output of TerminateInstancesInAutoScalingGroup.
" }, "AdjustmentType":{ "type":"structure", @@ -937,7 +941,8 @@ "shape":"ResourceName", "documentation":"The name of the group.
" } - } + }, + "documentation":"Contains the parameters for AttachInstances.
" }, "AttachLoadBalancerTargetGroupsResultType":{ "type":"structure", @@ -959,12 +964,14 @@ "shape":"TargetGroupARNs", "documentation":"The Amazon Resource Names (ARN) of the target groups.
" } - } + }, + "documentation":"Contains the parameters for AttachLoadBalancerTargetGroups.
" }, "AttachLoadBalancersResultType":{ "type":"structure", "members":{ - } + }, + "documentation":"Contains the output of AttachLoadBalancers.
" }, "AttachLoadBalancersType":{ "type":"structure", @@ -981,7 +988,8 @@ "shape":"LoadBalancerNames", "documentation":"One or more load balancer names.
" } - } + }, + "documentation":"Contains the parameters for AttachLoadBalancers.
" }, "AutoScalingGroup":{ "type":"structure", @@ -1109,7 +1117,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribeAutoScalingGroups.
" }, "AutoScalingGroups":{ "type":"list", @@ -1127,7 +1136,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output for DescribeAutoScalingGroups.
" }, "AutoScalingInstanceDetails":{ "type":"structure", @@ -1187,7 +1197,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribeAutoScalingInstances.
" }, "AutoScalingNotificationTypes":{ "type":"list", @@ -1249,7 +1260,8 @@ "CompleteLifecycleActionAnswer":{ "type":"structure", "members":{ - } + }, + "documentation":"Contains the output of CompleteLifecycleAction.
" }, "CompleteLifecycleActionType":{ "type":"structure", @@ -1279,7 +1291,8 @@ "shape":"XmlStringMaxLen19", "documentation":"The ID of the instance.
" } - } + }, + "documentation":"Contains the parameters for CompleteLifecycleAction.
" }, "Cooldown":{"type":"integer"}, "CreateAutoScalingGroupType":{ @@ -1312,7 +1325,7 @@ }, "DesiredCapacity":{ "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
" + "documentation":"The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
" }, "DefaultCooldown":{ "shape":"Cooldown", @@ -1358,7 +1371,8 @@ "shape":"Tags", "documentation":"One or more tags.
For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.
" } - } + }, + "documentation":"Contains the parameters for CreateAutoScalingGroup.
" }, "CreateLaunchConfigurationType":{ "type":"structure", @@ -1370,7 +1384,7 @@ }, "ImageId":{ "shape":"XmlStringMaxLen255", - "documentation":"The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
If you do not specify InstanceId, you must specify ImageId.
For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.
" }, "KeyName":{ "shape":"XmlStringMaxLen255", @@ -1394,11 +1408,11 @@ }, "InstanceId":{ "shape":"XmlStringMaxLen19", - "documentation":"The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, with the exception of the block device mapping.
If you do not specify InstanceId, you must specify both ImageId and InstanceType.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling User Guide.
" + "documentation":"The ID of the instance to use to create the launch configuration.
The new launch configuration derives attributes from the instance, with the exception of the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling User Guide.
" }, "InstanceType":{ "shape":"XmlStringMaxLen255", - "documentation":"The instance type of the EC2 instance.
If you do not specify InstanceId, you must specify InstanceType.
For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The instance type of the EC2 instance. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
" }, "KernelId":{ "shape":"XmlStringMaxLen255", @@ -1414,7 +1428,7 @@ }, "InstanceMonitoring":{ "shape":"InstanceMonitoring", - "documentation":"Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default is true.
Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances.
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.
You must set the value of this parameter to dedicated if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).
If you specify this parameter, be sure to specify at least one subnet when you create your group.
For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.
Valid values: default | dedicated
Contains the parameters for CreateLaunchConfiguration.
" }, "CreateOrUpdateTagsType":{ "type":"structure", @@ -1446,7 +1461,39 @@ "shape":"Tags", "documentation":"One or more tags.
" } - } + }, + "documentation":"Contains the parameters for CreateOrUpdateTags.
" + }, + "CustomizedMetricSpecification":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace", + "Statistic" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"The name of the metric.
" + }, + "Namespace":{ + "shape":"MetricNamespace", + "documentation":"The namespace of the metric.
" + }, + "Dimensions":{ + "shape":"MetricDimensions", + "documentation":"The dimensions of the metric.
" + }, + "Statistic":{ + "shape":"MetricStatistic", + "documentation":"The statistic of the metric.
" + }, + "Unit":{ + "shape":"MetricUnit", + "documentation":"The unit of the metric.
" + } + }, + "documentation":"Configures a customized metric for a target tracking policy.
" }, "DeleteAutoScalingGroupType":{ "type":"structure", @@ -1460,12 +1507,14 @@ "shape":"ForceDelete", "documentation":"Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
" } - } + }, + "documentation":"Contains the parameters for DeleteAutoScalingGroup.
" }, "DeleteLifecycleHookAnswer":{ "type":"structure", "members":{ - } + }, + "documentation":"Contains the output of DeleteLifecycleHook.
" }, "DeleteLifecycleHookType":{ "type":"structure", @@ -1482,7 +1531,8 @@ "shape":"ResourceName", "documentation":"The name of the Auto Scaling group for the lifecycle hook.
" } - } + }, + "documentation":"Contains the parameters for DeleteLifecycleHook.
" }, "DeleteNotificationConfigurationType":{ "type":"structure", @@ -1499,7 +1549,8 @@ "shape":"ResourceName", "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
" } - } + }, + "documentation":"Contains the parameters for DeleteNotificationConfiguration.
" }, "DeletePolicyType":{ "type":"structure", @@ -1513,7 +1564,8 @@ "shape":"ResourceName", "documentation":"The name or Amazon Resource Name (ARN) of the policy.
" } - } + }, + "documentation":"Contains the parameters for DeletePolicy.
" }, "DeleteScheduledActionType":{ "type":"structure", @@ -1530,7 +1582,8 @@ "shape":"ResourceName", "documentation":"The name of the action to delete.
" } - } + }, + "documentation":"Contains the parameters for DeleteScheduledAction.
" }, "DeleteTagsType":{ "type":"structure", @@ -1540,7 +1593,8 @@ "shape":"Tags", "documentation":"One or more tags.
" } - } + }, + "documentation":"Contains the parameters for DeleteTags.
" }, "DescribeAccountLimitsAnswer":{ "type":"structure", @@ -1561,7 +1615,8 @@ "shape":"NumberOfLaunchConfigurations", "documentation":"The current number of launch configurations for your AWS account.
" } - } + }, + "documentation":"Contains the parameters for DescribeAccountLimits.
" }, "DescribeAdjustmentTypesAnswer":{ "type":"structure", @@ -1570,7 +1625,8 @@ "shape":"AdjustmentTypes", "documentation":"The policy adjustment types.
" } - } + }, + "documentation":"Contains the parameters for DescribeAdjustmentTypes.
" }, "DescribeAutoScalingInstancesType":{ "type":"structure", @@ -1587,7 +1643,8 @@ "shape":"XmlString", "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" } - } + }, + "documentation":"Contains the parameters for DescribeAutoScalingInstances.
" }, "DescribeAutoScalingNotificationTypesAnswer":{ "type":"structure", @@ -1596,7 +1653,8 @@ "shape":"AutoScalingNotificationTypes", "documentation":"The notification types.
" } - } + }, + "documentation":"Contains the output of DescribeAutoScalingNotificationTypes.
" }, "DescribeLifecycleHookTypesAnswer":{ "type":"structure", @@ -1605,7 +1663,8 @@ "shape":"AutoScalingNotificationTypes", "documentation":"The lifecycle hook types.
" } - } + }, + "documentation":"Contains the output of DescribeLifecycleHookTypes.
" }, "DescribeLifecycleHooksAnswer":{ "type":"structure", @@ -1614,7 +1673,8 @@ "shape":"LifecycleHooks", "documentation":"The lifecycle hooks for the specified group.
" } - } + }, + "documentation":"Contains the output of DescribeLifecycleHooks.
" }, "DescribeLifecycleHooksType":{ "type":"structure", @@ -1628,7 +1688,8 @@ "shape":"LifecycleHookNames", "documentation":"The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.
" } - } + }, + "documentation":"Contains the parameters for DescribeLifecycleHooks.
" }, "DescribeLoadBalancerTargetGroupsRequest":{ "type":"structure", @@ -1646,7 +1707,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribeLoadBalancerTargetGroups.
" }, "DescribeLoadBalancerTargetGroupsResponse":{ "type":"structure", @@ -1659,7 +1721,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribeLoadBalancerTargetGroups.
" }, "DescribeLoadBalancersRequest":{ "type":"structure", @@ -1677,7 +1740,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribeLoadBalancers.
" }, "DescribeLoadBalancersResponse":{ "type":"structure", @@ -1690,7 +1754,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribeLoadBalancers.
" }, "DescribeMetricCollectionTypesAnswer":{ "type":"structure", @@ -1703,7 +1768,8 @@ "shape":"MetricGranularityTypes", "documentation":"The granularities for the metrics.
" } - } + }, + "documentation":"Contains the output of DescribeMetricsCollectionTypes.
" }, "DescribeNotificationConfigurationsAnswer":{ "type":"structure", @@ -1717,7 +1783,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output from DescribeNotificationConfigurations.
" }, "DescribeNotificationConfigurationsType":{ "type":"structure", @@ -1734,7 +1801,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribeNotificationConfigurations.
" }, "DescribePoliciesType":{ "type":"structure", @@ -1759,7 +1827,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribePolicies.
" }, "DescribeScalingActivitiesType":{ "type":"structure", @@ -1780,7 +1849,8 @@ "shape":"XmlString", "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" } - } + }, + "documentation":"Contains the parameters for DescribeScalingActivities.
" }, "DescribeScheduledActionsType":{ "type":"structure", @@ -1809,7 +1879,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribeScheduledActions.
" }, "DescribeTagsType":{ "type":"structure", @@ -1826,7 +1897,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribeTags.
" }, "DescribeTerminationPolicyTypesAnswer":{ "type":"structure", @@ -1835,7 +1907,8 @@ "shape":"TerminationPolicies", "documentation":"The termination policies supported by Auto Scaling (OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, and Default).
Contains the output of DescribeTerminationPolicyTypes.
" }, "DetachInstancesAnswer":{ "type":"structure", @@ -1844,7 +1917,8 @@ "shape":"Activities", "documentation":"The activities related to detaching the instances from the Auto Scaling group.
" } - } + }, + "documentation":"Contains the output of DetachInstances.
" }, "DetachInstancesQuery":{ "type":"structure", @@ -1865,7 +1939,8 @@ "shape":"ShouldDecrementDesiredCapacity", "documentation":"If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
Contains the parameters for DetachInstances.
" }, "DetachLoadBalancerTargetGroupsResultType":{ "type":"structure", @@ -1892,7 +1967,8 @@ "DetachLoadBalancersResultType":{ "type":"structure", "members":{ - } + }, + "documentation":"Contains the output for DetachLoadBalancers.
" }, "DetachLoadBalancersType":{ "type":"structure", @@ -1909,7 +1985,8 @@ "shape":"LoadBalancerNames", "documentation":"One or more load balancer names.
" } - } + }, + "documentation":"Contains the parameters for DetachLoadBalancers.
" }, "DisableMetricsCollectionQuery":{ "type":"structure", @@ -1923,8 +2000,10 @@ "shape":"Metrics", "documentation":"One or more of the following metrics. If you omit this parameter, all metrics are disabled.
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Contains the parameters for DisableMetricsCollection.
" }, + "DisableScaleIn":{"type":"boolean"}, "Ebs":{ "type":"structure", "members":{ @@ -1975,7 +2054,8 @@ "shape":"XmlStringMaxLen255", "documentation":"The granularity to associate with the metrics to collect. The only valid value is 1Minute.
Contains the parameters for EnableMetricsCollection.
" }, "EnabledMetric":{ "type":"structure", @@ -2002,7 +2082,8 @@ "shape":"Activities", "documentation":"The activities related to moving instances into Standby mode.
Contains the output of EnterStandby.
" }, "EnterStandbyQuery":{ "type":"structure", @@ -2023,7 +2104,8 @@ "shape":"ShouldDecrementDesiredCapacity", "documentation":"Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.
Contains the parameters for EnteStandby.
" }, "EstimatedInstanceWarmup":{"type":"integer"}, "ExecutePolicyType":{ @@ -2050,7 +2132,8 @@ "shape":"MetricScale", "documentation":"The breach threshold for the alarm.
This parameter is required if the policy type is StepScaling and not supported otherwise.
Contains the parameters for ExecutePolicy.
" }, "ExitStandbyAnswer":{ "type":"structure", @@ -2059,7 +2142,8 @@ "shape":"Activities", "documentation":"The activities related to moving instances out of Standby mode.
Contains the parameters for ExitStandby.
" }, "ExitStandbyQuery":{ "type":"structure", @@ -2073,7 +2157,8 @@ "shape":"ResourceName", "documentation":"The name of the Auto Scaling group.
" } - } + }, + "documentation":"Contains the parameters for ExitStandby.
" }, "Filter":{ "type":"structure", @@ -2145,10 +2230,10 @@ "members":{ "Enabled":{ "shape":"MonitoringEnabled", - "documentation":"If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
If True, instance monitoring is enabled.
Describes whether detailed monitoring is enabled for the Auto Scaling instances.
" + "documentation":"Describes whether instance monitoring is enabled.
" }, "InstanceProtected":{"type":"boolean"}, "Instances":{ @@ -2267,7 +2352,8 @@ "shape":"ResourceName", "documentation":"The name of the launch configuration.
" } - } + }, + "documentation":"Contains the parameters for DeleteLaunchConfiguration.
" }, "LaunchConfigurationNames":{ "type":"list", @@ -2288,7 +2374,8 @@ "shape":"MaxRecords", "documentation":"The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
" } - } + }, + "documentation":"Contains the parameters for DescribeLaunchConfigurations.
" }, "LaunchConfigurations":{ "type":"list", @@ -2306,7 +2393,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribeLaunchConfigurations.
" }, "LifecycleActionResult":{"type":"string"}, "LifecycleActionToken":{ @@ -2358,7 +2446,8 @@ }, "LifecycleHookNames":{ "type":"list", - "member":{"shape":"AsciiStringMaxLen255"} + "member":{"shape":"AsciiStringMaxLen255"}, + "max":50 }, "LifecycleHooks":{ "type":"list", @@ -2456,6 +2545,30 @@ "type":"list", "member":{"shape":"MetricCollectionType"} }, + "MetricDimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"MetricDimensionName", + "documentation":"The name of the dimension.
" + }, + "Value":{ + "shape":"MetricDimensionValue", + "documentation":"The value of the dimension.
" + } + }, + "documentation":"Describes the dimension of a metric.
" + }, + "MetricDimensionName":{"type":"string"}, + "MetricDimensionValue":{"type":"string"}, + "MetricDimensions":{ + "type":"list", + "member":{"shape":"MetricDimension"} + }, "MetricGranularityType":{ "type":"structure", "members":{ @@ -2470,7 +2583,29 @@ "type":"list", "member":{"shape":"MetricGranularityType"} }, + "MetricName":{"type":"string"}, + "MetricNamespace":{"type":"string"}, "MetricScale":{"type":"double"}, + "MetricStatistic":{ + "type":"string", + "enum":[ + "Average", + "Minimum", + "Maximum", + "SampleCount", + "Sum" + ] + }, + "MetricType":{ + "type":"string", + "enum":[ + "ASGAverageCPUUtilization", + "ASGAverageNetworkIn", + "ASGAverageNetworkOut", + "ALBRequestCountPerTarget" + ] + }, + "MetricUnit":{"type":"string"}, "Metrics":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"} @@ -2523,7 +2658,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribePolicies.
" }, "PolicyARNType":{ "type":"structure", @@ -2531,8 +2667,13 @@ "PolicyARN":{ "shape":"ResourceName", "documentation":"The Amazon Resource Name (ARN) of the policy.
" + }, + "Alarms":{ + "shape":"Alarms", + "documentation":"The CloudWatch alarms created for the target tracking policy. This parameter will be empty if the policy type is anything other than TargetTrackingScaling.
Contains the output of PutScalingPolicy.
" }, "PolicyIncrement":{"type":"integer"}, "PolicyNames":{ @@ -2543,6 +2684,21 @@ "type":"list", "member":{"shape":"XmlStringMaxLen64"} }, + "PredefinedMetricSpecification":{ + "type":"structure", + "required":["PredefinedMetricType"], + "members":{ + "PredefinedMetricType":{ + "shape":"MetricType", + "documentation":"The metric type.
" + }, + "ResourceLabel":{ + "shape":"XmlStringMaxLen1023", + "documentation":"Identifies the resource associated with the metric type. For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
Configures a predefined metric for a target tracking policy. The following predefined metrics are available:
ASGAverageCPUUtilization - average CPU utilization of the Auto Scaling group
ASGAverageNetworkIn - average number of bytes received on all network interfaces by the Auto Scaling group
ASGAverageNetworkOut - average number of bytes sent out on all network interfaces by the Auto Scaling group
ALBRequestCountPerTarget - number of requests completed per target in an Application Load Balancer target group
The names of the process types.
" } - } + }, + "documentation":"Contains the output of DescribeScalingProcessTypes.
" }, "Progress":{"type":"integer"}, "PropagateAtLaunch":{"type":"boolean"}, @@ -2577,7 +2734,8 @@ "PutLifecycleHookAnswer":{ "type":"structure", "members":{ - } + }, + "documentation":"Contains the output of PutLifecycleHook.
" }, "PutLifecycleHookType":{ "type":"structure", @@ -2618,7 +2776,8 @@ "shape":"LifecycleActionResult", "documentation":"Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.
Contains the parameters for PutLifecycleHook.
" }, "PutNotificationConfigurationType":{ "type":"structure", @@ -2640,14 +2799,14 @@ "shape":"AutoScalingNotificationTypes", "documentation":"The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.
" } - } + }, + "documentation":"Contains the parameters for PutNotificationConfiguration.
" }, "PutScalingPolicyType":{ "type":"structure", "required":[ "AutoScalingGroupName", - "PolicyName", - "AdjustmentType" + "PolicyName" ], "members":{ "AutoScalingGroupName":{ @@ -2660,11 +2819,11 @@ }, "PolicyType":{ "shape":"XmlStringMaxLen64", - "documentation":"The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.
The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
For more information, see Dynamic Scaling in the Auto Scaling User Guide.
" + "documentation":"The adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
This parameter is supported if the policy type is SimpleScaling or StepScaling.
For more information, see Dynamic Scaling in the Auto Scaling User Guide.
" }, "MinAdjustmentStep":{ "shape":"MinAdjustmentStep", @@ -2672,7 +2831,7 @@ }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", - "documentation":"The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
This parameter is supported if the policy type is SimpleScaling or StepScaling.
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is SimpleScaling.
For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
" + "documentation":"The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is supported if the policy type is SimpleScaling.
For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
" }, "MetricAggregationType":{ "shape":"XmlStringMaxLen32", - "documentation":"The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
This parameter is not supported if the policy type is SimpleScaling.
The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
This parameter is supported if the policy type is StepScaling.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is SimpleScaling.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is supported if the policy type is StepScaling or TargetTrackingScaling.
The configuration of a target tracking policy.
This parameter is required if the policy type is TargetTrackingScaling and not supported otherwise.
Contains the parameters for PutScalingPolicy.
" }, "PutScheduledUpdateGroupActionType":{ "type":"structure", @@ -2739,12 +2903,14 @@ "shape":"AutoScalingGroupDesiredCapacity", "documentation":"The number of EC2 instances that should be running in the group.
" } - } + }, + "documentation":"Contains the parameters for PutScheduledUpdateGroupAction.
" }, "RecordLifecycleActionHeartbeatAnswer":{ "type":"structure", "members":{ - } + }, + "documentation":"Contains the output of RecordLifecycleActionHeartBeat.
" }, "RecordLifecycleActionHeartbeatType":{ "type":"structure", @@ -2769,7 +2935,8 @@ "shape":"XmlStringMaxLen19", "documentation":"The ID of the instance.
" } - } + }, + "documentation":"Contains the parameters for RecordLifecycleActionHeartbeat.
" }, "ResourceContentionFault":{ "type":"structure", @@ -2883,7 +3050,7 @@ }, "Cooldown":{ "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
" + "documentation":"The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
" }, "StepAdjustments":{ "shape":"StepAdjustments", @@ -2900,6 +3067,10 @@ "Alarms":{ "shape":"Alarms", "documentation":"The CloudWatch alarms related to the policy.
" + }, + "TargetTrackingConfiguration":{ + "shape":"TargetTrackingConfiguration", + "documentation":"A target tracking policy.
" } }, "documentation":"Describes a scaling policy.
" @@ -2916,7 +3087,8 @@ "shape":"ProcessNames", "documentation":"One or more of the following processes. If you omit this parameter, all processes are specified.
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
Contains the parameters for SuspendProcesses and ResumeProcesses.
" }, "ScheduledActionNames":{ "type":"list", @@ -2933,7 +3105,8 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribeScheduledActions.
" }, "ScheduledUpdateGroupAction":{ "type":"structure", @@ -3008,7 +3181,8 @@ "shape":"HonorCooldown", "documentation":"By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.
Contains the parameters for SetDesiredCapacity.
" }, "SetInstanceHealthQuery":{ "type":"structure", @@ -3029,12 +3203,14 @@ "shape":"ShouldRespectGracePeriod", "documentation":"If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.
For more information, see the description of the health check grace period for CreateAutoScalingGroup.
" } - } + }, + "documentation":"Contains the parameters for SetInstanceHealth.
" }, "SetInstanceProtectionAnswer":{ "type":"structure", "members":{ - } + }, + "documentation":"Contains the output of SetInstanceProtection.
" }, "SetInstanceProtectionQuery":{ "type":"structure", @@ -3056,7 +3232,8 @@ "shape":"ProtectedFromScaleIn", "documentation":"Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
" } - } + }, + "documentation":"Contains the parameters for SetInstanceProtection.
" }, "ShouldDecrementDesiredCapacity":{"type":"boolean"}, "ShouldRespectGracePeriod":{"type":"boolean"}, @@ -3190,12 +3367,36 @@ "shape":"XmlString", "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" } - } + }, + "documentation":"Contains the output of DescribeTags.
" }, "TargetGroupARNs":{ "type":"list", "member":{"shape":"XmlStringMaxLen511"} }, + "TargetTrackingConfiguration":{ + "type":"structure", + "required":["TargetValue"], + "members":{ + "PredefinedMetricSpecification":{ + "shape":"PredefinedMetricSpecification", + "documentation":"A predefined metric. You can specify either a predefined metric or a customized metric.
" + }, + "CustomizedMetricSpecification":{ + "shape":"CustomizedMetricSpecification", + "documentation":"A customized metric.
" + }, + "TargetValue":{ + "shape":"MetricScale", + "documentation":"The target value for the metric.
" + }, + "DisableScaleIn":{ + "shape":"DisableScaleIn", + "documentation":"If the parameter is true, then scale-in will be disabled for the target tracking policy, i.e. the target tracking policy will not scale in the Auto Scaling group. The default value is false.
" + } + }, + "documentation":"Represents a target tracking policy configuration.
" + }, "TerminateInstanceInAutoScalingGroupType":{ "type":"structure", "required":[ @@ -3211,7 +3412,8 @@ "shape":"ShouldDecrementDesiredCapacity", "documentation":"If true, terminating the instance also decrements the size of the Auto Scaling group.
Contains the parameters for TerminateInstanceInAutoScalingGroup.
" }, "TerminationPolicies":{ "type":"list", @@ -3274,7 +3476,8 @@ "shape":"InstanceProtected", "documentation":"Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
" } - } + }, + "documentation":"Contains the parameters for UpdateAutoScalingGroup.
" }, "Values":{ "type":"list", diff --git a/botocore/data/cognito-idp/2016-04-18/service-2.json b/botocore/data/cognito-idp/2016-04-18/service-2.json index 057e253e..154cef31 100644 --- a/botocore/data/cognito-idp/2016-04-18/service-2.json +++ b/botocore/data/cognito-idp/2016-04-18/service-2.json @@ -320,6 +320,9 @@ {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"UserNotFoundException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"InternalErrorException"} ], "documentation":"Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
" @@ -1872,11 +1875,11 @@ }, "AuthFlow":{ "shape":"AuthFlowType", - "documentation":"The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRPA and return the SRP variables to be used for next challenge execution.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRPA (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), DEVICE_KEY
For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), DEVICE_KEY
For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
" }, + "UsernameAttributes":{ + "shape":"UsernameAttributesListType", + "documentation":"Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
" + }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"A string representing the SMS verification message.
" @@ -3692,11 +3699,11 @@ "members":{ "AuthFlow":{ "shape":"AuthFlowType", - "documentation":"The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRPA and return the SRP variables to be used for next challenge execution.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH is not a valid value.
The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH is not a valid value.
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRPA (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), DEVICE_KEY
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), DEVICE_KEY
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
Specifies the attributes that are aliased in a user pool.
" }, + "UsernameAttributes":{ + "shape":"UsernameAttributesListType", + "documentation":"Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
" + }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"The contents of the SMS verification message.
" @@ -5572,6 +5583,17 @@ }, "documentation":"The user type.
" }, + "UsernameAttributeType":{ + "type":"string", + "enum":[ + "phone_number", + "email" + ] + }, + "UsernameAttributesListType":{ + "type":"list", + "member":{"shape":"UsernameAttributeType"} + }, "UsernameExistsException":{ "type":"structure", "members":{ diff --git a/botocore/data/discovery/2015-11-01/service-2.json b/botocore/data/discovery/2015-11-01/service-2.json index 9c721e06..7723b9c8 100644 --- a/botocore/data/discovery/2015-11-01/service-2.json +++ b/botocore/data/discovery/2015-11-01/service-2.json @@ -289,7 +289,7 @@ {"shape":"ServerInternalErrorException"}, {"shape":"OperationNotPermittedException"} ], - "documentation":"Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.
" + "documentation":"Begins the export of discovered data to an S3 bucket.
If you specify agentId in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports.
If you do not include an agentId filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day.
One or more unique identifiers used to query the status of an export request.
" }, + "filters":{ + "shape":"ExportFilters", + "documentation":"One or more filters.
AgentId - ID of the agent whose collected data will be exported
The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.
A single ExportFilter name. Supported filters: agentId.
A single agentId for a Discovery Agent. An agentId can be found using the DescribeAgents action. Typically an ADS agentId is in the form o-0123456789abcdef0.
Supported condition: EQUALS
Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
" + }, + "ExportFilters":{ + "type":"list", + "member":{"shape":"ExportFilter"} + }, "ExportIds":{ "type":"list", "member":{"shape":"ConfigurationsExportId"} @@ -904,26 +935,38 @@ "members":{ "exportId":{ "shape":"ConfigurationsExportId", - "documentation":"A unique identifier that you can use to query the export.
" + "documentation":"A unique identifier used to query an export.
" }, "exportStatus":{ "shape":"ExportStatus", - "documentation":"The status of the configuration data export. The status can succeed, fail, or be in-progress.
" + "documentation":"The status of the data export job.
" }, "statusMessage":{ "shape":"ExportStatusMessage", - "documentation":"Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.
" + "documentation":"A status message provided for API callers.
" }, "configurationsDownloadUrl":{ "shape":"ConfigurationsDownloadUrl", - "documentation":"A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.
" + "documentation":"A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
" }, "exportRequestTime":{ "shape":"ExportRequestTime", - "documentation":"The time that the configuration data export was initiated.
" + "documentation":"The time that the data export was initiated.
" + }, + "isTruncated":{ + "shape":"Boolean", + "documentation":"If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate.
The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.
The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.
Information regarding the export status of the discovered data. The value is an array of objects.
" + "documentation":"Information regarding the export status of discovered data. The value is an array of objects.
" }, "ExportRequestTime":{"type":"timestamp"}, "ExportStatus":{ @@ -1216,6 +1259,18 @@ "exportDataFormat":{ "shape":"ExportDataFormats", "documentation":"The file format for the returned export data. Default value is CSV.
If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.
The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.
" + }, + "endTime":{ + "shape":"TimeStamp", + "documentation":"The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.
" } } }, @@ -1224,7 +1279,7 @@ "members":{ "exportId":{ "shape":"ConfigurationsExportId", - "documentation":"A unique identifier used to query the status of an export request.
" + "documentation":"A unique identifier used to query the status of an export request.
" } } }, diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 7c30780a..86beeb23 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -433,6 +433,16 @@ "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
" }, + "CreateNetworkInterfacePermission":{ + "name":"CreateNetworkInterfacePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfacePermissionRequest"}, + "output":{"shape":"CreateNetworkInterfacePermissionResult"}, + "documentation":"Grants an AWS authorized partner account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single AWS account only, and only one account at a time.
" + }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ @@ -683,6 +693,16 @@ "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"Deletes the specified network interface. You must detach the network interface before you can delete it.
" }, + "DeleteNetworkInterfacePermission":{ + "name":"DeleteNetworkInterfacePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfacePermissionRequest"}, + "output":{"shape":"DeleteNetworkInterfacePermissionResult"}, + "documentation":"Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.
" + }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ @@ -1067,7 +1087,7 @@ }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, - "documentation":"Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
Describes the status of one or more instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
Describes a network interface attribute. You can specify only one attribute at a time.
" }, + "DescribeNetworkInterfacePermissions":{ + "name":"DescribeNetworkInterfacePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacePermissionsRequest"}, + "output":{"shape":"DescribeNetworkInterfacePermissionsResult"}, + "documentation":"Describes the permissions for your network interfaces.
" + }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ @@ -4497,6 +4527,45 @@ }, "documentation":"Contains the output of CreateNetworkAcl.
" }, + "CreateNetworkInterfacePermissionRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "Permission" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"The ID of the network interface.
" + }, + "AwsAccountId":{ + "shape":"String", + "documentation":"The AWS account ID.
" + }, + "AwsService":{ + "shape":"String", + "documentation":"The AWS service. Currently not supported.
" + }, + "Permission":{ + "shape":"InterfacePermissionType", + "documentation":"The type of permission to grant.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the permission for the network interface.
", + "locationName":"interfacePermission" + } + } + }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], @@ -5428,6 +5497,34 @@ }, "documentation":"Contains the parameters for DeleteNetworkAcl.
" }, + "DeleteNetworkInterfacePermissionRequest":{ + "type":"structure", + "required":["NetworkInterfacePermissionId"], + "members":{ + "NetworkInterfacePermissionId":{ + "shape":"String", + "documentation":"The ID of the network interface permission.
" + }, + "Force":{ + "shape":"Boolean", + "documentation":"Specify true to remove the permission even if the network interface is attached to an instance.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds, otherwise returns an error.
Contains the output of DescribeNetworkInterfaceAttribute.
" }, + "DescribeNetworkInterfacePermissionsRequest":{ + "type":"structure", + "members":{ + "NetworkInterfacePermissionIds":{ + "shape":"NetworkInterfacePermissionIdList", + "documentation":"One or more network interface permission IDs.
", + "locationName":"NetworkInterfacePermissionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The AWS account ID.
network-interface-permission.aws-service - The AWS service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
The token to request the next page of results.
" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.
The network interface permissions.
", + "locationName":"networkInterfacePermissions" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results.
", + "locationName":"nextToken" + } + } + }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ @@ -7466,7 +7601,7 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"One or more filters.
description - A description of the snapshot.
owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM consolew.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
One or more filters.
description - A description of the snapshot.
owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.
If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.
The ID of the network interface permission.
", + "locationName":"networkInterfacePermissionId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"The ID of the network interface.
", + "locationName":"networkInterfaceId" + }, + "AwsAccountId":{ + "shape":"String", + "documentation":"The AWS account ID.
", + "locationName":"awsAccountId" + }, + "AwsService":{ + "shape":"String", + "documentation":"The AWS service.
", + "locationName":"awsService" + }, + "Permission":{ + "shape":"InterfacePermissionType", + "documentation":"The type of permission.
", + "locationName":"permission" + }, + "PermissionState":{ + "shape":"NetworkInterfacePermissionState", + "documentation":"Information about the state of the permission.
", + "locationName":"permissionState" + } + }, + "documentation":"Describes a permission for a network interface.
" + }, + "NetworkInterfacePermissionIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "NetworkInterfacePermissionList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePermission", + "locationName":"item" + } + }, + "NetworkInterfacePermissionState":{ + "type":"structure", + "members":{ + "State":{ + "shape":"NetworkInterfacePermissionStateCode", + "documentation":"The state of the permission.
", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"A status message, if applicable.
", + "locationName":"statusMessage" + } + }, + "documentation":"Describes the state of a network interface permission.
" + }, + "NetworkInterfacePermissionStateCode":{ + "type":"string", + "enum":[ + "pending", + "granted", + "revoking", + "revoked" + ] + }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ diff --git a/botocore/data/iot/2015-05-28/paginators-1.json b/botocore/data/iot/2015-05-28/paginators-1.json index ea142457..cc1934b2 100644 --- a/botocore/data/iot/2015-05-28/paginators-1.json +++ b/botocore/data/iot/2015-05-28/paginators-1.json @@ -1,3 +1,70 @@ { - "pagination": {} + "pagination": { + "ListCACertificates": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "certificates" + }, + "ListCertificates": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "certificates" + }, + "ListCertificatesByCA": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "certificates" + }, + "ListOutgoingCertificates": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "outgoingCertificates" + }, + "ListPolicies": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "policies" + }, + "ListPolicyPrincipals": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "principals" + }, + "ListPrincipalPolicies": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "policies" + }, + "ListPrincipalThings": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "things" + }, + "ListThingTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "thingTypes" + }, + "ListThings": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "things" + }, + "ListTopicRules": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "rules" + } + } } diff --git a/botocore/data/kinesis/2013-12-02/paginators-1.json b/botocore/data/kinesis/2013-12-02/paginators-1.json index bd1c8603..f2b4e081 100644 --- a/botocore/data/kinesis/2013-12-02/paginators-1.json +++ b/botocore/data/kinesis/2013-12-02/paginators-1.json @@ -11,7 +11,9 @@ "StreamDescription.StreamName", "StreamDescription.StreamStatus", "StreamDescription.RetentionPeriodHours", - "StreamDescription.EnhancedMonitoring" + "StreamDescription.EnhancedMonitoring", + "StreamDescription.EncryptionType", + "StreamDescription.KeyId" ] }, "ListStreams": { diff --git a/botocore/data/lambda/2015-03-31/service-2.json b/botocore/data/lambda/2015-03-31/service-2.json index ba779306..1ecf85c5 100644 --- a/botocore/data/lambda/2015-03-31/service-2.json +++ b/botocore/data/lambda/2015-03-31/service-2.json @@ -327,9 +327,10 @@ "output":{"shape":"ListFunctionsResponse"}, "errors":[ {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} ], - "documentation":"Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions action.
If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
" + "documentation":"Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions action.
If you are using the versioning feature, you can list all of your functions or only $LATEST versions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
The name of the function. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
" }, "FunctionArn":{ - "shape":"FunctionArn", + "shape":"NameSpacedFunctionArn", "documentation":"The Amazon Resource Name (ARN) assigned to the function.
" }, "Runtime":{ @@ -1123,6 +1124,10 @@ "TracingConfig":{ "shape":"TracingConfigResponse", "documentation":"The parent object that contains your function's tracing settings.
" + }, + "MasterArn":{ + "shape":"FunctionArn", + "documentation":"Returns the ARN (Amazon Resource Name) of the master function.
" } }, "documentation":"A complex type that describes function metadata.
" @@ -1137,6 +1142,10 @@ "min":1, "pattern":"(arn:aws:lambda:)?([a-z]{2}-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" }, + "FunctionVersion":{ + "type":"string", + "enum":["ALL"] + }, "GetAccountSettingsRequest":{ "type":"structure", "members":{ @@ -1188,7 +1197,7 @@ "required":["FunctionName"], "members":{ "FunctionName":{ - "shape":"FunctionName", + "shape":"NamespacedFunctionName", "documentation":"The name of the Lambda function for which you want to retrieve the configuration information.
You can specify a 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 a partial ARN (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 characters in length.
The Lambda function name.
You can specify a 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 a partial ARN (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 characters in length.
Function name whose resource policy you want to retrieve.
You can specify the 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). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with 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 characters in length.
The Lambda function name.
You can specify a 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 a partial ARN (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 characters in length.
The Lambda function name. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
", "location":"uri", "locationName":"FunctionName" @@ -1587,6 +1596,18 @@ "ListFunctionsRequest":{ "type":"structure", "members":{ + "MasterRegion":{ + "shape":"MasterRegion", + "documentation":"Optional string. If not specified, will return only regular function versions (i.e., non-replicated versions).
Valid values are:
The region from which the functions are replicated. For example, if you specify us-east-1, only functions replicated from that region will be returned.
ALL _ Will return all functions from any region. If specified, you also must specify a valid FunctionVersion parameter.
Optional string. If not specified, only the unqualified functions ARNs (Amazon Resource Names) will be returned.
Valid value:
ALL _ Will return all versions, including $LATEST which will have fully qualified ARNs (Amazon Resource Names).
Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.
Function name whose versions to list. You can specify a 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 a partial ARN (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 characters in length.
Statement ID of the permission to remove.
", "location":"uri", "locationName":"StatementId" @@ -2129,7 +2170,7 @@ }, "Runtime":{ "shape":"Runtime", - "documentation":"The runtime environment for the Lambda function.
To use the Python runtime v3.6, set the value to \"python3.6\". To use the Python runtime v2.7, set the value to \"python2.7\". To use the Node.js runtime v6.10, set the value to \"nodejs6.10\". To use the Node.js runtime v4.3, set the value to \"nodejs4.3\". To use the Python runtime v3.6, set the value to \"python3.6\". To use the Python runtime v2.7, set the value to \"python2.7\".
Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. Failure to do so will result in an invalid parameter value error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.
The runtime environment for the Lambda function.
To use the Python runtime v3.6, set the value to \"python3.6\". To use the Python runtime v2.7, set the value to \"python2.7\". To use the Node.js runtime v6.10, set the value to \"nodejs6.10\". To use the Node.js runtime v4.3, set the value to \"nodejs4.3\". To use the Python runtime v3.6, set the value to \"python3.6\".
Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.
Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the operation.
If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful.
This operation requires permissions for the lex:DeleteBot action.
Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation.
If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful.
This operation requires permissions for the lex:DeleteBot action.
Deletes a specific version of a bot. To delete all versions of a bot, use the operation.
This operation requires permissions for the lex:DeleteBotVersion action.
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the lex:DeleteBotVersion action.
Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the operation.
You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.
If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful.
This operation requires permission for the lex:DeleteIntent action.
Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation.
You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.
If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful.
This operation requires permission for the lex:DeleteIntent action.
Deletes a specific version of an intent. To delete all versions of a intent, use the operation.
This operation requires permissions for the lex:DeleteIntentVersion action.
Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the lex:DeleteIntentVersion action.
Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the operation.
You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful.
This operation requires permission for the lex:DeleteSlotType action.
Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.
You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful.
This operation requires permission for the lex:DeleteSlotType action.
Deletes a specific version of a slot type. To delete all versions of a slot type, use the operation.
This operation requires permissions for the lex:DeleteSlotTypeVersion action.
Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.
This operation requires permissions for the lex:DeleteSlotTypeVersion action.
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot unless the childDirected field in the bot is set to true. Utterances are stored for 15 days for use with the operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.
Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user.
This operation requires permissions for the lex:DeleteUtterances action.
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot unless the childDirected field in the bot is set to true. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.
Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user.
This operation requires permissions for the lex:DeleteUtterances action.
Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.
If the bot's childDirected field is set to true, utterances for the bot are not stored and cannot be retrieved with the GetUtterancesView operation. For more information, see .
This operation requires permissions for the lex:GetUtterancesView action.
Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.
If the bot's childDirected field is set to true, utterances for the bot are not stored and cannot be retrieved with the GetUtterancesView operation. For more information, see PutBot.
This operation requires permissions for the lex:GetUtterancesView action.
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you only required to specify a name. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.
If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control.
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.
If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control.
An array of Intent objects. For more information, see .
An array of Intent objects. For more information, see PutBot.
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see .
" + "documentation":"The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
" }, "abortStatement":{ "shape":"Statement", - "documentation":"The message that Amazon Lex uses to abort a conversation. For more information, see .
" + "documentation":"The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
" }, "status":{ "shape":"Status", @@ -899,7 +899,7 @@ }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", - "documentation":"The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see .
" + "documentation":"The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
" }, "voiceId":{ "shape":"String", @@ -1135,7 +1135,7 @@ }, "version":{ "shape":"NumericalVersion", - "documentation":"The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the operation.
The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the DeleteBot operation.
The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the operation.
The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the DeleteIntent operation.
The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the operation.
The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the DeleteSlotType operation.
The unique identifier for the user that made the utterances. This is the user ID that was sent in the or operation request that contained the utterance.
", + "documentation":"The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance.
", "location":"uri", "locationName":"userId" } @@ -1259,14 +1259,14 @@ "members":{ "prompt":{ "shape":"Prompt", - "documentation":"Obtains information from the user.
" + "documentation":"Prompts for information from the user.
" }, "rejectionStatement":{ "shape":"Statement", - "documentation":"If the user answers \"no\" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
If the user answers \"no\" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
After an intent is fulfilled, you might prompt the user for additional activity. For example, after the OrderPizza intent is fulfilled (the pizza order is placed with a pizzeria), you might prompt the user to find out whether the user wants to order drinks (another intent you defined in your bot).
A prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.
An array of intent objects. For more information, see .
An array of intent objects. For more information, see PutBot.
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see .
" + "documentation":"The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
" }, "abortStatement":{ "shape":"Statement", - "documentation":"The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see .
" + "documentation":"The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
" }, "status":{ "shape":"Status", @@ -1562,11 +1562,11 @@ }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", - "documentation":"The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see .
" + "documentation":"The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
" }, "voiceId":{ "shape":"String", - "documentation":"The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see .
" + "documentation":"The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
" }, "checksum":{ "shape":"String", @@ -1814,7 +1814,7 @@ }, "confirmationPrompt":{ "shape":"Prompt", - "documentation":"If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see .
" + "documentation":"If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
" }, "rejectionStatement":{ "shape":"Statement", @@ -1822,7 +1822,7 @@ }, "followUpPrompt":{ "shape":"FollowUpPrompt", - "documentation":"If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see .
" + "documentation":"If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.
" }, "conclusionStatement":{ "shape":"Statement", @@ -1830,11 +1830,11 @@ }, "dialogCodeHook":{ "shape":"CodeHook", - "documentation":"If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see .
" + "documentation":"If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
" }, "fulfillmentActivity":{ "shape":"FulfillmentActivity", - "documentation":"Describes how the intent is fulfilled. For more information, see .
" + "documentation":"Describes how the intent is fulfilled. For more information, see PutIntent.
" }, "parentIntentSignature":{ "shape":"BuiltinIntentSignature", @@ -1923,7 +1923,7 @@ "members":{ "intents":{ "shape":"IntentMetadataList", - "documentation":"An array of Intent objects. For more information, see .
An array of Intent objects. For more information, see PutBot.
An array of objects, each containing a list of objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version.
An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version.
When Amazon Lex doesn't understand the user's intent, it uses one of these messages to get clarification. For example, \"Sorry, I didn't understand. Please repeat.\" Amazon Lex repeats the clarification prompt the number of times specified in maxAttempts. If Amazon Lex still can't understand, it sends the message specified in abortStatement.
When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeate the clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field.
When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: \"What would you like to do? You can say 'Order a pizza' or 'Order a drink.'\"
" }, "abortStatement":{ "shape":"Statement", @@ -2419,7 +2419,7 @@ }, "voiceId":{ "shape":"String", - "documentation":"The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Voice in the Amazon Polly Developer Guide.
" + "documentation":"The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
" }, "checksum":{ "shape":"String", @@ -2452,15 +2452,15 @@ }, "intents":{ "shape":"IntentList", - "documentation":"An array of Intent objects. For more information, see .
An array of Intent objects. For more information, see PutBot.
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see .
" + "documentation":"The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
" }, "abortStatement":{ "shape":"Statement", - "documentation":"The message that Amazon Lex uses to abort a conversation. For more information, see .
" + "documentation":"The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
" }, "status":{ "shape":"Status", @@ -2480,11 +2480,11 @@ }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", - "documentation":"The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see .
" + "documentation":"The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
" }, "voiceId":{ "shape":"String", - "documentation":"The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see .
" + "documentation":"The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
" }, "checksum":{ "shape":"String", @@ -2536,7 +2536,7 @@ }, "followUpPrompt":{ "shape":"FollowUpPrompt", - "documentation":"A user prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled (your Lambda function placed an order with a pizzeria), you might prompt the user to find if they want to order a drink (assuming that you have defined an OrderDrink intent in your bot).
The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one. For example, your bot may not solicit both the following:
Follow up prompt - \"$session.FirstName, your pizza order has been placed. Would you like to order a drink or a dessert?\"
Conclusion statement - \"$session.FirstName, your pizza order has been placed.\"
Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.
The action that Amazon Lex takes depends on the user's response, as follows:
If the user says \"Yes\" it responds with the clarification prompt that is configured for the bot.
if the user says \"Yes\" and continues with an utterance that triggers an intent it starts a conversation for the intent.
If the user says \"No\" it responds with the rejection statement configured for the the follow-up prompt.
If it doesn't recognize the utterance it repeats the follow-up prompt again.
The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.
At runtime, if the client is using the API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
" + "documentation":"At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
" } }, "documentation":"A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.
" @@ -2910,7 +2910,7 @@ }, "utterances":{ "shape":"ListOfUtterance", - "documentation":"One or more objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.
" + "documentation":"One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.
" } }, "documentation":"Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.
" diff --git a/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json b/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json index 17753cf6..e6107700 100644 --- a/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json +++ b/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json @@ -96,7 +96,7 @@ "members":{ "dataSetType":{ "shape":"DataSetType", - "documentation":"The desired data set type.
The desired data set type.
From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.
From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior.
From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior.
From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior.
From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior.
From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.
From 2012-04-19 to 2015-01-25: Available every 30 days by 5:00 PM Pacific Time.
From 2015-01-26 to present: This data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.
From 2012-09-04 to present: Available every 30 days by 5:00 PM Pacific Time.
From 2012-04-19 to present: Available every 30 days by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.
From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.
From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.
From 2017-06-30 to present: This data set is no longer available.
From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.
From 2017-06-30 to present: This data set is no longer available.
From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.
From 2017-06-30 to present: This data set is no longer available.
From 2016-12 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior, and up-front software charges (e.g. annual) from one month prior.
From 2017-06 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.
From 2017-02-15 to present: Available monthly on the 15th day of the month by 5:00 PM Pacific Time.
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide.
", "operations":{ "CountClosedWorkflowExecutions":{ "name":"CountClosedWorkflowExecutions", @@ -21,23 +20,12 @@ "requestUri":"/" }, "input":{"shape":"CountClosedWorkflowExecutionsInput"}, - "output":{ - "shape":"WorkflowExecutionCount", - "documentation":"Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
" - }, + "output":{"shape":"WorkflowExecutionCount"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
typeFilter.name: String constraint. The key is swf:typeFilter.name.
typeFilter.version: String constraint. The key is swf:typeFilter.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
" - }, + "output":{"shape":"WorkflowExecutionCount"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
typeFilter.name: String constraint. The key is swf:typeFilter.name.
typeFilter.version: String constraint. The key is swf:typeFilter.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains the count of tasks in a task list.
" - }, + "output":{"shape":"PendingTaskCount"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains the count of tasks in a task list.
" - }, + "output":{"shape":"PendingTaskCount"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"TypeDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"TypeDeprecatedFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
activityType.name: String constraint. The key is swf:activityType.name.
activityType.version: String constraint. The key is swf:activityType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"DomainDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified domain has been deprecated.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"DomainDeprecatedFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"TypeDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"TypeDeprecatedFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
workflowType.name: String constraint. The key is swf:workflowType.name.
workflowType.version: String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Detailed information about an activity type.
" - }, + "output":{"shape":"ActivityTypeDetail"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
activityType.name: String constraint. The key is swf:activityType.name.
activityType.version: String constraint. The key is swf:activityType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains details of a domain.
" - }, + "output":{"shape":"DomainDetail"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns information about the specified domain, including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns information about the specified domain, including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains details about a workflow execution.
" - }, + "output":{"shape":"WorkflowExecutionDetail"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns information about the specified workflow execution including its type and some statistics.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns information about the specified workflow execution including its type and some statistics.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains details about a workflow type.
" - }, + "output":{"shape":"WorkflowTypeDetail"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
workflowType.name: String constraint. The key is swf:workflowType.name.
workflowType.version: String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.
" - }, + "output":{"shape":"History"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains a paginated list of activity type information structures.
" - }, + "output":{"shape":"ActivityTypeInfos"}, "errors":[ - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - } + {"shape":"OperationNotPermittedFault"}, + {"shape":"UnknownResourceFault"} ], - "documentation":"Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains a paginated list of information about workflow executions.
" - }, + "output":{"shape":"WorkflowExecutionInfos"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
typeFilter.name: String constraint. The key is swf:typeFilter.name.
typeFilter.version: String constraint. The key is swf:typeFilter.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains a paginated collection of DomainInfo structures.
" - }, + "output":{"shape":"DomainInfos"}, "errors":[ - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains a paginated list of information about workflow executions.
" - }, + "output":{"shape":"WorkflowExecutionInfos"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
typeFilter.name: String constraint. The key is swf:typeFilter.name.
typeFilter.version: String constraint. The key is swf:typeFilter.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Contains a paginated list of information structures about workflow types.
" - }, + "output":{"shape":"WorkflowTypeInfos"}, "errors":[ - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - } + {"shape":"OperationNotPermittedFault"}, + {"shape":"UnknownResourceFault"} ], - "documentation":"Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Unit of work sent to an activity worker.
" - }, + "output":{"shape":"ActivityTask"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"}, + {"shape":"LimitExceededFault"} ], - "documentation":"Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.
Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.
" - }, + "output":{"shape":"DecisionTask"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"}, + {"shape":"LimitExceededFault"} ], - "documentation":"Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Status information about an activity task.
" - }, + "output":{"shape":"ActivityTaskStatus"}, "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.
This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.
This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.
taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.
This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.
This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.
The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.
This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"TypeAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Registers a new activity type along with its configuration settings in the specified domain.
TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Registers a new activity type along with its configuration settings in the specified domain.
A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
name: String constraint. The key is swf:name.
version: String constraint. The key is swf:version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"DomainAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Registers a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Registers a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"TypeAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
name: String constraint. The key is swf:name.
version: String constraint. The key is swf:version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.
Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.
These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.
canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.
These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.
Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.
canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.
If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.
A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.
Access Control
If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows.
Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.
A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.
Access Control
If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).
WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.UnknownResource.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).
If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.
If the specified workflow execution isn't open, this method fails with UnknownResource.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Specifies the runId of a workflow execution.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"TypeDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" - }, - { - "shape":"WorkflowExecutionAlreadyStartedFault", - "exception":true, - "documentation":"Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"DefaultUndefinedFault", - "exception":true - } + {"shape":"UnknownResourceFault"}, + {"shape":"TypeDeprecatedFault"}, + {"shape":"WorkflowExecutionAlreadyStartedFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"OperationNotPermittedFault"}, + {"shape":"DefaultUndefinedFault"} ], - "documentation":"Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0.tagList.member.1: The key is swf:tagList.member.1.tagList.member.2: The key is swf:tagList.member.2.tagList.member.3: The key is swf:tagList.member.3.tagList.member.4: The key is swf:tagList.member.4.taskList: String constraint. The key is swf:taskList.name.workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
tagList.member.0: The key is swf:tagList.member.0.
tagList.member.1: The key is swf:tagList.member.1.
tagList.member.2: The key is swf:tagList.member.2.
tagList.member.3: The key is swf:tagList.member.3.
tagList.member.4: The key is swf:tagList.member.4.
taskList: String constraint. The key is swf:taskList.name.
workflowType.name: String constraint. The key is swf:workflowType.name.
workflowType.version: String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} ], - "documentation":"Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.
WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.
If the identified workflow execution was in progress, it is terminated immediately.
If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.
You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The unique ID of the task.
" } }, - "documentation":"Provides details of the ActivityTaskCancelRequested event.
Provides the details of the ActivityTaskCancelRequested event.
Details of the cancellation (if any).
" + "documentation":"Details of the cancellation.
" }, "scheduledEventId":{ "shape":"EventId", @@ -887,7 +533,7 @@ "documentation":"If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskCanceled event.
Provides the details of the ActivityTaskCanceled event.
The results of the activity task (if any).
" + "documentation":"The results of the activity task.
" }, "scheduledEventId":{ "shape":"EventId", @@ -909,7 +555,7 @@ "documentation":"The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskCompleted event.
Provides the details of the ActivityTaskCompleted event.
The reason provided for the failure (if any).
" + "documentation":"The reason provided for the failure.
" }, "details":{ "shape":"Data", - "documentation":"The details of the failure (if any).
" + "documentation":"The details of the failure.
" }, "scheduledEventId":{ "shape":"EventId", @@ -935,7 +581,7 @@ "documentation":"The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskFailed event.
Provides the details of the ActivityTaskFailed event.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
" + "documentation":"Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.
" }, "scheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", @@ -980,7 +626,7 @@ }, "taskPriority":{ "shape":"TaskPriority", - "documentation":"Optional. The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":"The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "decisionTaskCompletedEventId":{ "shape":"EventId", @@ -988,10 +634,10 @@ }, "heartbeatTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.
" + "documentation":"The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.
" } }, - "documentation":"Provides details of the ActivityTaskScheduled event.
Provides the details of the ActivityTaskScheduled event.
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskStarted event.
Provides the details of the ActivityTaskStarted event.
Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.
Provides details of the ActivityTaskTimedOut event.
Provides the details of the ActivityTaskTimedOut event.
The name of this activity.
The name of this activity.
The combination of activity type name and version must be unique within a domain.
The version of this activity.
The version of this activity.
The combination of activity type name and version must be unique with in a domain.
Represents an activity type.
" @@ -1078,27 +724,27 @@ "members":{ "defaultTaskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":" The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.
The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.
Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then \"0\" will be used as the default priority. This default can be overridden when scheduling an activity task.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":" The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "defaultTaskScheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":" The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":" The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Configuration settings registered with the activity type.
" @@ -1112,7 +758,7 @@ "members":{ "typeInfo":{ "shape":"ActivityTypeInfo", - "documentation":"General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
REGISTERED – The type is registered and available. Workers supporting this type should be running.
DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.
Required. The unique ID of the timer to cancel.
" + "documentation":"The unique ID of the timer to cancel.
" } }, - "documentation":"Provides details of the CancelTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the CancelTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the CancelTimerFailed event.
Provides the details of the CancelTimerFailed event.
Optional. details of the cancellation.
" + "documentation":"Details of the cancellation.
" } }, - "documentation":"Provides details of the CancelWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the CancelWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the CancelWorkflowExecutionFailed event.
Provides the details of the CancelWorkflowExecutionFailed event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The result of the child workflow execution (if any).
" + "documentation":"The result of the child workflow execution.
" }, "initiatedEventId":{ "shape":"EventId", - "documentation":"The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionCompleted event.
Provides the details of the ChildWorkflowExecutionCompleted event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionFailed event.
Provides the details of the ChildWorkflowExecutionFailed event.
The type of the child workflow execution.
" + "documentation":"The type of the child workflow execution.
" }, "initiatedEventId":{ "shape":"EventId", - "documentation":"The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionStarted event.
Provides the details of the ChildWorkflowExecutionStarted event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionTerminated event.
Provides the details of the ChildWorkflowExecutionTerminated event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionTimedOut event.
Provides the details of the ChildWorkflowExecutionTimedOut event.
Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.
" + "documentation":"The close status that must match the close status of an execution for it to meet the criteria of this filter.
" } }, "documentation":"Used to filter the closed workflow executions in visibility APIs by their close status.
" @@ -1479,7 +1125,7 @@ "documentation":"The result of the workflow execution. The form of the result is implementation defined.
" } }, - "documentation":"Provides details of the CompleteWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the CompleteWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the CompleteWorkflowExecutionFailed event.
Provides the details of the CompleteWorkflowExecutionFailed event.
If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
The task list to use for the decisions of the new (continued) workflow execution.
" }, - "taskList":{"shape":"TaskList"}, "taskPriority":{ "shape":"TaskPriority", - "documentation":"Optional. The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":" The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
" }, - "workflowTypeVersion":{"shape":"Version"}, + "workflowTypeVersion":{ + "shape":"Version", + "documentation":"The version of the workflow to start.
" + }, "lambdaRole":{ "shape":"Arn", - "documentation":"The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
The IAM role to attach to the new (continued) execution.
" } }, - "documentation":"Provides details of the ContinueAsNewWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tag: Optional.. A tag used to identify the workflow executiontaskList: String constraint. The key is swf:taskList.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the ContinueAsNewWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
tag – A tag used to identify the workflow execution
taskList – String constraint. The key is swf:taskList.name.
workflowType.version – String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ContinueAsNewWorkflowExecutionFailed event.
Provides the details of the ContinueAsNewWorkflowExecutionFailed event.
If specified, only workflow executions that meet the start time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, only workflow executions that meet the start time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
If specified, only workflow executions that meet the close time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, only workflow executions that meet the close time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
If specified, only workflow executions matching the WorkflowId in the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the WorkflowId in the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, indicates the type of the workflow executions to be counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, indicates the type of the workflow executions to be counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only executions that have a tag that matches the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have a tag that matches the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
Specifies the type of the workflow executions to be counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.Specifies the type of the workflow executions to be counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only executions that have a tag that matches the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have a tag that matches the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only workflow executions matching the WorkflowId in the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the WorkflowId in the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
Provides details of the ScheduleActivityTask decision. It is not set for other decision types.
Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types.
Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.
Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.
Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.
Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.
Provides details of the FailWorkflowExecution decision. It is not set for other decision types.
Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.
Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.
Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.
Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.
Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.
Provides details of the RecordMarker decision. It is not set for other decision types.
Provides the details of the RecordMarker decision. It isn't set for other decision types.
Provides details of the StartTimer decision. It is not set for other decision types.
Provides the details of the StartTimer decision. It isn't set for other decision types.
Provides details of the CancelTimer decision. It is not set for other decision types.
Provides the details of the CancelTimer decision. It isn't set for other decision types.
Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.
Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.
Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.
Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types.
Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.
Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.
Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types.
Specifies a decision made by the decider. A decision can be one of these types:
TimerCanceled event in the history.WorkflowExecutionCanceled event in the history.WorkflowExecutionCompleted event in the history .WorkflowExecutionContinuedAsNew event is recorded in the history.WorkflowExecutionFailed event in the history.MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they do not need to look at the history beyond the marker event.RequestCancelExternalWorkflowExecutionInitiated event in the history.SignalExternalWorkflowExecutionInitiated event in the history.StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.TimerStarted event in the history. This timer will fire after the specified delay and record a TimerFired event.Access Control
If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Decision Failure
Decisions can fail for several reasons
One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
workflowID specified in the decision was incorrect.workflowID specified in the decision was incorrect.The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.How to code a decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
Specifies a decision made by the decider. A decision can be one of these types:
CancelTimer – Cancels a previously started timer and records a TimerCanceled event in the history.
CancelWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCanceled event in the history.
CompleteWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCompleted event in the history .
ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.
FailWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionFailed event in the history.
RecordMarker – Records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they don't need to look at the history beyond the marker event.
RequestCancelActivityTask – Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already assigned to a worker, then the worker is informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.
RequestCancelExternalWorkflowExecution – Requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.
ScheduleActivityTask – Schedules an activity task.
SignalExternalWorkflowExecution – Requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.
StartChildWorkflowExecution – Requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.
StartTimer – Starts a timer for this workflow execution and records a TimerStarted event in the history. This timer fires after the specified delay and record a TimerFired event.
Access Control
If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Decision Failure
Decisions can fail for several reasons
The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.
A limit on your account was reached.
The decision lacks sufficient permissions.
One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't properly configured.
RequestCancelActivityTaskFailed – A RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.
StartTimerFailed – A StartTimer decision failed. This could happen if there is another open timer with the same timerId.
CancelTimerFailed – A CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.
StartChildWorkflowExecutionFailed – A StartChildWorkflowExecution decision failed. This could happen if the workflow type specified isn't registered, is deprecated, or the decision isn't properly configured.
SignalExternalWorkflowExecutionFailed – A SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.
RequestCancelExternalWorkflowExecutionFailed – A RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.
CancelWorkflowExecutionFailed – A CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
CompleteWorkflowExecutionFailed – A CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
ContinueAsNewWorkflowExecutionFailed – A ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.
FailWorkflowExecutionFailed – A FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault is returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.
How to Code a Decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the DecisionTaskCompleted event.
Provides the details of the DecisionTaskCompleted event.
Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":" A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Provides details about the DecisionTaskScheduled event.
The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the DecisionTaskStarted event.
Provides the details of the DecisionTaskStarted event.
The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the DecisionTaskTimedOut event.
Provides the details of the DecisionTaskTimedOut event.
The StartWorkflowExecution API action was called without the required parameters set.
Some workflow execution parameters, such as the decision taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow type.
If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.
A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.
" + "documentation":"Returned if the specified domain already exists. You get this fault even if the existing domain is in deprecated status.
", + "exception":true }, "DomainConfiguration":{ "type":"structure", @@ -2031,8 +1687,8 @@ "documentation":"A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned when the specified domain has been deprecated.
" + "documentation":"Returned when the specified domain has been deprecated.
", + "exception":true }, "DomainDetail":{ "type":"structure", @@ -2041,8 +1697,14 @@ "configuration" ], "members":{ - "domainInfo":{"shape":"DomainInfo"}, - "configuration":{"shape":"DomainConfiguration"} + "domainInfo":{ + "shape":"DomainInfo", + "documentation":"The basic information about a domain, such as its name, status, and description.
" + }, + "configuration":{ + "shape":"DomainConfiguration", + "documentation":"The domain configuration. Currently, this includes only the domain's retention period.
" + } }, "documentation":"Contains details of a domain.
" }, @@ -2059,7 +1721,7 @@ }, "status":{ "shape":"RegistrationStatus", - "documentation":"The status of the domain:
The status of the domain:
REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.
Specifies the latest start or close date and time to return.
" } }, - "documentation":"Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: \"oldestDate\": 1325376070.
Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: \"oldestDate\": 1325376070.
The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ExternalWorkflowExecutionCancelRequested event.
Provides the details of the ExternalWorkflowExecutionCancelRequested event.
The external workflow execution that the signal was delivered to.
" + "documentation":"The external workflow execution that the signal was delivered to.
" }, "initiatedEventId":{ "shape":"EventId", "documentation":"The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ExternalWorkflowExecutionSignaled event.
Provides the details of the ExternalWorkflowExecutionSignaled event.
Optional. Details of the failure.
" + "documentation":"Details of the failure.
" } }, - "documentation":"Provides details of the FailWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the FailWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the FailWorkflowExecutionFailed event.
Provides the details of the FailWorkflowExecutionFailed event.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + "documentation":"The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" }, "reverseOrder":{ "shape":"ReverseOrder", @@ -2349,201 +2011,222 @@ }, "workflowExecutionStartedEventAttributes":{ "shape":"WorkflowExecutionStartedEventAttributes", - "documentation":"If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.
Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.
Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.
Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.
Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types.
Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.
Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.
Event within a workflow execution. A history event can be one of these types:
RequestCancelActivityTask decision was received by the system.RecordMarker decision.StartTimer decision.Event within a workflow execution. A history event can be one of these types:
ActivityTaskCancelRequested – A RequestCancelActivityTask decision was received by the system.
ActivityTaskCanceled – The activity task was successfully canceled.
ActivityTaskCompleted – An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.
ActivityTaskFailed – An activity worker failed an activity task by calling RespondActivityTaskFailed.
ActivityTaskScheduled – An activity task was scheduled for execution.
ActivityTaskStarted – The scheduled activity task was dispatched to a worker.
ActivityTaskTimedOut – The activity task timed out.
CancelTimerFailed – Failed to process CancelTimer decision. This happens when the decision isn't configured properly, for example no timer exists with the specified timer Id.
CancelWorkflowExecutionFailed – A request to cancel a workflow execution failed.
ChildWorkflowExecutionCanceled – A child workflow execution, started by this workflow execution, was canceled and closed.
ChildWorkflowExecutionCompleted – A child workflow execution, started by this workflow execution, completed successfully and was closed.
ChildWorkflowExecutionFailed – A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.
ChildWorkflowExecutionStarted – A child workflow execution was successfully started.
ChildWorkflowExecutionTerminated – A child workflow execution, started by this workflow execution, was terminated.
ChildWorkflowExecutionTimedOut – A child workflow execution, started by this workflow execution, timed out and was closed.
CompleteWorkflowExecutionFailed – The workflow execution failed to complete.
ContinueAsNewWorkflowExecutionFailed – The workflow execution failed to complete after being continued as a new workflow execution.
DecisionTaskCompleted – The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.
DecisionTaskScheduled – A decision task was scheduled for the workflow execution.
DecisionTaskStarted – The decision task was dispatched to a decider.
DecisionTaskTimedOut – The decision task timed out.
ExternalWorkflowExecutionCancelRequested – Request to cancel an external workflow execution was successfully delivered to the target execution.
ExternalWorkflowExecutionSignaled – A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.
FailWorkflowExecutionFailed – A request to mark a workflow execution as failed, itself failed.
MarkerRecorded – A marker was recorded in the workflow history as the result of a RecordMarker decision.
RecordMarkerFailed – A RecordMarker decision was returned as failed.
RequestCancelActivityTaskFailed – Failed to process RequestCancelActivityTask decision. This happens when the decision isn't configured properly.
RequestCancelExternalWorkflowExecutionFailed – Request to cancel an external workflow execution failed.
RequestCancelExternalWorkflowExecutionInitiated – A request was made to request the cancellation of an external workflow execution.
ScheduleActivityTaskFailed – Failed to process ScheduleActivityTask decision. This happens when the decision isn't configured properly, for example the activity type specified isn't registered.
SignalExternalWorkflowExecutionFailed – The request to signal an external workflow execution failed.
SignalExternalWorkflowExecutionInitiated – A request to signal an external workflow was made.
StartActivityTaskFailed – A scheduled activity task failed to start.
StartChildWorkflowExecutionFailed – Failed to process StartChildWorkflowExecution decision. This happens when the decision isn't configured properly, for example the workflow type specified isn't registered.
StartChildWorkflowExecutionInitiated – A request was made to start a child workflow execution.
StartTimerFailed – Failed to process StartTimer decision. This happens when the decision isn't configured properly, for example a timer already exists with the specified timer Id.
TimerCanceled – A timer, previously started for this workflow execution, was successfully canceled.
TimerFired – A timer, previously started for this workflow execution, fired.
TimerStarted – A timer was started for the workflow execution due to a StartTimer decision.
WorkflowExecutionCancelRequested – A request to cancel this workflow execution was made.
WorkflowExecutionCanceled – The workflow execution was successfully canceled and closed.
WorkflowExecutionCompleted – The workflow execution was closed due to successful completion.
WorkflowExecutionContinuedAsNew – The workflow execution was closed and a new execution of the same type was created with the same workflowId.
WorkflowExecutionFailed – The workflow execution closed due to a failure.
WorkflowExecutionSignaled – An external signal was received for the workflow execution.
WorkflowExecutionStarted – The workflow execution was started.
WorkflowExecutionTerminated – The workflow execution was terminated.
WorkflowExecutionTimedOut – The workflow execution was closed because a time out was exceeded.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
The ID of the LambdaFunctionStarted event recorded in the history.
The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
The result of the function execution (if any).
" + "documentation":"The results of the Lambda task.
" } }, - "documentation":"Provides details for the LambdaFunctionCompleted event.
Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
The ID of the LambdaFunctionStarted event recorded in the history.
The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
The reason provided for the failure (if any).
" + "documentation":"The reason provided for the failure.
" }, "details":{ "shape":"Data", - "documentation":"The details of the failure (if any).
" + "documentation":"The details of the failure.
" } }, - "documentation":"Provides details for the LambdaFunctionFailed event.
Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.
The unique Amazon SWF ID for the AWS Lambda task.
" + "documentation":"The unique ID of the Lambda task.
" }, "name":{ "shape":"FunctionName", - "documentation":"The name of the scheduled AWS Lambda function.
" + "documentation":"The name of the Lambda function.
" + }, + "control":{ + "shape":"Data", + "documentation":"Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.
" }, "input":{ "shape":"FunctionInput", - "documentation":"Input provided to the AWS Lambda function.
" + "documentation":"The input provided to the Lambda task.
" }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.
" + "documentation":"The maximum amount of time a worker can take to process the Lambda task.
" }, "decisionTaskCompletedEventId":{ "shape":"EventId", - "documentation":"The ID of the DecisionTaskCompleted event for the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
Provides details for the LambdaFunctionScheduled event.
Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
Provides details for the LambdaFunctionStarted event.
Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
The ID of the LambdaFunctionStarted event recorded in the history.
The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
The type of the timeout that caused this event.
" } }, - "documentation":"Provides details for the LambdaFunctionTimedOut event.
Provides details of the LambdaFunctionTimedOut event.
A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" + "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
", + "exception":true }, "LimitedData":{ "type":"string", @@ -2709,7 +2396,7 @@ }, "maximumPageSize":{ "shape":"PageSize", - "documentation":"The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + "documentation":"The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" }, "reverseOrder":{ "shape":"ReverseOrder", @@ -2727,27 +2414,27 @@ }, "startTimeFilter":{ "shape":"ExecutionTimeFilter", - "documentation":"If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the workflow ID specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only executions of the type specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions of the type specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only executions that have the matching tag are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have the matching tag are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + "documentation":"The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" }, "reverseOrder":{ "shape":"ReverseOrder", @@ -2777,7 +2464,7 @@ }, "maximumPageSize":{ "shape":"PageSize", - "documentation":"The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + "documentation":"The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" }, "reverseOrder":{ "shape":"ReverseOrder", @@ -2802,11 +2489,11 @@ }, "typeFilter":{ "shape":"WorkflowTypeFilter", - "documentation":"If specified, only executions of the type specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions of the type specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
If specified, only executions that have the matching tag are listed.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have the matching tag are listed.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + "documentation":"The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" }, "reverseOrder":{ "shape":"ReverseOrder", @@ -2822,7 +2509,7 @@ }, "executionFilter":{ "shape":"WorkflowExecutionFilter", - "documentation":"If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + "documentation":"The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" }, "reverseOrder":{ "shape":"ReverseOrder", @@ -2861,8 +2548,8 @@ }, "MarkerName":{ "type":"string", - "min":1, - "max":256 + "max":256, + "min":1 }, "MarkerRecordedEventAttributes":{ "type":"structure", @@ -2877,24 +2564,24 @@ }, "details":{ "shape":"Data", - "documentation":"Details of the marker (if any).
" + "documentation":"The details of the marker.
" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the MarkerRecorded event.
Provides the details of the MarkerRecorded event.
A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" + "documentation":"Returned when the caller doesn't have sufficient permissions to invoke the action.
", + "exception":true }, "PageSize":{ "type":"integer", - "min":0, - "max":1000 + "max":1000, + "min":0 }, "PageToken":{ "type":"string", @@ -2944,7 +2631,7 @@ }, "taskList":{ "shape":"TaskList", - "documentation":"Specifies the task list to poll for activity tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Specifies the task list to poll for activity tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
Specifies the task list to poll for decision tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Specifies the task list to poll for decision tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken will not return a new decision task.If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + "documentation":"The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" }, "reverseOrder":{ "shape":"ReverseOrder", @@ -2991,7 +2678,7 @@ "members":{ "taskToken":{ "shape":"TaskToken", - "documentation":"The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
Required. The name of the marker.
" + "documentation":"The name of the marker.
" }, "details":{ "shape":"Data", - "documentation":"Optional. details of the marker.
" + "documentation":"The details of the marker.
" } }, - "documentation":"Provides details of the RecordMarker decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the RecordMarker decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the RecordMarkerFailed event.
Provides the details of the RecordMarkerFailed event.
The name of the activity type within the domain.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the activity type within the domain.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
The version of the activity type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique within the domain.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision.
If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.
The default task priority to assign to the activity type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":"The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..
" }, "defaultTaskScheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Name of the domain to register. The name must be unique in the region that the domain is registered in.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Name of the domain to register. The name must be unique in the region that the domain is registered in.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.
If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
" + "documentation":"The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.
If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
" } } }, @@ -3126,11 +2813,11 @@ }, "name":{ "shape":"Name", - "documentation":"The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
The version of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The version of the workflow type.
The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.
If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The default task priority to assign to the workflow type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":"The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "defaultChildPolicy":{ "shape":"ChildPolicy", - "documentation":"If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.
This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution and ContinueAsNewWorkflowExecution decision.
The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
The activityId of the activity task to be canceled.
Provides details of the RequestCancelActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the RequestCancelActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the RequestCancelActivityTaskFailed event.
Provides the details of the RequestCancelActivityTaskFailed event.
Required. The workflowId of the external workflow execution to cancel.
The workflowId of the external workflow execution to cancel.
The runId of the external workflow execution to cancel.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" + "documentation":"The data attached to the event that can be used by the decider in subsequent workflow tasks.
" } }, - "documentation":"Provides details of the RequestCancelExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the RequestCancelExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The workflowId of the external workflow to which the cancel request was to be delivered.
The runId of the external workflow execution.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.
" + } }, - "documentation":"Provides details of the RequestCancelExternalWorkflowExecutionFailed event.
Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.
The workflowId of the external workflow execution to be canceled.
The runId of the external workflow execution to be canceled.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" + "documentation":"Data attached to the event that can be used by the decider in subsequent workflow tasks.
" } }, - "documentation":"Provides details of the RequestCancelExternalWorkflowExecutionInitiated event.
Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.
The workflowId of the workflow execution to cancel.
" }, "runId":{ - "shape":"RunIdOptional", + "shape":"WorkflowRunIdOptional", "documentation":"The runId of the workflow execution to cancel.
" } } @@ -3323,11 +3013,11 @@ "members":{ "taskToken":{ "shape":"TaskToken", - "documentation":"The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
Optional. Information about the cancellation.
" + "documentation":"Information about the cancellation.
" } } }, @@ -3337,7 +3027,7 @@ "members":{ "taskToken":{ "shape":"TaskToken", - "documentation":"The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
Optional. Detailed information about the failure.
" + "documentation":"Detailed information about the failure.
" } } }, @@ -3369,38 +3059,30 @@ "members":{ "taskToken":{ "shape":"TaskToken", - "documentation":"The taskToken from the DecisionTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The taskToken from the DecisionTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the decision structure for details.
" + "documentation":"The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.
" }, "executionContext":{ "shape":"Data", "documentation":"User defined context to add to workflow execution.
" } - } + }, + "documentation":"Input data for a TaskCompleted response to a decision task.
" }, "ReverseOrder":{"type":"boolean"}, "Run":{ "type":"structure", "members":{ "runId":{ - "shape":"RunId", + "shape":"WorkflowRunId", "documentation":"The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.
Specifies the runId of a workflow execution.
Required. The type of the activity task to schedule.
" + "documentation":"The type of the activity task to schedule.
" }, "activityId":{ "shape":"ActivityId", - "documentation":"Required. The activityId of the activity task.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The activityId of the activity task.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
" + "documentation":"Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.
" }, "input":{ "shape":"Data", @@ -3426,30 +3108,30 @@ }, "scheduleToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for this activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
The maximum duration for this activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.
If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.
A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
Optional. If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":" If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "scheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.
If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.
If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Provides details of the ScheduleActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.taskList: String constraint. The key is swf:taskList.name.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the ScheduleActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
activityType.name – String constraint. The key is swf:activityType.name.
activityType.version – String constraint. The key is swf:activityType.version.
taskList – String constraint. The key is swf:taskList.name.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ScheduleActivityTaskFailed event.
Provides the details of the ScheduleActivityTaskFailed event.
Required. The SWF id of the AWS Lambda task.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
A string that identifies the Lambda function execution in the event history.
" }, "name":{ "shape":"FunctionName", - "documentation":"Required. The name of the AWS Lambda function to invoke.
" + "documentation":"The name, or ARN, of the Lambda function to schedule.
" + }, + "control":{ + "shape":"Data", + "documentation":"The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.
" }, "input":{ "shape":"FunctionInput", - "documentation":"The input provided to the AWS Lambda function.
" + "documentation":"The optional input data to be supplied to the Lambda function.
" }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the maximum duration the function may take to execute.
" + "documentation":"The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.
" } }, - "documentation":"Provides details of the ScheduleLambdaFunction decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.taskList: String constraint. The key is swf:taskList.name.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.
The unique Amazon SWF ID of the AWS Lambda task.
" + "documentation":"The ID provided in the ScheduleLambdaFunction decision that failed.
The name of the scheduled AWS Lambda function.
" + "documentation":"The name of the Lambda function.
" }, "cause":{ "shape":"ScheduleLambdaFunctionFailedCause", - "documentation":"The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
Provides details for the ScheduleLambdaFunctionFailed event.
Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.
Required. The workflowId of the workflow execution to be signaled.
The workflowId of the workflow execution to be signaled.
The runId of the workflow execution to be signaled.
Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.
" + "documentation":"The name of the signal.The target workflow execution uses the signal name and input to process the signal.
" }, "input":{ "shape":"Data", - "documentation":"Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.
" + "documentation":"The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.
" }, "control":{ "shape":"Data", - "documentation":"Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.
" + "documentation":"The data attached to the event that can be used by the decider in subsequent decision tasks.
" } }, - "documentation":"Provides details of the SignalExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the SignalExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The workflowId of the external workflow execution that the signal was being delivered to.
The runId of the external workflow execution that the signal was being delivered to.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.
" + } }, - "documentation":"Provides details of the SignalExternalWorkflowExecutionFailed event.
Provides the details of the SignalExternalWorkflowExecutionFailed event.
The workflowId of the external workflow execution.
The runId of the external workflow execution to send the signal to.
Input provided to the signal (if any).
" + "documentation":"The input provided to the signal.
" }, "decisionTaskCompletedEventId":{ "shape":"EventId", @@ -3659,15 +3348,15 @@ }, "control":{ "shape":"Data", - "documentation":"Optional. data attached to the event that can be used by the decider in subsequent decision tasks.
" + "documentation":"Data attached to the event that can be used by the decider in subsequent decision tasks.
" } }, - "documentation":"Provides details of the SignalExternalWorkflowExecutionInitiated event.
Provides the details of the SignalExternalWorkflowExecutionInitiated event.
The workflowId of the workflow execution to signal.
" }, "runId":{ - "shape":"RunIdOptional", + "shape":"WorkflowRunIdOptional", "documentation":"The runId of the workflow execution to signal.
" }, "signalName":{ @@ -3708,15 +3397,15 @@ "members":{ "workflowType":{ "shape":"WorkflowType", - "documentation":"Required. The type of the workflow execution to be started.
" + "documentation":"The type of the workflow execution to be started.
" }, "workflowId":{ "shape":"WorkflowId", - "documentation":"Required. The workflowId of the workflow execution.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The workflowId of the workflow execution.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
" + "documentation":"The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.
" }, "input":{ "shape":"Data", @@ -3724,23 +3413,23 @@ }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
The name of the task list to be used for decision tasks of the child workflow execution.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the task list to be used for decision tasks of the child workflow execution.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":" A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
The IAM role attached to the child workflow execution.
" } }, - "documentation":"Provides details of the StartChildWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagList.member.N: The key is \"swf:tagList.N\" where N is the tag number from 0 to 4, inclusive.taskList: String constraint. The key is swf:taskList.name.workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the StartChildWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
tagList.member.N – The key is \"swf:tagList.N\" where N is the tag number from 0 to 4, inclusive.
taskList – String constraint. The key is swf:taskList.name.
workflowType.name – String constraint. The key is swf:workflowType.name.
workflowType.version – String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The workflow type provided in the StartChildWorkflowExecution decision that failed.
The workflow type provided in the StartChildWorkflowExecution Decision that failed.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.
When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.
The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.
" + } }, - "documentation":"Provides details of the StartChildWorkflowExecutionFailed event.
Provides the details of the StartChildWorkflowExecutionFailed event.
Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.
" + "documentation":"Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.
" }, "input":{ "shape":"Data", - "documentation":"The inputs provided to the child workflow execution (if any).
" + "documentation":"The inputs provided to the child workflow execution.
" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":" The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "decisionTaskCompletedEventId":{ "shape":"EventId", - "documentation":"The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
The maximum duration allowed for the decision tasks for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The maximum duration allowed for the decision tasks for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
" + "documentation":"The IAM role to attach to the child workflow execution.
" } }, - "documentation":"Provides details of the StartChildWorkflowExecutionInitiated event.
Provides the details of the StartChildWorkflowExecutionInitiated event.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.
The error message (if any).
" + "documentation":"A description that can help diagnose the cause of the fault.
" } }, - "documentation":"Provides details for the StartLambdaFunctionFailed event.
Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.
Required. The unique ID of the timer.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The unique ID of the timer.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" + "documentation":"The data attached to the event that can be used by the decider in subsequent workflow tasks.
" }, "startToFireTimeout":{ "shape":"DurationInSeconds", - "documentation":"Required. The duration to wait before firing the timer.
The duration is specified in seconds; an integer greater than or equal to 0.
" + "documentation":"The duration to wait before firing the timer.
The duration is specified in seconds, an integer greater than or equal to 0.
Provides details of the StartTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + "documentation":"Provides the details of the StartTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the StartTimerFailed event.
Provides the details of the StartTimerFailed event.
The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.
The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":"The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "input":{ "shape":"Data", @@ -3974,7 +3666,7 @@ }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
The IAM role to attach to this workflow execution.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
Required. Specifies the tag that must be associated with the execution for it to meet the filter criteria.
" + "documentation":"Specifies the tag that must be associated with the execution for it to meet the filter criteria.
" } }, "documentation":"Used to filter the workflow executions in visibility APIs based on a tag.
" @@ -4026,14 +3718,11 @@ }, "documentation":"Represents a task list.
" }, - "TaskPriority":{ - "type":"string", - "max":11 - }, + "TaskPriority":{"type":"string"}, "TaskToken":{ "type":"string", - "min":1, - "max":1024 + "max":1024, + "min":1 }, "TerminateReason":{ "type":"string", @@ -4055,20 +3744,20 @@ "documentation":"The workflowId of the workflow execution to terminate.
" }, "runId":{ - "shape":"RunIdOptional", + "shape":"WorkflowRunIdOptional", "documentation":"The runId of the workflow execution to terminate.
" }, "reason":{ "shape":"TerminateReason", - "documentation":"Optional. A descriptive reason for terminating the workflow execution.
" + "documentation":"A descriptive reason for terminating the workflow execution.
" }, "details":{ "shape":"Data", - "documentation":"Optional. Details for terminating the workflow execution.
" + "documentation":"Details for terminating the workflow execution.
" }, "childPolicy":{ "shape":"ChildPolicy", - "documentation":"If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
The unique ID of the timer that was canceled.
" + "documentation":"The unique ID of the timer that was canceled.
" }, "startedEventId":{ "shape":"EventId", @@ -4093,7 +3782,7 @@ "documentation":"The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the TimerCanceled event.
Provides the details of the TimerCanceled event.
The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the TimerFired event.
Provides the details of the TimerFired event.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" + "documentation":"Data attached to the event that can be used by the decider in subsequent workflow tasks.
" }, "startToFireTimeout":{ "shape":"DurationInSeconds", - "documentation":"The duration of time after which the timer will fire.
The duration is specified in seconds; an integer greater than or equal to 0.
" + "documentation":"The duration of time after which the timer fires.
The duration is specified in seconds, an integer greater than or equal to 0.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the TimerStarted event.
Provides the details of the TimerStarted event.
A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
" + "documentation":"Returned if the type already exists in the specified domain. You get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
", + "exception":true }, "TypeDeprecatedFault":{ "type":"structure", @@ -4166,8 +3855,8 @@ "documentation":"A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" + "documentation":"Returned when the specified activity or workflow type was already deprecated.
", + "exception":true }, "UnknownResourceFault":{ "type":"structure", @@ -4177,13 +3866,13 @@ "documentation":"A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" + "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
", + "exception":true }, "Version":{ "type":"string", - "min":1, - "max":64 + "max":64, + "min":1 }, "VersionOptional":{ "type":"string", @@ -4201,7 +3890,7 @@ "documentation":"The user defined identifier associated with the workflow execution.
" }, "runId":{ - "shape":"RunId", + "shape":"WorkflowRunId", "documentation":"A system-generated unique identifier for the workflow execution.
" } }, @@ -4215,8 +3904,8 @@ "documentation":"A description that may help with diagnosing the cause of the fault.
" } }, - "exception":true, - "documentation":"Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
" + "documentation":"Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
", + "exception":true }, "WorkflowExecutionCancelRequestedCause":{ "type":"string", @@ -4238,7 +3927,7 @@ "documentation":"If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.
" } }, - "documentation":"Provides details of the WorkflowExecutionCancelRequested event.
Provides the details of the WorkflowExecutionCancelRequested event.
Details for the cancellation (if any).
" + "documentation":"The details of the cancellation.
" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the WorkflowExecutionCanceled event.
Provides the details of the WorkflowExecutionCanceled event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the WorkflowExecutionCompleted event.
Provides the details of the WorkflowExecutionCompleted event.
The maximum duration allowed for decision tasks for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The maximum duration allowed for decision tasks for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The total duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The total duration for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":"The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "childPolicy":{ "shape":"ChildPolicy", - "documentation":"The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
The IAM role used by this workflow execution when invoking AWS Lambda functions.
" + "documentation":"The IAM role attached to the child workflow execution.
" } }, "documentation":"The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.
" @@ -4325,34 +4014,43 @@ "documentation":"The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The runId of the new workflow execution.
The total duration allowed for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The total duration allowed for the new workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The task list to use for the decisions of the new (continued) workflow execution.
" + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"The priority of the task to use for the decisions of the new (continued) workflow execution.
" }, - "taskList":{"shape":"TaskList"}, - "taskPriority":{"shape":"TaskPriority"}, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration of decision tasks for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The maximum duration of decision tasks for the new workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
The list of tags associated with the new workflow execution.
" }, - "workflowType":{"shape":"WorkflowType"}, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"The workflow type of this execution.
" + }, "lambdaRole":{ "shape":"Arn", - "documentation":"The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
" + "documentation":"The IAM role to attach to the new (continued) workflow execution.
" } }, - "documentation":"Provides details of the WorkflowExecutionContinuedAsNew event.
Provides the details of the WorkflowExecutionContinuedAsNew event.
If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
" } }, - "documentation":"Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
" + "documentation":"Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
" }, "WorkflowExecutionDetail":{ "type":"structure", @@ -4406,18 +4104,18 @@ "members":{ "reason":{ "shape":"FailureReason", - "documentation":"The descriptive reason provided for the failure (if any).
" + "documentation":"The descriptive reason provided for the failure.
" }, "details":{ "shape":"Data", - "documentation":"The details of the failure (if any).
" + "documentation":"The details of the failure.
" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the WorkflowExecutionFailed event.
Provides the details of the WorkflowExecutionFailed event.
If the execution status is closed then this specifies how the execution was closed:
COMPLETED: the execution was successfully completed.CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.TERMINATED: the execution was force terminated.FAILED: the execution failed to complete.TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.If the execution status is closed then this specifies how the execution was closed:
COMPLETED – the execution was successfully completed.
CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.
TERMINATED – the execution was force terminated.
FAILED – the execution failed to complete.
TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.
CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
Set to true if a cancellation is requested for this workflow execution.
" } }, - "documentation":"Contains information about a workflow execution.
" + "documentation":"Contains information about a workflow execution.
" }, "WorkflowExecutionInfoList":{ "type":"list", @@ -4508,7 +4206,7 @@ "members":{ "openActivityTasks":{ "shape":"Count", - "documentation":"The count of activity tasks whose status is OPEN.
" + "documentation":"The count of activity tasks whose status is OPEN.
The count of child workflow executions whose status is OPEN.
" + "documentation":"The count of child workflow executions whose status is OPEN.
The count of AWS Lambda functions that are currently executing.
" + "documentation":"The count of Lambda tasks whose status is OPEN.
Contains the counts of open tasks, child workflow executions and timers for a workflow execution.
" @@ -4539,7 +4237,7 @@ }, "input":{ "shape":"Data", - "documentation":"Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.
" + "documentation":"The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.
" }, "externalWorkflowExecution":{ "shape":"WorkflowExecution", @@ -4550,7 +4248,7 @@ "documentation":"The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.
Provides details of the WorkflowExecutionSignaled event.
Provides the details of the WorkflowExecutionSignaled event.
The input provided to the workflow execution (if any).
" + "documentation":"The input provided to the workflow execution.
" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The maximum duration for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":"The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
The name of the task list for scheduling the decision tasks for this workflow execution.
" }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"The priority of the decision tasks in the workflow execution.
" + }, "workflowType":{ "shape":"WorkflowType", "documentation":"The workflow type of this execution.
" @@ -4588,22 +4290,21 @@ "shape":"TagList", "documentation":"The list of tags associated with this workflow execution. An execution can have up to 5 tags.
" }, - "taskPriority":{"shape":"TaskPriority"}, "continuedExecutionRunId":{ - "shape":"RunIdOptional", + "shape":"WorkflowRunIdOptional", "documentation":"If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
" + "documentation":"The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.
" }, "parentInitiatedEventId":{ "shape":"EventId", - "documentation":"The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
" + "documentation":"The IAM role attached to the workflow execution.
" } }, "documentation":"Provides details of WorkflowExecutionStarted event.
The reason provided for the termination (if any).
" + "documentation":"The reason provided for the termination.
" }, "details":{ "shape":"Data", - "documentation":"The details provided for the termination (if any).
" + "documentation":"The details provided for the termination.
" }, "childPolicy":{ "shape":"ChildPolicy", - "documentation":"The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.
" } }, - "documentation":"Provides details of the WorkflowExecutionTerminated event.
Provides the details of the WorkflowExecutionTerminated event.
The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
Provides details of the WorkflowExecutionTimedOut event.
Provides the details of the WorkflowExecutionTimedOut event.
Required. The name of the workflow type.
The name of the workflow type.
The combination of workflow type name and version must be unique with in a domain.
Required. The version of the workflow type.
The version of the workflow type.
The combination of workflow type name and version must be unique with in a domain.
Represents a workflow type.
" @@ -4689,27 +4399,27 @@ "members":{ "defaultTaskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":" The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + "documentation":" The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + "documentation":" The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
" }, "defaultChildPolicy":{ "shape":"ChildPolicy", - "documentation":"Optional. The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The supported child policies are:
TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.
The default IAM role to use when a workflow execution invokes a AWS Lambda function.
" + "documentation":"The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
The configuration settings of a workflow type.
" @@ -4723,11 +4433,11 @@ "members":{ "typeInfo":{ "shape":"WorkflowTypeInfo", - "documentation":"General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
REGISTERED – The type is registered and available. Workers supporting this type should be running.
DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.
Configuration settings of the workflow type registered through RegisterWorkflowType
" + "documentation":"Configuration settings of the workflow type registered through RegisterWorkflowType
" } }, "documentation":"Contains details about a workflow type.
" @@ -4738,7 +4448,7 @@ "members":{ "name":{ "shape":"Name", - "documentation":"Required. Name of the workflow type.
" + "documentation":"Name of the workflow type.
" }, "version":{ "shape":"VersionOptional", @@ -4798,6 +4508,5 @@ "documentation":"Contains a paginated list of information structures about workflow types.
" } }, - "examples":{ - } + "documentation":"The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .
" } diff --git a/botocore/paginate.py b/botocore/paginate.py index 29c544b5..8cae9749 100644 --- a/botocore/paginate.py +++ b/botocore/paginate.py @@ -257,6 +257,11 @@ class PageIterator(object): parsed, primary_result_key, starting_truncation) first_request = False self._record_non_aggregate_key_values(parsed) + else: + # If this isn't the first request, we have already sliced into + # the first request and had to make additional requests after. + # We no longer need to add this to truncation. + starting_truncation = 0 current_response = primary_result_key.search(parsed) if current_response is None: current_response = [] diff --git a/botocore/utils.py b/botocore/utils.py index 1d9185c3..59cf3492 100644 --- a/botocore/utils.py +++ b/botocore/utils.py @@ -18,6 +18,7 @@ import hashlib import binascii import functools import weakref +import random import dateutil.parser from dateutil.tz import tzlocal, tzutc @@ -578,6 +579,8 @@ class ArgumentGenerator(object): elif shape.type_name == 'string': if self._use_member_names: return name + if shape.enum: + return random.choice(shape.enum) return '' elif shape.type_name in ['integer', 'long']: return 0 diff --git a/docs/source/conf.py b/docs/source/conf.py index 49030d59..a93a657a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat' # The short X.Y version. version = '1.5.' # The full version, including alpha/beta/rc tags. -release = '1.5.80' +release = '1.5.84' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tests/unit/test_paginate.py b/tests/unit/test_paginate.py index 5f7d1931..0c10e2e4 100644 --- a/tests/unit/test_paginate.py +++ b/tests/unit/test_paginate.py @@ -296,6 +296,49 @@ class TestPagination(unittest.TestCase): complete = pages.build_full_result() self.assertEqual(complete, {'Users': ['User1', 'User2', 'User3']}) + def test_build_multiple_results(self): + self.paginate_config = { + "output_token": "Marker", + "input_token": "Marker", + "result_key": "Users", + "limit_key": "MaxKeys", + } + self.paginator = Paginator(self.method, self.paginate_config) + + max_items = 3 + page_size = 2 + + responses = [ + {"Users": ["User1", "User2"], "Marker": "m1"}, + {"Users": ["User3", "User4"], "Marker": "m2"}, + {"Users": ["User3", "User4"], "Marker": "m2"}, + {"Users": ["User5", "User6", "User7"], "Marker": "m3"}, + ] + self.method.side_effect = responses + + pages = self.paginator.paginate( + PaginationConfig={ + 'PageSize': page_size, + 'MaxItems': max_items + } + ) + result = pages.build_full_result() + + pages = self.paginator.paginate( + PaginationConfig={ + 'MaxItems': max_items, + 'PageSize': page_size, + 'StartingToken': result['NextToken'] + } + ) + result = pages.build_full_result() + + expected_token = encode_token({ + 'Marker': 'm2', + 'boto_truncate_amount': 2, + }) + self.assertEqual(expected_token, result['NextToken']) + class TestPaginatorPageSize(unittest.TestCase): def setUp(self): diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py index ebd51511..c1cc1b9c 100644 --- a/tests/unit/test_utils.py +++ b/tests/unit/test_utils.py @@ -416,6 +416,17 @@ class TestArgumentGenerator(unittest.TestCase): } ) + def test_generate_string_enum(self): + enum_values = ['A', 'B', 'C'] + model = { + 'A': {'type': 'string', 'enum': enum_values} + } + shape = DenormalizedStructureBuilder().with_members( + model).build_model() + actual = self.arg_generator.generate_skeleton(shape) + + self.assertIn(actual['A'], enum_values) + def test_generate_scalars(self): self.assert_skeleton_from_model_is( model={